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

Interface ManagedCamelContextMBean

All Superinterfaces:

ManagedCounterMBean, ManagedPerformanceCounterMBean

public interface ManagedCamelContextMBean
extends ManagedPerformanceCounterMBean

Method Summary

Modifier and Type	Method	Description
void	addOrUpdateRoutesFromXml(String xml)
void	addOrUpdateRoutesFromXml(String xml, boolean urlDecode)
boolean	canSendToEndpoint(String endpointUri)
String	componentParameterJsonSchema(String componentName)	Returns the JSON schema representation with information about the component and the endpoint parameters it supports
boolean	createEndpoint(String uri)	Creates the endpoint by the given uri
String	dataFormatParameterJsonSchema(String dataFormatName)	Returns the JSON schema representation with information about the data format and the parameters it supports
String	dumpRestsAsXml()
String	dumpRestsAsXml(boolean resolvePlaceholders)
String	dumpRoutesAsXml()
String	dumpRoutesAsXml(boolean resolvePlaceholders)
String	dumpRoutesAsXml(boolean resolvePlaceholders, boolean resolveDelegateEndpoints)
String	dumpRoutesCoverageAsXml()
String	dumpRoutesStatsAsXml(boolean fullStats, boolean includeProcessors)
String	dumpStepStatsAsXml(boolean fullStats)
String	eipParameterJsonSchema(String eipName)	Returns the JSON schema representation with information about the EIP and the parameters it supports
String	getApplicationContextClassName()
String	getCamelId()
String	getCamelVersion()
String	getClassResolver()
String	getGlobalOption(String key)	Gets the value of a CamelContext global option
Map<String,String>	getGlobalOptions()
String	getHeadersMapFactoryClassName()
String	getLoad01()
String	getLoad05()
String	getLoad15()
String	getManagementName()
String	getManagementStatisticsLevel()
String	getPackageScanClassResolver()
Integer	getStartedRoutes()
String	getState()
long	getTimeout()
TimeUnit	getTimeUnit()
Integer	getTotalRoutes()
Boolean	getTracing()
String	getUptime()
long	getUptimeMillis()
boolean	isAllowUseOriginalMessage()
boolean	isLogMask()
boolean	isMessageHistory()
boolean	isShutdownNowOnTimeout()
boolean	isUseBreadcrumb()
boolean	isUseDataType()
boolean	isUseMDCLogging()
String	languageParameterJsonSchema(String languageName)	Returns the JSON schema representation with information about the language and the parameters it supports
int	removeEndpoints(String pattern)	Removes the endpoint by the given pattern
Object	requestBody(String endpointUri, Object body)
Object	requestBodyAndHeaders(String endpointUri, Object body, Map<String,Object> headers)
Object	requestStringBody(String endpointUri, String body)
void	reset(boolean includeRoutes)	Resets all the performance counters.
void	restart()
void	resume()
void	sendBody(String endpointUri, Object body)
void	sendBodyAndHeaders(String endpointUri, Object body, Map<String,Object> headers)
void	sendStringBody(String endpointUri, String body)
void	setGlobalOption(String key, String value)	Sets the value of a CamelContext property name
void	setShutdownNowOnTimeout(boolean shutdownNowOnTimeout)
void	setTimeout(long timeout)
void	setTimeUnit(TimeUnit timeUnit)
void	setTracing(Boolean tracing)
void	start()
void	startAllRoutes()
void	stop()
void	suspend()

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, getLastExchangeCompletedExchangeId, getLastExchangeCompletedTimestamp, getLastExchangeFailureExchangeId, getLastExchangeFailureTimestamp, getLastProcessingTime, getMaxProcessingTime, getMeanProcessingTime, getMinProcessingTime, getRedeliveries, getTotalProcessingTime, isStatisticsEnabled, setStatisticsEnabled

Method Detail

getCamelId

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

getManagementName

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

getCamelVersion

@ManagedAttribute(description="Camel Version")
String getCamelVersion()

getState

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

getUptime

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

getUptimeMillis

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

getManagementStatisticsLevel

@ManagedAttribute(description="Camel Management StatisticsLevel")
String getManagementStatisticsLevel()

getGlobalOptions

@ManagedAttribute(description="Camel Global Options")
Map<String,String> getGlobalOptions()

