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     */
017    package org.apache.camel.api.management.mbean;
018    
019    import java.io.Serializable;
020    import java.util.Date;
021    
022    /**
023     * Represents a traced message by the {@link org.apache.camel.processor.interceptor.BacklogTracer}.
024     */
025    public interface BacklogTracerEventMessage extends Serializable {
026    
027        String ROOT_TAG = "backlogTracerEventMessage";
028        String TIMESTAMP_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSZ";
029    
030        long getUid();
031    
032        Date getTimestamp();
033    
034        String getRouteId();
035    
036        String getToNode();
037    
038        String getExchangeId();
039    
040        String getMessageAsXml();
041    
042        /**
043         * Dumps the event message as XML using the {@link #ROOT_TAG} as root tag.
044         * <p/>
045         * The <tt>timestamp</tt> tag is formatted in the format defined by {@link #TIMESTAMP_FORMAT}
046         *
047         * @param indent number of spaces to indent
048         * @return xml representation of this event
049         */
050        String toXml(int indent);
051    
052    }