com.adaptris.core.triggered

Class JmxConsumer

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageConsumerImp

com.adaptris.core.triggered.JmxConsumer

All Implemented Interfaces:

AdaptrisComponent, AdaptrisMessageConsumer, AdaptrisMessageWorker, ComponentLifecycle, ComponentLifecycleExtension, LicensedComponent, MessageEventGenerator, StateManagedComponent

public class JmxConsumer
extends AdaptrisMessageConsumerImp
implements LicensedComponent

Consumer type that can fires based on a JMX invocation.

The destination returned by ConsumeDestination is used as part of the ObjectName

In the adapter configuration file this class is aliased as triggered-jmx-consumer which is the preferred alternative to the fully qualified classname when building your configuration.

License Required: STANDARD

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JMX_OBJECT_NAME_PREFIX

Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

log

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
JmxConsumer()
JmxConsumer(ConsumeDestination d)

Method Summary

Modifier and Type	Method and Description
void	close()
void	init()
boolean	isEnabled(License license)
void	prepare()
void	start()
void	stop()

Methods inherited from class com.adaptris.core.AdaptrisMessageConsumerImp

changeState, getDestination, registerAdaptrisMessageListener, renameThread, requestClose, requestInit, requestStart, requestStop, retrieveAdaptrisMessageListener, retrieveComponentState, setDestination

Methods inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

createName, createQualifier, decode, encode, getEncoder, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsTrackingEndpoint, setMessageFactory, setUniqueId, withMessageFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.adaptris.core.AdaptrisMessageConsumer

consumeLocationKey

Methods inherited from interface com.adaptris.core.AdaptrisMessageWorker

decode, encode, getEncoder, getMessageFactory, handleConnectionException, registerConnection, retrieveConnection, setEncoder, setMessageFactory

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Field Detail

JMX_OBJECT_NAME_PREFIX

public static final java.lang.String JMX_OBJECT_NAME_PREFIX

See Also:

Constant Field Values

Constructor Detail

JmxConsumer

public JmxConsumer()

JmxConsumer

public JmxConsumer(ConsumeDestination d)

Method Detail

prepare

public void prepare()
             throws CoreException

Specified by:

prepare in interface ComponentLifecycleExtension

Throws:

CoreException

isEnabled

public boolean isEnabled(License license)

Specified by:

isEnabled in interface LicensedComponent

close

public void close()

Specified by:

close in interface ComponentLifecycle

init

public void init()
          throws CoreException

Specified by:

init in interface ComponentLifecycle

Throws:

CoreException

start

public void start()
           throws CoreException

Specified by:

start in interface ComponentLifecycle

Throws:

CoreException

stop

public void stop()

Specified by:

stop in interface ComponentLifecycle