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;
018
019import org.apache.camel.model.ProcessorDefinition;
020
021/**
022 * Represents a model of a node in the runtime route path.
023 *
024 * @version 
025 */
026public interface RouteNode {
027
028    /**
029     * Gets the actual processor this node represents.
030     *
031     * @return the processor, can be <tt>null</tt> in special cases such as an intercepted node
032     */
033    Processor getProcessor();
034
035    /**
036     * Gets the model definition that represents this node
037     *
038     * @return the definition, is never <tt>null</tt>
039     */
040    ProcessorDefinition<?> getProcessorDefinition();
041
042    /**
043     * Gets a label about this node to be used for tracing or tooling etc.
044     *
045     * @param exchange the current exchange
046     * @return  a label for this node
047     */
048    String getLabel(Exchange exchange);
049
050    /**
051     * Whether this node is abstract (no real processor under the cover).
052     * <p/>
053     * Some nodes that represent intermediate steps are abstract, for instance with
054     * onException, onCompletion or intercept
055     *
056     * @return whether this node is abstract or not
057     */
058    boolean isAbstract();
059}