Package com.adaptris.core
Class AdaptrisMessageConsumerImp
- java.lang.Object
-
- com.adaptris.core.AdaptrisMessageWorkerImp
-
- com.adaptris.core.AdaptrisMessageConsumerImp
-
- All Implemented Interfaces:
AdaptrisComponent
,AdaptrisMessageConsumer
,AdaptrisMessageWorker
,ComponentLifecycle
,ComponentLifecycleExtension
,MessageEventGenerator
,StateManagedComponent
- Direct Known Subclasses:
AdaptrisPollingConsumer
,BasicJettyConsumer
,JmsConsumerImpl
,JmxNotificationConsumer
,NullMessageConsumer
public abstract class AdaptrisMessageConsumerImp extends AdaptrisMessageWorkerImp implements AdaptrisMessageConsumer, StateManagedComponent
Implementation of behaviour common to
AdaptrisMessageConsumer
s.
-
-
Field Summary
-
Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp
log
-
-
Constructor Summary
Constructors Constructor Description AdaptrisMessageConsumerImp()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
changeState(ComponentState newState)
Updates the state for the componentComponentState
.protected java.lang.String
newThreadName()
void
registerAdaptrisMessageListener(AdaptrisMessageListener l)
Sets theAdaptrisMessageListener
to use.protected java.lang.String
renameThread()
Rename the thread to something suitable.void
requestClose()
Request this component is closed.void
requestInit()
Request this component is init'd.void
requestStart()
Request this component is started.void
requestStop()
Request this component is stopped.AdaptrisMessageListener
retrieveAdaptrisMessageListener()
Returns theAdaptrisMessageListener
to use.ComponentState
retrieveComponentState()
Returns the last recordeComponentState
.-
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, withUniqueID
-
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.AdaptrisComponent
getUniqueId
-
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.ComponentLifecycle
close, init, start, stop
-
Methods inherited from interface com.adaptris.core.ComponentLifecycleExtension
prepare
-
Methods inherited from interface com.adaptris.core.MessageEventGenerator
createName, createQualifier, isTrackingEndpoint
-
-
-
-
Method Detail
-
registerAdaptrisMessageListener
public void registerAdaptrisMessageListener(AdaptrisMessageListener l)
Sets the
AdaptrisMessageListener
to use.- Specified by:
registerAdaptrisMessageListener
in interfaceAdaptrisMessageConsumer
- Parameters:
l
- theAdaptrisMessageListener
to use
-
retrieveAdaptrisMessageListener
public AdaptrisMessageListener retrieveAdaptrisMessageListener()
Returns the
AdaptrisMessageListener
to use.- Returns:
- the
AdaptrisMessageListener
to use
-
renameThread
protected java.lang.String renameThread()
Rename the thread to something suitable.- Returns:
- the old thread name if you want it.
-
newThreadName
protected java.lang.String newThreadName()
-
changeState
public void changeState(ComponentState newState)
Description copied from interface:StateManagedComponent
Updates the state for the component
ComponentState
.- Specified by:
changeState
in interfaceStateManagedComponent
-
retrieveComponentState
public ComponentState retrieveComponentState()
Description copied from interface:StateManagedComponent
Returns the last recorde
ComponentState
.- Specified by:
retrieveComponentState
in interfaceStateManagedComponent
- Returns:
- the current
ComponentState
-
requestInit
public void requestInit() throws CoreException
Description copied from interface:StateManagedComponent
Request this component is init'd.
- Specified by:
requestInit
in interfaceStateManagedComponent
- Throws:
CoreException
- wrapping any underlying Exceptions
-
requestStart
public void requestStart() throws CoreException
Description copied from interface:StateManagedComponent
Request this component is started.
- Specified by:
requestStart
in interfaceStateManagedComponent
- Throws:
CoreException
- wrapping any underlying Exceptions
-
requestStop
public void requestStop()
Description copied from interface:StateManagedComponent
Request this component is stopped.
- Specified by:
requestStop
in interfaceStateManagedComponent
-
requestClose
public void requestClose()
Description copied from interface:StateManagedComponent
Request this component is closed.
- Specified by:
requestClose
in interfaceStateManagedComponent
-
-