org.apache.camel.spi.DeferServiceFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camel-api Show documentation

The Camel API

The newest version!

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.camel.spi;

import org.apache.camel.Endpoint;
import org.apache.camel.Producer;

/**
 * Factory to create services such as {@link Producer}s and defer starting the created service, until
 * {@link org.apache.camel.CamelContext} has been started.
 */
public interface DeferServiceFactory {

    /**
     * Service factory key.
     */
    String FACTORY = "defer-service-factory";

    /**
     * Creates the {@link Producer} which is deferred started until {@link org.apache.camel.CamelContext} is being
     * started.
     * 
     * When the producer is started, it re-lookup the endpoint to capture any changes such as the endpoint has been
     * intercepted. This allows the producer to react and send messages to the updated endpoint.
     *
     * @param  endpoint  the endpoint
     * @return           the producer which will be deferred started until {@link org.apache.camel.CamelContext} has
     *                   been started
     * @throws Exception can be thrown if there is an error starting the producer
     */
    Producer createProducer(Endpoint endpoint) throws Exception;

}