org.apache.camel.api.management.mbean
Interface ManagedCamelContextMBean

All Superinterfaces:
ManagedCounterMBean, ManagedPerformanceCounterMBean
All Known Implementing Classes:
ManagedCamelContext

public interface ManagedCamelContextMBean
extends ManagedPerformanceCounterMBean


Method Summary
 void addOrUpdateRoutesFromXml(String xml)
           
 boolean createEndpoint(String uri)
          Creates the endpoint by the given uri
 String dumpRoutesAsXml()
           
 String dumpRoutesStatsAsXml(boolean fullStats, boolean includeProcessors)
           
 String getCamelId()
           
 String getCamelVersion()
           
 Integer getInflightExchanges()
           
 String getLoad01()
           
 String getLoad05()
           
 String getLoad15()
           
 String getManagementName()
           
 Map<String,String> getProperties()
           
 String getState()
           
 long getTimeout()
           
 TimeUnit getTimeUnit()
           
 Boolean getTracing()
           
 String getUptime()
           
 boolean isShutdownNowOnTimeout()
           
 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 resume()
           
 void sendBody(String endpointUri, Object body)
           
 void sendBodyAndHeaders(String endpointUri, Object body, Map<String,Object> headers)
           
 void sendStringBody(String endpointUri, String body)
           
 void setShutdownNowOnTimeout(boolean shutdownNowOnTimeout)
           
 void setTimeout(long timeout)
           
 void setTimeUnit(TimeUnit timeUnit)
           
 void setTracing(Boolean tracing)
           
 void start()
           
 void stop()
           
 void suspend()
           
 
Methods inherited from interface org.apache.camel.api.management.mbean.ManagedPerformanceCounterMBean
dumpStatsAsXml, getExchangesCompleted, getExchangesFailed, 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, reset
 

Method Detail

getCamelId

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

getManagementName

@ManagedAttribute(description="Camel Management Name")
String getManagementName()

getCamelVersion

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

getState

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

getUptime

@ManagedAttribute(description="Uptime")
String getUptime()

getProperties

@ManagedAttribute(description="Camel Properties")
Map<String,String> getProperties()

getTracing

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

setTracing

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

getInflightExchanges

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

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

start

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

stop

@ManagedOperation(description="Stop Camel (shutdown)")
void stop()
          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

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

dumpRoutesAsXml

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

addOrUpdateRoutesFromXml

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

dumpRoutesStatsAsXml

@ManagedOperation(description="Dumps the routes stats as XML")
String dumpRoutesStatsAsXml(boolean fullStats,
                                                        boolean includeProcessors)
                            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:
CamelContext.removeEndpoints(String)


Apache CAMEL