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     */
017    package org.apache.camel;
018    
019    /**
020     * Allows objects to be notified when {@link CamelContext} has done all work when starting.
021     * <p/>
022     * This can be used to perform any custom work when the entire {@link CamelContext} has been initialized and <b>almost</b>
023     * started. For example this ensures that all Camel routes have been started and are up and running, before this callback
024     * is invoked.
025     * <p/>
026     * The state of {@link CamelContext} may still be in <tt>starting</tt> when this callback is invoked, this is by design.
027     * The callback is invoked as the last step during all the processes that occur during starting {@link CamelContext}.
028     * <p/>
029     * For example the QuartzComponent leverages this to ensure the Quartz scheduler does not start until after all the
030     * Camel routes and services have already been started.
031     *
032     * @version 
033     */
034    public interface StartupListener {
035    
036        /**
037         * Callback invoked when the {@link CamelContext} has just been started.
038         *
039         * @param context        the Camel context
040         * @param alreadyStarted whether or not the {@link CamelContext} already has been started. For example the context
041         *                       could already have been started, and then a service is added/started later which still
042         *                       triggers this callback to be invoked.
043         * @throws Exception can be thrown in case of errors to fail the startup process and have the application
044         *                   fail on startup.
045         */
046        void onCamelContextStarted(CamelContext context, boolean alreadyStarted) throws Exception;
047    }