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 */
017package org.apache.camel.model;
018
019import org.apache.camel.Channel;
020import org.apache.camel.spi.RouteContext;
021
022public interface ModelChannel extends Channel {
023
024    /**
025     * Initializes the channel.
026     *
027     * @param outputDefinition  the route definition the {@link Channel} represents
028     * @param routeContext      the route context
029     * @throws Exception is thrown if some error occurred
030     */
031    void initChannel(ProcessorDefinition<?> outputDefinition, RouteContext routeContext) throws Exception;
032
033    /**
034     * Post initializes the channel.
035     *
036     * @param outputDefinition  the route definition the {@link Channel} represents
037     * @param routeContext      the route context
038     * @throws Exception is thrown if some error occurred
039     */
040    void postInitChannel(ProcessorDefinition<?> outputDefinition, RouteContext routeContext) throws Exception;
041
042    /**
043     * If the initialized output definition contained outputs (children) then we need to
044     * set the child so we can leverage fine grained tracing
045     *
046     * @param child the child
047     */
048    void setChildDefinition(ProcessorDefinition<?> child);
049    
050    /**
051     * Gets the definition of the next processor
052     *
053     * @return the processor definition
054     */
055    ProcessorDefinition<?> getProcessorDefinition();
056}