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.api.management.mbean;
018
019import java.io.Serializable;
020
021/**
022 * Represents a traced message by the BacklogTracer.
023 */
024public interface BacklogTracerEventMessage extends Serializable {
025
026    String ROOT_TAG = "backlogTracerEventMessage";
027    String TIMESTAMP_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSZ";
028
029    /**
030     * Unique id of the traced message
031     */
032    long getUid();
033
034    /**
035     * Timestamp of the traced event
036     */
037    long getTimestamp();
038
039    /**
040     * Route id
041     */
042    String getRouteId();
043
044    /**
045     * Node id where the message is being routed to
046     */
047    String getToNode();
048
049    /**
050     * The exchange id
051     */
052    String getExchangeId();
053
054    /**
055     * The content of the message as XML (body and headers)
056     */
057    String getMessageAsXml();
058
059    /**
060     * Dumps the event message as XML using the {@link #ROOT_TAG} as root tag.
061     * <p/>
062     * The <tt>timestamp</tt> tag is formatted in the format defined by {@link #TIMESTAMP_FORMAT}
063     *
064     * @param  indent number of spaces to indent
065     * @return        xml representation of this event
066     */
067    String toXml(int indent);
068
069}