org.apache.camel.api.management.mbean

Interface ManagedRouteMBean

All Superinterfaces:

ManagedCounterMBean, ManagedPerformanceCounterMBean

All Known Subinterfaces:

ManagedSuspendableRouteMBean

All Known Implementing Classes:

ManagedRoute, ManagedSuspendableRoute

public interface ManagedRouteMBean
extends ManagedPerformanceCounterMBean

Method Summary

Methods

Modifier and Type	Method and Description
String	createRouteStaticEndpointJson()
String	createRouteStaticEndpointJson(boolean includeDynamic)
String	dumpRouteAsXml()
String	dumpRouteStatsAsXml(boolean fullStats, boolean includeProcessors)
String	getCamelId()
String	getCamelManagementName()
String	getDescription()
String	getEndpointUri()
Integer	getInflightExchanges() Deprecated. use ManagedPerformanceCounterMBean.getExchangesInflight()
String	getLoad01()
String	getLoad05()
String	getLoad15()
Boolean	getMessageHistory()
Long	getOldestInflightDuration()
String	getOldestInflightExchangeId()
String	getRouteId()
String	getRoutePolicyList()
String	getState()
Boolean	getTracing()
boolean	remove()
void	reset(boolean includeProcessors)
void	setTracing(Boolean tracing)
void	shutdown() Deprecated. will be removed in the near future. Use stop and remove instead
void	shutdown(long timeout) Deprecated. will be removed in the near future. Use stop and remove instead
void	start()
void	stop()
void	stop(long timeout)
boolean	stop(Long timeout, Boolean abortAfterTimeout)
void	updateRouteFromXml(String xml)

Methods inherited from interface org.apache.camel.api.management.mbean.ManagedPerformanceCounterMBean

dumpStatsAsXml, getDeltaProcessingTime, getExchangesCompleted, getExchangesFailed, getExchangesInflight, getExternalRedeliveries, getFailuresHandled, getFirstExchangeCompletedExchangeId, getFirstExchangeCompletedTimestamp, getFirstExchangeFailureExchangeId, getFirstExchangeFailureTimestamp, getLastExchangeCompletedExchangeId, getLastExchangeCompletedTimestamp, getLastExchangeFailureExchangeId, getLastExchangeFailureTimestamp, getLastProcessingTime, getMaxProcessingTime, getMeanProcessingTime, getMinProcessingTime, getRedeliveries, getTotalProcessingTime, isStatisticsEnabled, setStatisticsEnabled

Methods inherited from interface org.apache.camel.api.management.mbean.ManagedCounterMBean

getExchangesTotal, getResetTimestamp, reset

Method Detail

getRouteId

@ManagedAttribute(description="Route ID")
String getRouteId()

getDescription

@ManagedAttribute(description="Route Description")
String getDescription()

getEndpointUri

@ManagedAttribute(description="Route Endpoint URI",
                  mask=true)
String getEndpointUri()

getState

@ManagedAttribute(description="Route State")
String getState()

getInflightExchanges

@ManagedAttribute(description="Current number of inflight Exchanges")
@Deprecated
Integer getInflightExchanges()

Deprecated. use ManagedPerformanceCounterMBean.getExchangesInflight()

getCamelId

@ManagedAttribute(description="Camel ID")
String getCamelId()

getCamelManagementName

@ManagedAttribute(description="Camel ManagementName")
String getCamelManagementName()

getTracing

@ManagedAttribute(description="Tracing")
Boolean getTracing()

setTracing

@ManagedAttribute(description="Tracing")
void setTracing(Boolean tracing)

getMessageHistory

@ManagedAttribute(description="Message History")
Boolean getMessageHistory()

getRoutePolicyList

@ManagedAttribute(description="Route Policy List")
String getRoutePolicyList()

getLoad01

@ManagedAttribute(description="Average load over the last minute")
String getLoad01()

getLoad05

@ManagedAttribute(description="Average load over the last five minutes")
String getLoad05()

getLoad15

@ManagedAttribute(description="Average load over the last fifteen minutes")
String getLoad15()

start

@ManagedOperation(description="Start route")
void start()
           throws Exception

Throws:

Exception

stop

@ManagedOperation(description="Stop route")
void stop()
          throws Exception

Throws:

Exception

stop

@ManagedOperation(description="Stop route (using timeout in seconds)")
void stop(long timeout)
          throws Exception

Throws:

Exception

stop

@ManagedOperation(description="Stop route, abort stop after timeout (in seconds)")
boolean stop(Long timeout,
                                       Boolean abortAfterTimeout)
             throws Exception

Throws:

Exception

shutdown

@ManagedOperation(description="Shutdown route")
@Deprecated
void shutdown()
              throws Exception

Deprecated. will be removed in the near future. Use stop and remove instead

Throws:

Exception

shutdown

@ManagedOperation(description="Shutdown route (using timeout in seconds)")
@Deprecated
void shutdown(long timeout)
              throws Exception

Deprecated. will be removed in the near future. Use stop and remove instead

Throws:

Exception

remove

@ManagedOperation(description="Remove route (must be stopped)")
boolean remove()
               throws Exception

Throws:

Exception

dumpRouteAsXml

@ManagedOperation(description="Dumps the route as XML")
String dumpRouteAsXml()
                      throws Exception

Throws:

Exception

updateRouteFromXml

@ManagedOperation(description="Updates the route from XML")
void updateRouteFromXml(String xml)
                        throws Exception

Throws:

Exception

dumpRouteStatsAsXml

@ManagedOperation(description="Dumps the routes stats as XML")
String dumpRouteStatsAsXml(boolean fullStats,
                                                     boolean includeProcessors)
                           throws Exception

Throws:

Exception

reset

@ManagedOperation(description="Reset counters")
void reset(boolean includeProcessors)
           throws Exception

Throws:

Exception

createRouteStaticEndpointJson

@ManagedOperation(description="Returns the JSON representation of all the static and dynamic endpoints defined in this route")
String createRouteStaticEndpointJson()

createRouteStaticEndpointJson

@ManagedOperation(description="Returns the JSON representation of all the static endpoints (and possible dynamic) defined in this route")
String createRouteStaticEndpointJson(boolean includeDynamic)

getOldestInflightDuration

@ManagedAttribute(description="Oldest inflight exchange duration")
Long getOldestInflightDuration()

getOldestInflightExchangeId

@ManagedAttribute(description="Oldest inflight exchange id")
String getOldestInflightExchangeId()