public interface ManagementAgent extends Service
Modifier and Type | Method and Description |
---|---|
Boolean |
getEndpointRuntimeStatisticsEnabled()
Gets whether endpoint runtime statistics is enabled
|
Boolean |
getIncludeHostName()
Gets whether host name is included in MBean names.
|
Boolean |
getLoadStatisticsEnabled()
Gets whether load statistics is enabled
|
String |
getManagementNamePattern()
The naming pattern for creating the CamelContext management name.
|
Boolean |
getMask()
Whether to remove detected sensitive information (such as passwords) from MBean names and attributes.
|
String |
getMBeanObjectDomainName()
Get domain name for Camel MBeans.
|
MBeanServer |
getMBeanServer()
Get the MBeanServer which hosts managed objects.
|
String |
getMBeanServerDefaultDomain()
Gets the default domain on the MBean server
|
Boolean |
getOnlyRegisterProcessorWithCustomId()
Whether to only register processors which has a custom id assigned.
|
Boolean |
getRegisterAlways()
Whether to always register mbeans.
|
Boolean |
getRegisterNewRoutes()
Whether to register mbeans when starting a new route
This option is default true.
|
ManagementStatisticsLevel |
getStatisticsLevel()
§ Gets the statistics level
|
Boolean |
getUseHostIPAddress()
Gets whether host IP Address to be used instead of host name.
|
Boolean |
getUsePlatformMBeanServer()
Whether to use the platform MBean Server.
|
boolean |
isRegistered(ObjectName name)
Is the given object registered
|
<T> T |
newProxyClient(ObjectName name,
Class<T> mbean)
Creates a new proxy client
|
void |
register(Object obj,
ObjectName name)
Registers object with management infrastructure with a specific name.
|
void |
register(Object obj,
ObjectName name,
boolean forceRegistration)
Registers object with management infrastructure with a specific name.
|
void |
setEndpointRuntimeStatisticsEnabled(Boolean flag)
Sets whether endpoint runtime statistics is enabled (gathers runtime usage of each incoming and outgoing
endpoints).
|
void |
setIncludeHostName(Boolean includeHostName)
Sets whether to include host name in the
ManagementObjectNameStrategy . |
void |
setLoadStatisticsEnabled(Boolean flag)
Sets whether load statistics is enabled (gathers load statistics using a background thread per CamelContext).
|
void |
setManagementNamePattern(String managementNamePattern)
The naming pattern for creating the CamelContext management name.
|
void |
setMask(Boolean sanitize)
Whether to remove detected sensitive information (such as passwords) from MBean names and attributes.
|
void |
setMBeanObjectDomainName(String domainName)
Sets the object domain name
|
void |
setMBeanServer(MBeanServer mbeanServer)
Sets a custom mbean server to use
|
void |
setMBeanServerDefaultDomain(String domain)
Sets the default domain on the MBean server
|
void |
setOnlyRegisterProcessorWithCustomId(Boolean onlyRegisterProcessorWithCustomId)
Whether to only register processors which has a custom id assigned.
|
void |
setRegisterAlways(Boolean registerAlways)
Whether to always register mbeans.
|
void |
setRegisterNewRoutes(Boolean registerNewRoutes)
Whether to register mbeans when starting a new route
This option is default true.
|
void |
setStatisticsLevel(ManagementStatisticsLevel level)
Sets the statistics level
Default is
ManagementStatisticsLevel.Default
The level can be set to Extended to gather additional information |
void |
setUseHostIPAddress(Boolean useHostIPAddress)
Sets whether to use host IP Address
|
void |
setUsePlatformMBeanServer(Boolean usePlatformMBeanServer)
Whether to use the platform MBean Server.
|
void |
unregister(ObjectName name)
Unregisters object based upon registered name
|
void register(Object obj, ObjectName name) throws JMException
obj
- the object to registername
- the nameJMException
- is thrown if the registration failedvoid register(Object obj, ObjectName name, boolean forceRegistration) throws JMException
obj
- the object to registername
- the nameforceRegistration
- if set to true, then object will be registered despite existing object is
already registered with the name.JMException
- is thrown if the registration failedvoid unregister(ObjectName name) throws JMException
name
- the nameJMException
- is thrown if the unregistration failedboolean isRegistered(ObjectName name)
name
- the name<T> T newProxyClient(ObjectName name, Class<T> mbean)
name
- the mbean namembean
- the client interface, such as from the org.apache.camel.api.management.mbean
package.MBeanServer getMBeanServer()
void setMBeanServer(MBeanServer mbeanServer)
mbeanServer
- the custom mbean serverString getMBeanObjectDomainName()
void setMBeanServerDefaultDomain(String domain)
domain
- the domainString getMBeanServerDefaultDomain()
void setMBeanObjectDomainName(String domainName)
domainName
- the object domain namevoid setUsePlatformMBeanServer(Boolean usePlatformMBeanServer)
usePlatformMBeanServer
- true to use platform MBean serverBoolean getUsePlatformMBeanServer()
Boolean getOnlyRegisterProcessorWithCustomId()
void setOnlyRegisterProcessorWithCustomId(Boolean onlyRegisterProcessorWithCustomId)
onlyRegisterProcessorWithCustomId
- true to only register if custom id has been assignedBoolean getRegisterAlways()
void setRegisterAlways(Boolean registerAlways)
registerAlways
- true to always registerBoolean getRegisterNewRoutes()
void setRegisterNewRoutes(Boolean registerNewRoutes)
registerNewRoutes
- true to register when starting a new routeBoolean getMask()
void setMask(Boolean sanitize)
Boolean getIncludeHostName()
void setIncludeHostName(Boolean includeHostName)
ManagementObjectNameStrategy
.
By default this is turned off from Camel 2.13 onwards, but this option can be set to true to include the
hostname as Camel 2.12 or older releases does.includeHostName
- true to include host name in the MBean names.String getManagementNamePattern()
void setManagementNamePattern(String managementNamePattern)
void setLoadStatisticsEnabled(Boolean flag)
flag
- true to enable load statisticsBoolean getLoadStatisticsEnabled()
void setEndpointRuntimeStatisticsEnabled(Boolean flag)
flag
- true to enable endpoint runtime statisticsBoolean getEndpointRuntimeStatisticsEnabled()
void setStatisticsLevel(ManagementStatisticsLevel level)
ManagementStatisticsLevel.Default
The level can be set to Extended to gather additional informationlevel
- the new levelManagementStatisticsLevel getStatisticsLevel()
Boolean getUseHostIPAddress()
void setUseHostIPAddress(Boolean useHostIPAddress)
useHostIPAddress
- true to use IP Address.Apache Camel