@ComponentProfile(summary="Default NO-OP consumer implementation",
tag="consumer,base",
recommended=NullConnection.class)
public class NullMessageConsumer
extends AdaptrisMessageConsumerImp
Null implementation of AdaptrisMessageConsumer.
In the adapter configuration file this class is aliased as null-message-consumer which is the preferred alternative to the fully qualified classname when building your configuration.
logCONFIRMATION_ID_KEY| Constructor and Description |
|---|
NullMessageConsumer() |
| Modifier and Type | Method and Description |
|---|---|
void |
close()
Closes the component.
|
void |
init()
Initialises the component.
|
void |
prepare()
Prepare for initialisation.
|
void |
start()
Starts the component.
|
void |
stop()
Stop the component
|
changeState, getDestination, registerAdaptrisMessageListener, renameThread, requestClose, requestInit, requestStart, requestStop, retrieveAdaptrisMessageListener, retrieveComponentState, setDestinationcreateName, createQualifier, decode, encode, getEncoder, getIsConfirmation, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isConfirmation, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsConfirmation, setIsTrackingEndpoint, setMessageFactory, setUniqueId, withMessageFactoryclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdecode, encode, getEncoder, getMessageFactory, handleConnectionException, registerConnection, retrieveConnection, setEncoder, setMessageFactorygetUniqueIdcreateName, createQualifier, isConfirmation, isTrackingEndpointpublic void close()
ComponentLifecycle
A closed component should release any connections it uses, etc. and clean up completely.
Throwing a RuntimeException may cause unintended consequences
ComponentLifecycle.close()public void init()
throws CoreException
ComponentLifecycleComponent initialisation includes config verification, creation of connections etc.
CoreException - wrapping any underlying ExceptionsComponentLifecycle.init()public void start()
throws CoreException
ComponentLifecycle
Once a component is started it should be ready to process messages. In the case of
AdaptrisMessageConsumer, calling start will begin message delivery.
CoreException - wrapping any underlying ExceptionsComponentLifecycle.start()public void stop()
ComponentLifecycle
A stopped component is not expected to be ready to process messages. In the case of
AdaptrisMessageConsumer, calling stop will pause message delivery. Throwing a
RuntimeException may cause unintended consequences
ComponentLifecycle.stop()public void prepare()
throws CoreException
ComponentLifecycleExtensionCoreException