getClassResolver

@ManagedAttribute(description="ClassResolver class name")
String getClassResolver()

getPackageScanClassResolver

@ManagedAttribute(description="PackageScanClassResolver class name")
String getPackageScanClassResolver()

getApplicationContextClassName

@ManagedAttribute(description="ApplicationContext class name")
String getApplicationContextClassName()

getHeadersMapFactoryClassName

@ManagedAttribute(description="HeadersMapFactory class name")
String getHeadersMapFactoryClassName()

getGlobalOption

@ManagedOperation(description="Gets the value of a Camel global option")
String getGlobalOption(String key)
                throws Exception

Gets the value of a CamelContext global option

Parameters:

key - the global option key

Returns:

the global option value

Throws:

Exception - when an error occurred

setGlobalOption

@ManagedOperation(description="Sets the value of a Camel global option")
void setGlobalOption(String key,
                     String value)
              throws Exception

Sets the value of a CamelContext property name

Parameters:

key - the global option key

value - the global option value

Throws:

Exception - when an error occurred

getTracing

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

setTracing

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

getTotalRoutes

@ManagedAttribute(description="Total number of routes")
Integer getTotalRoutes()

getStartedRoutes

@ManagedAttribute(description="Current number of started routes")
Integer getStartedRoutes()

setTimeout

@ManagedAttribute(description="Shutdown timeout")
void setTimeout(long timeout)

getTimeout

@ManagedAttribute(description="Shutdown timeout")
long getTimeout()

setTimeUnit

@ManagedAttribute(description="Shutdown timeout time unit")
void setTimeUnit(TimeUnit timeUnit)

getTimeUnit

@ManagedAttribute(description="Shutdown timeout time unit")
TimeUnit getTimeUnit()

setShutdownNowOnTimeout

@ManagedAttribute(description="Whether to force shutdown now when a timeout occurred")
void setShutdownNowOnTimeout(boolean shutdownNowOnTimeout)

isShutdownNowOnTimeout

@ManagedAttribute(description="Whether to force shutdown now when a timeout occurred")
boolean isShutdownNowOnTimeout()

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

isUseBreadcrumb

@ManagedAttribute(description="Whether breadcrumbs is in use")
boolean isUseBreadcrumb()

isAllowUseOriginalMessage

@ManagedAttribute(description="Whether allowing access to the original message during routing")
boolean isAllowUseOriginalMessage()

isMessageHistory

@ManagedAttribute(description="Whether message history is enabled")
boolean isMessageHistory()

isLogMask

@ManagedAttribute(description="Whether security mask for Logging is enabled")
boolean isLogMask()

isUseMDCLogging

@ManagedAttribute(description="Whether MDC logging is supported")
boolean isUseMDCLogging()

isUseDataType

@ManagedAttribute(description="Whether Message DataType is enabled")
boolean isUseDataType()

start

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

Throws:

Exception

stop

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

Throws:

Exception

restart

@ManagedOperation(description="Restart Camel (stop and then start)")
void restart()
      throws Exception

Throws:

Exception

suspend

@ManagedOperation(description="Suspend Camel")
void suspend()
      throws Exception

Throws:

Exception

resume

@ManagedOperation(description="Resume Camel")
void resume()
     throws Exception

Throws:

Exception

startAllRoutes

@ManagedOperation(description="Starts all the routes which currently is not started")
void startAllRoutes()
             throws Exception

Throws:

Exception

canSendToEndpoint

@ManagedOperation(description="Whether its possible to send to the endpoint (eg the endpoint has a producer)")
boolean canSendToEndpoint(String endpointUri)

sendBody

@ManagedOperation(description="Send body (in only)")
void sendBody(String endpointUri,
              Object body)
       throws Exception

Throws:

Exception

sendStringBody

@ManagedOperation(description="Send body (String type) (in only)")
void sendStringBody(String endpointUri,
                    String body)
             throws Exception

Throws:

Exception

sendBodyAndHeaders

@ManagedOperation(description="Send body and headers (in only)")
void sendBodyAndHeaders(String endpointUri,
                        Object body,
                        Map<String,Object> headers)
                 throws Exception

Throws:

Exception

requestBody

@ManagedOperation(description="Request body (in out)")
Object requestBody(String endpointUri,
                   Object body)
            throws Exception

