001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel;
018
019import java.io.IOException;
020
021/**
022 * Represents the core lifecycle API for services which can be initialized, started and stopped
023 */
024public interface Service extends AutoCloseable {
025
026    /**
027     * Optional build phase which is executed by frameworks that supports pre-building projects (pre-compile)
028     * which allows special optimizations such as camel-quarkus.
029     *
030     * @throws RuntimeCamelException is thrown if build failed
031     */
032    default void build() {
033    }
034
035    /**
036     * Initialize the service
037     *
038     * @throws RuntimeCamelException is thrown if initialization failed
039     */
040    default void init() {
041    }
042
043    /**
044     * Starts the service
045     *
046     * @throws RuntimeCamelException is thrown if starting failed
047     */
048    void start();
049
050    /**
051     * Stops the service
052     *
053     * @throws RuntimeCamelException is thrown if stopping failed
054     */
055    void stop();
056
057    /**
058     * Delegates to {@link Service#stop()} so it can be used in
059     * try-with-resources expression.
060     * 
061     * @throws IOException per contract of {@link AutoCloseable} if
062     *             {@link Service#stop()} fails
063     */
064    default void close() throws IOException {
065        try {
066            stop();
067        } catch (RuntimeException e) {
068            throw e;
069        } catch (Exception e) {
070            throw new IOException(e);
071        }
072    }
073}