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 java.util.Date;
020
021/**
022 * Represents the history of a Camel {@link Message} how it was routed by the Camel routing engine.
023 */
024public interface MessageHistory {
025
026    /**
027     * Gets the route id at the point of this history.
028     */
029    String getRouteId();
030
031    /**
032     * Gets the node at the point of this history.
033     */
034    NamedNode getNode();
035
036    /**
037     * Gets the timestamp at the point of this history.
038     *
039     * @deprecated use {@link #getTime()}
040     */
041    @Deprecated
042    Date getTimestamp();
043
044    /**
045     * Gets the timestamp at the point of this history.
046     */
047    long getTime();
048
049    /**
050     * Gets the elapsed time in millis processing the node took
051     */
052    long getElapsed();
053
054    /**
055     * Used for signalling that processing of the node is done.
056     */
057    void nodeProcessingDone();
058
059}