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 org.apache.camel.api.management.ManagedOperation;
020    
021    public interface ManagedBrowsableEndpointMBean extends ManagedEndpointMBean {
022    
023        @ManagedOperation(description = "Current number of Exchanges in Queue")
024        long queueSize();
025    
026        @ManagedOperation(description = "Get Exchange from queue by index")
027        String browseExchange(Integer index);
028    
029        @ManagedOperation(description = "Get message body from queue by index")
030        String browseMessageBody(Integer index);
031    
032        /**
033         * @deprecated use {@link #browseAllMessagesAsXml(Boolean)} instead
034         */
035        @ManagedOperation(description = "Get message as XML from queue by index")
036        @Deprecated
037        String browseMessageAsXml(Integer index);
038    
039        @ManagedOperation(description = "Get message as XML from queue by index")
040        String browseMessageAsXml(Integer index, Boolean includeBody);
041    
042        @ManagedOperation(description = "Gets all the messages as XML from the queue")
043        String browseAllMessagesAsXml(Boolean includeBody);
044    
045        @ManagedOperation(description = "Gets the range of messages as XML from the queue")
046        String browseRangeMessagesAsXml(Integer fromIndex, Integer toIndex, Boolean includeBody);
047    
048    }