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 ManagedRouteGroupMBean extends ManagedPerformanceCounterMBean {
023
024    @ManagedAttribute(description = "Route ID")
025    String getRouteGroup();
026
027    @ManagedAttribute(description = "Number of routes in this group")
028    int getGroupSize();
029
030    @ManagedAttribute(description = "The route IDs within this group")
031    String[] getGroupIds();
032
033    @ManagedAttribute(description = "Route State")
034    String getState();
035
036    @ManagedAttribute(description = "Route Uptime [human readable text]")
037    String getUptime();
038
039    @ManagedAttribute(description = "Route Uptime [milliseconds]")
040    long getUptimeMillis();
041
042    @ManagedAttribute(description = "Camel ID")
043    String getCamelId();
044
045    @ManagedAttribute(description = "Camel ManagementName")
046    String getCamelManagementName();
047
048    @ManagedAttribute(description = "Number of completed exchanges")
049    long getExchangesCompleted();
050
051    @ManagedAttribute(description = "Number of failed exchanges")
052    long getExchangesFailed();
053
054    @ManagedAttribute(description = "Number of inflight exchanges")
055    long getExchangesInflight();
056
057    @ManagedAttribute(description = "Number of failures handled")
058    long getFailuresHandled();
059
060    @ManagedAttribute(description = "Number of redeliveries (internal only)")
061    long getRedeliveries();
062
063    @ManagedAttribute(description = "Number of external initiated redeliveries (such as from JMS broker)")
064    long getExternalRedeliveries();
065
066    @ManagedAttribute(description = "Average load (inflight messages, not cpu) over the last minute")
067    String getLoad01();
068
069    @ManagedAttribute(description = "Average load (inflight messages, not cpu) over the last five minutes")
070    String getLoad05();
071
072    @ManagedAttribute(description = "Average load (inflight messages, not cpu) over the last fifteen minutes")
073    String getLoad15();
074
075    @ManagedAttribute(description = "Throughput message/second")
076    String getThroughput();
077
078    @ManagedOperation(description = "Start all routes")
079    void start() throws Exception;
080
081    @ManagedOperation(description = "Stop all routes")
082    void stop() throws Exception;
083
084}