Throws:

Exception

requestStringBody

@ManagedOperation(description="Request body (String type) (in out)")
Object requestStringBody(String endpointUri,
                         String body)
                  throws Exception

Throws:

Exception

requestBodyAndHeaders

@ManagedOperation(description="Request body and headers (in out)")
Object requestBodyAndHeaders(String endpointUri,
                             Object body,
                             Map<String,Object> headers)
                      throws Exception

Throws:

Exception

dumpRestsAsXml

@ManagedOperation(description="Dumps the rests as XML")
String dumpRestsAsXml()
               throws Exception

Throws:

Exception

dumpRestsAsXml

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

Throws:

Exception

dumpRoutesAsXml

@ManagedOperation(description="Dumps the routes as XML")
String dumpRoutesAsXml()
                throws Exception

Throws:

Exception

dumpRoutesAsXml

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

Throws:

Exception

dumpRoutesAsXml

@ManagedOperation(description="Dumps the routes as XML")
String dumpRoutesAsXml(boolean resolvePlaceholders,
                       boolean resolveDelegateEndpoints)
                throws Exception

Throws:

Exception

addOrUpdateRoutesFromXml

@ManagedOperation(description="Adds or updates existing routes from XML")
void addOrUpdateRoutesFromXml(String xml)
                       throws Exception

Throws:

Exception

addOrUpdateRoutesFromXml

@ManagedOperation(description="Adds or updates existing routes from XML")
void addOrUpdateRoutesFromXml(String xml,
                              boolean urlDecode)
                       throws Exception

Throws:

Exception

dumpRoutesStatsAsXml

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

Throws:

Exception

dumpStepStatsAsXml

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

Throws:

Exception

dumpRoutesCoverageAsXml

@ManagedOperation(description="Dumps the routes coverage as XML")
String dumpRoutesCoverageAsXml()
                        throws Exception

Throws:

Exception

createEndpoint

@ManagedOperation(description="Creates the endpoint by the given URI")
boolean createEndpoint(String uri)
                throws Exception

Creates the endpoint by the given uri

Parameters:

uri - uri of endpoint to create

Returns:

true if a new endpoint was created, false if the endpoint already existed

Throws:

Exception - is thrown if error occurred

removeEndpoints

@ManagedOperation(description="Removes endpoints by the given pattern")
int removeEndpoints(String pattern)
             throws Exception

Removes the endpoint by the given pattern

Parameters:

pattern - the pattern

Returns:

number of endpoints removed

Throws:

Exception - is thrown if error occurred

See Also:

org.apache.camel.CamelContext#removeEndpoints(String)

componentParameterJsonSchema

@ManagedOperation(description="Returns the JSON schema representation of the endpoint parameters for the given component name")
String componentParameterJsonSchema(String componentName)
                             throws Exception

Returns the JSON schema representation with information about the component and the endpoint parameters it supports

Parameters:

componentName - the name of the component to lookup

Throws:

Exception - is thrown if error occurred

dataFormatParameterJsonSchema

@ManagedOperation(description="Returns the JSON schema representation of the data format parameters for the given data format name")
String dataFormatParameterJsonSchema(String dataFormatName)
                              throws Exception

Returns the JSON schema representation with information about the data format and the parameters it supports

Parameters:

dataFormatName - the name of the data format to lookup

Throws:

Exception - is thrown if error occurred

languageParameterJsonSchema

@ManagedOperation(description="Returns the JSON schema representation of the language parameters for the given language name")
String languageParameterJsonSchema(String languageName)
                            throws Exception

Returns the JSON schema representation with information about the language and the parameters it supports

Parameters:

languageName - the name of the language to lookup

Throws:

Exception - is thrown if error occurred

eipParameterJsonSchema

@ManagedOperation(description="Returns the JSON schema representation of the EIP parameters for the given EIP name")
String eipParameterJsonSchema(String eipName)
                       throws Exception

Returns the JSON schema representation with information about the EIP and the parameters it supports

Parameters:

eipName - the name of the EIP to lookup

Throws:

Exception - is thrown if error occurred

reset

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

Resets all the performance counters.

Parameters:

includeRoutes - whether to reset all routes as well.

Throws:

Exception - is thrown if error occurred