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