Skip to main content

JMX configuration for CXF services

Each server type defines several service types such as EJBs, Connection Pools, JMS Queues, and so on. The plugin defines additional service types to provide management of CXF via custom MBeans. The service element defines a service type, for example:

Plugin object section:

<service name="CXF all services monitoring">
    <property name="OBJECT_NAME"
    <metrics include="cxf"/>
    <plugin type="autoinventory" />

In order to access custom MBeans, the plugin must define its JMX ObjectName to be used with various MBeanServer interface methods. Only one ObjectName is defined per service type using the property tag within the service tag.

To configure specific definitions for the CXF service object use properties:

Property Name Description id of specific CXF bus
service service endpoint name
port service port name
operation service operation name

To enable JMX integration for CXF you need to declare the following bean in service Spring configuration:

<bean id=""
		<property name="bus" ref="cxf" />
		<property name="usePlatformMBeanServer" value="true" />
		<property name="createMBServerConnectorFactory" value="false" />
		<property name="enabled" value="true" />

To avoid any unnecessary runtime overhead, the performance counters measuring response time are disabled by default. To collect statistics for running sevices define the following bean:

<bean id="CounterRepository" 
        <property name="bus" ref="cxf" />

For further information about configuring JMX in CXF you can find at Apache CXF.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!