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 org.apache.camel.api.management.ManagedAttribute;
020import org.apache.camel.api.management.ManagedOperation;
021
022public interface ManagedBrowsableEndpointMBean extends ManagedEndpointMBean {
023
024    @ManagedAttribute(description = "Maximum number of messages to browse by default")
025    int getBrowseLimit();
026
027    @ManagedOperation(description = "Current number of Exchanges in Queue")
028    int queueSize();
029
030    @ManagedOperation(description = "Get Exchange from queue by index")
031    String browseExchange(Integer index);
032
033    @ManagedOperation(description = "Get message body from queue by index")
034    String browseMessageBody(Integer index);
035
036    @ManagedOperation(description = "Get message as XML from queue by index")
037    String browseMessageAsXml(Integer index, Boolean includeBody);
038
039    @ManagedOperation(description = "Gets all the messages as XML from the queue")
040    String browseAllMessagesAsXml(Boolean includeBody);
041
042    @ManagedOperation(description = "Gets the range of messages as XML from the queue")
043    String browseRangeMessagesAsXml(Integer fromIndex, Integer toIndex, Boolean includeBody);
044
045    @ManagedOperation(description = "Get message as JSon from queue by index")
046    String browseMessageAsJSon(Integer index, Boolean includeBody);
047
048    @ManagedOperation(description = "Gets all the messages as JSon from the queue")
049    String browseAllMessagesAsJSon(Boolean includeBody);
050
051    @ManagedOperation(description = "Gets the range of messages as JSon from the queue")
052    String browseRangeMessagesAsJSon(Integer fromIndex, Integer toIndex, Boolean includeBody);
053
054}