public interface ManagedCamelContextMBean extends ManagedPerformanceCounterMBean
Modifier and Type | Method and Description |
---|---|
void |
addOrUpdateRoutesFromXml(String xml) |
void |
addOrUpdateRoutesFromXml(String xml,
boolean urlDecode) |
boolean |
canSendToEndpoint(String endpointUri) |
List<String> |
completeEndpointPath(String componentName,
Map<String,Object> endpointParameters,
String completionText)
Helper method for tooling which returns the completion list of the endpoint path
from the given endpoint name, properties and current path expression.
|
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 |
createRouteStaticEndpointJson() |
String |
createRouteStaticEndpointJson(boolean includeDynamic) |
String |
dataFormatParameterJsonSchema(String dataFormatName)
Returns the JSON schema representation with information about the data format and the parameters it supports
|
String |
dumpRestsAsXml() |
String |
dumpRoutesAsXml() |
String |
dumpRoutesCoverageAsXml() |
String |
dumpRoutesStatsAsXml(boolean fullStats,
boolean includeProcessors) |
String |
eipParameterJsonSchema(String eipName)
Returns the JSON schema representation with information about the EIP and the parameters it supports
|
String |
explainComponentJson(String componentName,
boolean includeAllOptions)
Returns a JSON schema representation of the component parameters (not endpoint parameters) for the given component by its id.
|
String |
explainEipJson(String nameOrId,
boolean includeAllOptions)
Returns a JSON schema representation of the EIP parameters for the given EIP by its id.
|
String |
explainEndpointJson(String uri,
boolean includeAllOptions)
Returns a JSON schema representation of the endpoint parameters for the given endpoint uri
|
List<String> |
findComponentNames()
Find the names of all the Camel components available in the classpath and
Registry . |
Map<String,Properties> |
findComponents()
Find information about all the Camel components available in the classpath and
Registry . |
List<String> |
findEipNames()
Find the names of all the EIPs from camel-core.
|
Map<String,Properties> |
findEips()
Find information about all the EIPs from camel-core.
|
String |
getApplicationContextClassName() |
String |
getCamelId() |
String |
getCamelVersion() |
String |
getClassResolver() |
String |
getComponentDocumentation(String componentName)
Returns the HTML documentation for the given camel component
|
Integer |
getInflightExchanges()
Deprecated.
|
String |
getLoad01() |
String |
getLoad05() |
String |
getLoad15() |
String |
getManagementName() |
String |
getManagementStatisticsLevel() |
String |
getPackageScanClassResolver() |
Map<String,String> |
getProperties() |
String |
getProperty(String name)
Gets the value of a CamelContext property name
|
Integer |
getStartedRoutes() |
String |
getState() |
long |
getTimeout() |
TimeUnit |
getTimeUnit() |
Integer |
getTotalRoutes() |
Boolean |
getTracing() |
String |
getUptime() |
boolean |
isAllowUseOriginalMessage() |
boolean |
isMessageHistory() |
boolean |
isShutdownNowOnTimeout() |
boolean |
isUseBreadcrumb() |
boolean |
isUseMDCLogging() |
String |
languageParameterJsonSchema(String languageName)
Returns the JSON schema representation with information about the language and the parameters it supports
|
TabularData |
listComponents()
Find information about all the Camel components available in the classpath and
Registry . |
TabularData |
listEips()
Find information about all the EIPs from camel-core.
|
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 |
setProperty(String name,
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() |
dumpStatsAsXml, getDeltaProcessingTime, getExchangesCompleted, getExchangesFailed, getExchangesInflight, getExternalRedeliveries, getFailuresHandled, getFirstExchangeCompletedExchangeId, getFirstExchangeCompletedTimestamp, getFirstExchangeFailureExchangeId, getFirstExchangeFailureTimestamp, getLastExchangeCompletedExchangeId, getLastExchangeCompletedTimestamp, getLastExchangeFailureExchangeId, getLastExchangeFailureTimestamp, getLastProcessingTime, getMaxProcessingTime, getMeanProcessingTime, getMinProcessingTime, getRedeliveries, getTotalProcessingTime, isStatisticsEnabled, setStatisticsEnabled
getExchangesTotal, getResetTimestamp, getStartTimestamp, reset
@ManagedAttribute(description="Camel ID") String getCamelId()
@ManagedAttribute(description="Camel ManagementName") String getManagementName()
@ManagedAttribute(description="Camel Version") String getCamelVersion()
@ManagedAttribute(description="Camel State") String getState()
@ManagedAttribute(description="Uptime") String getUptime()
@ManagedAttribute(description="Camel Management StatisticsLevel") String getManagementStatisticsLevel()
@ManagedAttribute(description="Camel Properties") Map<String,String> getProperties()
@ManagedAttribute(description="ClassResolver class name") String getClassResolver()
@ManagedAttribute(description="PackageScanClassResolver class name") String getPackageScanClassResolver()
@ManagedAttribute(description="ApplicationContext class name") String getApplicationContextClassName()
@ManagedOperation(description="Get the value of a Camel property") String getProperty(String name) throws Exception
name
- the name of the propertyException
- is thrown if error occurred@ManagedOperation(description="Set the value of a Camel property") void setProperty(String name, String value) throws Exception
name
- the name of the propertyvalue
- the new value of the propertyException
- is thrown if error occurred@ManagedAttribute(description="Tracing") Boolean getTracing()
@ManagedAttribute(description="Tracing") void setTracing(Boolean tracing)
@ManagedAttribute(description="Current number of inflight Exchanges") @Deprecated Integer getInflightExchanges()
ManagedPerformanceCounterMBean.getExchangesInflight()
@ManagedAttribute(description="Total number of routes") Integer getTotalRoutes()
@ManagedAttribute(description="Current number of started routes") Integer getStartedRoutes()
@ManagedAttribute(description="Shutdown timeout") void setTimeout(long timeout)
@ManagedAttribute(description="Shutdown timeout") long getTimeout()
@ManagedAttribute(description="Shutdown timeout time unit") void setTimeUnit(TimeUnit timeUnit)
@ManagedAttribute(description="Shutdown timeout time unit") TimeUnit getTimeUnit()
@ManagedAttribute(description="Whether to force shutdown now when a timeout occurred") void setShutdownNowOnTimeout(boolean shutdownNowOnTimeout)
@ManagedAttribute(description="Whether to force shutdown now when a timeout occurred") boolean isShutdownNowOnTimeout()
@ManagedAttribute(description="Average load over the last minute") String getLoad01()
@ManagedAttribute(description="Average load over the last five minutes") String getLoad05()
@ManagedAttribute(description="Average load over the last fifteen minutes") String getLoad15()
@ManagedAttribute(description="Whether breadcrumbs is in use") boolean isUseBreadcrumb()
@ManagedAttribute(description="Whether allowing access to the original message during routing") boolean isAllowUseOriginalMessage()
@ManagedAttribute(description="Whether message history is enabled") boolean isMessageHistory()
@ManagedAttribute(description="Whether MDC logging is supported") boolean isUseMDCLogging()
@ManagedOperation(description="Start Camel") void start() throws Exception
Exception
@ManagedOperation(description="Stop Camel (shutdown)") void stop() throws Exception
Exception
@ManagedOperation(description="Restart Camel (stop and then start)") void restart() throws Exception
Exception
@ManagedOperation(description="Suspend Camel") void suspend() throws Exception
Exception
@ManagedOperation(description="Resume Camel") void resume() throws Exception
Exception
@ManagedOperation(description="Starts all the routes which currently is not started") void startAllRoutes() throws Exception
Exception
@ManagedOperation(description="Whether its possible to send to the endpoint (eg the endpoint has a producer)") boolean canSendToEndpoint(String endpointUri)
@ManagedOperation(description="Send body (in only)") void sendBody(String endpointUri, Object body) throws Exception
Exception
@ManagedOperation(description="Send body (String type) (in only)") void sendStringBody(String endpointUri, String body) throws Exception
Exception
@ManagedOperation(description="Send body and headers (in only)") void sendBodyAndHeaders(String endpointUri, Object body, Map<String,Object> headers) throws Exception
Exception
@ManagedOperation(description="Request body (in out)") Object requestBody(String endpointUri, Object body) throws Exception
Exception
@ManagedOperation(description="Request body (String type) (in out)") Object requestStringBody(String endpointUri, String body) throws Exception
Exception
@ManagedOperation(description="Request body and headers (in out)") Object requestBodyAndHeaders(String endpointUri, Object body, Map<String,Object> headers) throws Exception
Exception
@ManagedOperation(description="Dumps the rests as XML") String dumpRestsAsXml() throws Exception
Exception
@ManagedOperation(description="Dumps the routes as XML") String dumpRoutesAsXml() throws Exception
Exception
@ManagedOperation(description="Adds or updates existing routes from XML") void addOrUpdateRoutesFromXml(String xml) throws Exception
Exception
@ManagedOperation(description="Adds or updates existing routes from XML") void addOrUpdateRoutesFromXml(String xml, boolean urlDecode) throws Exception
Exception
@ManagedOperation(description="Dumps the CamelContext and routes stats as XML") String dumpRoutesStatsAsXml(boolean fullStats, boolean includeProcessors) throws Exception
Exception
@ManagedOperation(description="Dumps the routes coverage as XML") String dumpRoutesCoverageAsXml() throws Exception
Exception
@ManagedOperation(description="Creates the endpoint by the given URI") boolean createEndpoint(String uri) throws Exception
uri
- uri of endpoint to createException
- is thrown if error occurred@ManagedOperation(description="Removes endpoints by the given pattern") int removeEndpoints(String pattern) throws Exception
pattern
- the patternException
- is thrown if error occurredCamelContext.removeEndpoints(String)
@ManagedOperation(description="Find all Camel components available in the classpath") Map<String,Properties> findComponents() throws Exception
Registry
.Exception
- is thrown if error occurred@ManagedOperation(description="Find all Camel EIPs from camel-core") Map<String,Properties> findEips() throws Exception
Exception
- is thrown if error occurred@ManagedOperation(description="Find all Camel EIP names from camel-core") List<String> findEipNames() throws Exception
Exception
- is thrown if error occurred@ManagedOperation(description="Find all Camel components names available in the classpath") List<String> findComponentNames() throws Exception
Registry
.Exception
- is thrown if error occurred@ManagedOperation(description="List all Camel components available in the classpath") TabularData listComponents() throws Exception
Registry
.Exception
- is thrown if error occurred@ManagedOperation(description="List all Camel EIPs from camel-core") TabularData listEips() throws Exception
Exception
- is thrown if error occurred@ManagedOperation(description="Returns the JSON schema representation of the endpoint parameters for the given component name") String componentParameterJsonSchema(String componentName) throws Exception
componentName
- the name of the component to lookupException
- is thrown if error occurred@ManagedOperation(description="Returns the JSON schema representation of the data format parameters for the given data format name") String dataFormatParameterJsonSchema(String dataFormatName) throws Exception
dataFormatName
- the name of the data format to lookupException
- is thrown if error occurred@ManagedOperation(description="Returns the JSON schema representation of the language parameters for the given language name") String languageParameterJsonSchema(String languageName) throws Exception
languageName
- the name of the language to lookupException
- is thrown if error occurred@ManagedOperation(description="Returns the JSON schema representation of the EIP parameters for the given EIP name") String eipParameterJsonSchema(String eipName) throws Exception
eipName
- the name of the EIP to lookupException
- is thrown if error occurred@ManagedOperation(description="Returns a JSON schema representation of the EIP parameters for the given EIP by its id") String explainEipJson(String nameOrId, boolean includeAllOptions)
nameOrId
- the name of the EIP (NamedNode.getShortName()
or a node id to refer to a specific node from the routes.includeAllOptions
- whether to include non configured options also (eg default options)@ManagedOperation(description=" Returns a JSON schema representation of the component parameters for the given component by its id") String explainComponentJson(String componentName, boolean includeAllOptions) throws Exception
componentName
- the id of the componentincludeAllOptions
- whether to include non configured options also (eg default options)Exception
@ManagedOperation(description=" Returns a JSON schema representation of the endpoint parameters for the given endpoint uri") String explainEndpointJson(String uri, boolean includeAllOptions) throws Exception
uri
- the endpoint uriincludeAllOptions
- whether to include non configured options also (eg default options)Exception
@ManagedOperation(description="Reset counters") void reset(boolean includeRoutes) throws Exception
includeRoutes
- whether to reset all routes as well.Exception
- is thrown if error occurred@ManagedOperation(description="Returns the list of available endpoint paths for the given component name, endpoint properties and completion text") List<String> completeEndpointPath(String componentName, Map<String,Object> endpointParameters, String completionText) throws Exception
componentName
- the component nameendpointParameters
- parameters of the endpointcompletionText
- the entered text which we want to have completion suggestions forException
- is thrown if error occurred@ManagedOperation(description="Returns the HTML documentation for the given camel component") String getComponentDocumentation(String componentName) throws IOException
componentName
- the component nameIOException
@ManagedOperation(description="Returns the JSON representation of all the static and dynamic endpoints defined in all the routes") String createRouteStaticEndpointJson()
@ManagedOperation(description="Returns the JSON representation of all the static endpoints (and possible dynamic) defined in all the routes") String createRouteStaticEndpointJson(boolean includeDynamic)
Apache Camel