org.apache.camel.component.jmx
Class JMXEndpoint

java.lang.Object
  org.apache.camel.impl.ServiceSupport
      org.apache.camel.impl.DefaultEndpoint
          org.apache.camel.component.jmx.JMXEndpoint

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId

public class JMXEndpoint
extends org.apache.camel.impl.DefaultEndpoint

Endpoint that describes a connection to an mbean.

The component can connect to the local platform mbean server with the following URI:

jmx://platform?options

A remote mbean server url can be provided following the initial JMX scheme like so:

jmx:service:jmx:rmi:///jndi/rmi://localhost:1099/jmxrmi?options

You can append query options to the URI in the following format, ?options=value&option2=value&...

Author:

markford

Constructor Summary

JMXEndpoint(String aEndpointUri, JMXComponent aComponent)

Method Summary

org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor aProcessor)
org.apache.camel.Producer	createProducer()
String	getFormat()
Object	getHandback()
protected ObjectName	getJMXObjectName()
NotificationFilter	getNotificationFilter()
String	getObjectDomain()
String	getObjectName()
Hashtable<String,String>	getObjectProperties()
String	getPassword()
protected String	getServerURL()
String	getUser()
boolean	isPlatformServer()
boolean	isSingleton()
boolean	isXML()
void	setFormat(String aFormat)
void	setHandback(Object aHandback)
protected void	setJMXObjectName(ObjectName aCachedObjectName)
void	setNotificationFilter(NotificationFilter aFilterRef)
void	setObjectDomain(String aObjectDomain)
void	setObjectName(String aObjectName)
void	setObjectProperties(Hashtable<String,String> aObjectProperties) Setter for the ObjectProperties is either called by reflection when processing the URI or manually by the component.
void	setPassword(String aPassword)
protected void	setServerURL(String aServerURL)
void	setUser(String aUser)

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureProperties, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, doStart, doStop, equals, getCamelContext, getComponent, getEndpointKey, getEndpointUri, getExchangePattern, getExchangeType, getId, hashCode, isLenientProperties, isSynchronous, sanitizeUri, setCamelContext, setEndpointUri, setEndpointUriIfNotSpecified, setExchangePattern, setSynchronous, toString

Methods inherited from class org.apache.camel.impl.ServiceSupport

addChildService, doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspended, isSuspending, removeChildService, resume, shutdown, start, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

JMXEndpoint

public JMXEndpoint(String aEndpointUri,
                   JMXComponent aComponent)

Method Detail

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor aProcessor)
                                         throws Exception

Throws:

Exception

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Throws:

Exception

isSingleton

public boolean isSingleton()

getFormat

public String getFormat()

setFormat

public void setFormat(String aFormat)

isXML

public boolean isXML()

isPlatformServer

public boolean isPlatformServer()

getUser

public String getUser()

setUser

public void setUser(String aUser)

getPassword

public String getPassword()

setPassword

public void setPassword(String aPassword)

getObjectDomain

public String getObjectDomain()

setObjectDomain

public void setObjectDomain(String aObjectDomain)

getObjectName

public String getObjectName()

setObjectName

public void setObjectName(String aObjectName)

getServerURL

protected String getServerURL()

setServerURL

protected void setServerURL(String aServerURL)

getNotificationFilter

public NotificationFilter getNotificationFilter()

setNotificationFilter

public void setNotificationFilter(NotificationFilter aFilterRef)

getHandback

public Object getHandback()

setHandback

public void setHandback(Object aHandback)

getObjectProperties

public Hashtable<String,String> getObjectProperties()

setObjectProperties

public void setObjectProperties(Hashtable<String,String> aObjectProperties)

Setter for the ObjectProperties is either called by reflection when processing the URI or manually by the component.

If the URI contained a value with a reference like "objectProperties=#myHashtable" then the Hashtable will be set in place.

If there are extra properties that begin with "key." then the component will create a Hashtable with these values after removing the "key." prefix.

getJMXObjectName

protected ObjectName getJMXObjectName()
                               throws MalformedObjectNameException

Throws:

MalformedObjectNameException

setJMXObjectName

protected void setJMXObjectName(ObjectName aCachedObjectName)