Package org.apache.camel.api.management.mbean

Interface ManagedRouteMBean

All Superinterfaces:

ManagedCounterMBean, ManagedPerformanceCounterMBean

All Known Subinterfaces:

ManagedSuspendableRouteMBean

public interface ManagedRouteMBean
extends ManagedPerformanceCounterMBean

Method Summary

Modifier and Type	Method	Description
String	dumpRouteAsXml()
String	dumpRouteAsXml(boolean resolvePlaceholders)
String	dumpRouteAsXml(boolean resolvePlaceholders, boolean generatedIds)
String	dumpRouteAsYaml()
String	dumpRouteAsYaml(boolean resolvePlaceholders)
String	dumpRouteAsYaml(boolean resolvePlaceholders, boolean uriAsParameters)
String	dumpRouteAsYaml(boolean resolvePlaceholders, boolean uriAsParameters, boolean generatedIds)
String	dumpRouteSourceLocationsAsXml()
String	dumpRouteStatsAsXml(boolean fullStats, boolean includeProcessors)
String	dumpStepStatsAsXml(boolean fullStats)
String	getCamelId()
String	getCamelManagementName()
String	getDescription()
String	getEndpointUri()
Boolean	getHasRouteController()
RouteError	getLastError()
String	getLoad01()
String	getLoad05()
String	getLoad15()
Boolean	getLogMask()
Boolean	getMessageHistory()
String	getNodePrefixId()
Long	getOldestInflightDuration()
String	getOldestInflightExchangeId()
String	getRouteConfigurationId()
String	getRouteGroup()
String	getRouteId()
String	getRoutePolicyList()
TabularData	getRouteProperties()
String	getSourceLocation()
String	getSourceLocationShort()
String	getState()
String	getThroughput()
Boolean	getTracing()
String	getUptime()
long	getUptimeMillis()
boolean	isCreatedByKamelet()
boolean	isCreatedByRouteTemplate()
boolean	isRemoteEndpoint()
boolean	isUpdateRouteEnabled()
Collection<String>	processorIds()
boolean	remove()
void	reset(boolean includeProcessors)
void	restart()
void	restart(long delay)
void	setTracing(Boolean tracing)
void	start()
void	stop()
void	stop(long timeout)
boolean	stop(Long timeout, Boolean abortAfterTimeout)
void	stopAndFail()
void	updateRouteFromXml(String xml)

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

getExchangesTotal, getResetTimestamp, getStartTimestamp, reset

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

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

Method Details

getRouteId

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

getNodePrefixId

@ManagedAttribute(description="Node Prefix ID")
String getNodePrefixId()

getRouteGroup

@ManagedAttribute(description="Route Group")
String getRouteGroup()

isCreatedByRouteTemplate

@ManagedAttribute(description="Is this route created from a route template (or Kamelet)")
boolean isCreatedByRouteTemplate()

isCreatedByKamelet

@ManagedAttribute(description="Is this route created from a Kamelet")
boolean isCreatedByKamelet()

getRouteProperties

@ManagedAttribute(description="Route Properties")
TabularData getRouteProperties()

getDescription

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

getSourceLocation

@ManagedAttribute(description="Route Source Location")
String getSourceLocation()

getSourceLocationShort

@ManagedAttribute(description="Route Source Location (Short)")
String getSourceLocationShort()

getRouteConfigurationId

@ManagedAttribute(description="Route Configuration ID")
String getRouteConfigurationId()

getEndpointUri

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

getState

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

getUptime

@ManagedAttribute(description="Route Uptime [human readable text]")
String getUptime()

getUptimeMillis

@ManagedAttribute(description="Route Uptime [milliseconds]")
long getUptimeMillis()

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()

getLogMask

@ManagedAttribute(description="Whether security mask for Logging is enabled")
Boolean getLogMask()

getRoutePolicyList

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

getLoad01

@ManagedAttribute(description="Average load (inflight messages, not cpu) over the last minute")
String getLoad01()

getLoad05

@ManagedAttribute(description="Average load (inflight messages, not cpu) over the last five minutes")
String getLoad05()

getLoad15

@ManagedAttribute(description="Average load (inflight messages, not cpu) over the last fifteen minutes")
String getLoad15()

getThroughput

@ManagedAttribute(description="Throughput message/second")
String getThroughput()

start

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

Throws:

Exception

stop

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

Throws:

Exception

stopAndFail

@ManagedOperation(description="Stop and marks the route as failed (health-check reporting as DOWN)")
void stopAndFail()
          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

remove

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

Throws:

Exception

restart

@ManagedOperation(description="Restarts route (1 second delay before starting)")
void restart()
      throws Exception

Throws:

Exception

restart

@ManagedOperation(description="Restarts route (using delay in seconds before starting)")
void restart(long delay)
      throws Exception

Throws:

Exception

dumpRouteAsXml

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

Throws:

Exception

dumpRouteAsXml

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

Throws:

Exception

dumpRouteAsXml

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

Throws:

Exception

dumpRouteAsYaml

@ManagedOperation(description="Dumps the route as YAML")
String dumpRouteAsYaml()
                throws Exception

Throws:

Exception

dumpRouteAsYaml

@ManagedOperation(description="Dumps the route as YAML")
String dumpRouteAsYaml(boolean resolvePlaceholders)
                throws Exception

Throws:

Exception

dumpRouteAsYaml

@ManagedOperation(description="Dumps the route as YAML")
String dumpRouteAsYaml(boolean resolvePlaceholders,
 boolean uriAsParameters)
                throws Exception

Throws:

Exception

dumpRouteAsYaml

@ManagedOperation(description="Dumps the route as YAML")
String dumpRouteAsYaml(boolean resolvePlaceholders,
 boolean uriAsParameters,
 boolean generatedIds)
                throws Exception

Throws:

Exception

dumpRouteStatsAsXml

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

Throws:

Exception

dumpStepStatsAsXml

@ManagedOperation(description="Dumps the route and steps stats as XML")
String dumpStepStatsAsXml(boolean fullStats)
                   throws Exception

Throws:

Exception

dumpRouteSourceLocationsAsXml

@ManagedOperation(description="Dumps the route with mappings between node ids and their source location/line-number (currently only XML and YAML routes supported) as XML")
String dumpRouteSourceLocationsAsXml()
                              throws Exception

Throws:

Exception

reset

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

Throws:

Exception

getOldestInflightDuration

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

getOldestInflightExchangeId

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

getHasRouteController

@ManagedAttribute(description="Is using route controller")
Boolean getHasRouteController()

getLastError

@ManagedAttribute(description="Last error")
RouteError getLastError()

processorIds

@ManagedOperation(description="IDs for the processors that are part of this route")
Collection<String> processorIds()
                         throws Exception

Throws:

Exception

updateRouteFromXml

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

Throws:

Exception

isUpdateRouteEnabled

@ManagedAttribute(description="Whether update route from XML is enabled")
boolean isUpdateRouteEnabled()

isRemoteEndpoint

@ManagedAttribute(description="Whether the consumer connects to remote or local systems")
boolean isRemoteEndpoint()