org.apache.camel.spi.SharedInternalProcessor 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

There is a newer version: 4.9.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.AsyncCallback;
import org.apache.camel.AsyncProcessor;
import org.apache.camel.Exchange;
import org.apache.camel.Processor;

/**
 * A Shared (thread safe) internal {@link Processor} that Camel routing engine used during routing for cross cutting
 * functionality such as:
 * 
 * Execute {@link UnitOfWork}
 * Keeping track which route currently is being routed
 * Execute {@link RoutePolicy}
 * Gather JMX performance statics
 * Tracing
 * Debugging
 * Message History
 * Stream Caching
 * {@link Transformer}
 * 
 * ... and more.
 * 
 *
 * This is intended for internal use only - do not use this.
 */
public interface SharedInternalProcessor extends Processor {

    @Override
    default void process(Exchange exchange) throws Exception {
        // not in use
    }

    /**
     * Asynchronous API
     */
    boolean process(Exchange exchange, AsyncCallback originalCallback, AsyncProcessor processor, Processor resultProcessor);

    /**
     * Synchronous API
     */
    void process(Exchange exchange, AsyncProcessor processor, Processor resultProcessor);

}