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

Show more of this group Show more artifacts with this name
Show all versions of camel-core Show documentation
The Core Camel Java DSL based router
There is a newer version: 4.6.0
/**
 * 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.Processor;
import org.apache.camel.model.ProcessorDefinition;

/**
 * The purpose of this interface is to allow an implementation to wrap
 * processors in a route with interceptors.  For example, a possible
 * usecase is to gather performance statistics at the processor's level.
 * 
 * Important:  This SPI is not intended to be used by Camel end users - do NOT use this.
 * 

 * Its strongly adviced to use an {@link org.apache.camel.AsyncProcessor} as the returned wrapped
 * {@link Processor} which ensures the interceptor works well with the asynchronous routing engine.
 * You can use the {@link org.apache.camel.processor.DelegateAsyncProcessor} to easily return an
 * {@link org.apache.camel.AsyncProcessor} and override the
 * {@link org.apache.camel.AsyncProcessor#process(org.apache.camel.Exchange, org.apache.camel.AsyncCallback)} to
 * implement your interceptor logic. And just invoke the super method to continue routing.
 *
 * @version 
 */
public interface InterceptStrategy {

    // TODO: Camel 3.0 make this an internal API

    /**
     * This method is invoked by
     * {@link ProcessorDefinition#wrapProcessor(RouteContext, Processor)}
     * to give the implementor an opportunity to wrap the target processor
     * in a route.
     * 
     * Important: See the class javadoc for advice on letting interceptor be compatible with the
     * asynchronous routing engine.
     *
     * @param context       Camel context
     * @param definition    the model this interceptor represents
     * @param target        the processor to be wrapped
     * @param nextTarget    the next processor to be routed to
     * @return processor    wrapped with an interceptor or not wrapped.
     * @throws Exception can be thrown
     */
    Processor wrapProcessorInInterceptors(CamelContext context, ProcessorDefinition definition, 
                                          Processor target, Processor nextTarget) throws Exception;
}