core/camel-api/src/main/java/org/apache/camel/spi/ProcessorFactory.java

/*
 * 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.CamelContext;
import org.apache.camel.NamedNode;
import org.apache.camel.Processor;
import org.apache.camel.Route;

/**
 * A factory to create {@link Processor} based on the {@link org.apache.camel.model.ProcessorDefinition definition}.
 * <p/>
 * This allows you to implement a custom factory in which you can control the creation of the processors. It also allows
 * you to manipulate the {@link org.apache.camel.model.ProcessorDefinition definition}s for example to configure or
 * change options. Its also possible to add new steps in the route by adding outputs to
 * {@link org.apache.camel.model.ProcessorDefinition definition}s.
 * <p/>
 * <b>Important:</b> A custom ProcessorFactory should extend the default implementation
 * <tt>org.apache.camel.processor.DefaultProcessorFactory</tt> and in the overridden methods, super should be called to
 * let the default implementation create the processor when custom processors is not created.
 */
public interface ProcessorFactory {

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

    /**
     * Creates the child processor.
     * <p/>
     * The child processor is an output from the given definition, for example the sub route in a splitter EIP.
     *
     * @param  route      the route context
     * @param  definition the definition which represents the processor
     * @param  mandatory  whether or not the child is mandatory
     * @return            the created processor, or <tt>null</tt> to let the default implementation in Camel create the
     *                    processor.
     * @throws Exception  can be thrown if error creating the processor
     */
    Processor createChildProcessor(Route route, NamedNode definition, boolean mandatory) throws Exception;

    /**
     * Creates the processor.
     *
     * @param  route      the route context
     * @param  definition the definition which represents the processor
     * @return            the created processor, or <tt>null</tt> to let the default implementation in Camel create the
     *                    processor.
     * @throws Exception  can be thrown if error creating the processor
     */
    Processor createProcessor(Route route, NamedNode definition) throws Exception;

    /**
     * Creates a processor by the name of the definition. This should only be used in some special situations where the
     * processor is used internally by Camel itself and some component such as camel-cloud, camel-seda.
     *
     * @param  camelContext   the camel context
     * @param  definitionName the name of the definition that represents the processor
     * @param  args           arguments for creating the processor (optimized to use fixed order of parameters)
     * @return                the created processor, or <tt>null</tt> if this situation is not yet implemented.
     * @throws Exception      can be thrown if error creating the processor
     */
    Processor createProcessor(CamelContext camelContext, String definitionName, Object[] args) throws Exception;

}