StandaloneConsumer (Base Interlok)

java.lang.Object
- com.adaptris.core.StandaloneConsumer

All Implemented Interfaces:

AdaptrisComponent, AdaptrisMessageConsumer, AdaptrisMessageWorker, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, StateManagedComponent
```
@ComponentProfile(summary="Standalone wrapper for a consumer and connection",
                  tag="consumer,base")
public class StandaloneConsumer
extends java.lang.Object
implements AdaptrisMessageConsumer, StateManagedComponent, ComponentLifecycleExtension
```
Wrapper class for a AdaptrisMessageConsumer and a AdaptrisConnection. Implements AdaptrisMessageConsumer and delegates all method calls to the underlying consumer.

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

Field Summary
- Fields inherited from interface com.adaptris.core.MessageEventGenerator
  CONFIRMATION_ID_KEY

Constructor Summary

Constructors
Constructor and Description
`StandaloneConsumer()` Creates a new instance.
`StandaloneConsumer(AdaptrisConnection c)`
`StandaloneConsumer(AdaptrisConnection c, AdaptrisMessageConsumer amc)`
`StandaloneConsumer(AdaptrisMessageConsumer consumer)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`changeState(ComponentState newState)` Updates the state for the component `ComponentState`.
`void`	`close()` Closes the component.
`java.lang.String`	`createName()` Create a name for any `MleMarker` that is generated.
`java.lang.String`	`createQualifier()` Create a qualifier for any `MleMarker` that is generated.
`AdaptrisMessage`	`decode(byte[] bytes)` Decodes the passed byte[] using the configured `AdaptrisMessageEncoder`.
`byte[]`	`encode(AdaptrisMessage msg)` Encode the passed message using the configured `AdaptrisMessageEncoder`.
`AdaptrisConnection`	`getConnection()` Get the connection to be used.
`AdaptrisMessageConsumer`	`getConsumer()` Returns the underlying `AdaptrisMessageConsumer`.
`ConsumeDestination`	`getDestination()` Returns the `ConsumeDestination` to use.
`AdaptrisMessageEncoder`	`getEncoder()` Returns the `AdaptrisMessageEncoder` to use.
`java.lang.Boolean`	`getIsTrackingEndpoint()`
`AdaptrisMessageFactory`	`getMessageFactory()`
`java.lang.String`	`getUniqueId()` Get the unique-id that is associated with this component.
`void`	`handleConnectionException()` Called if a connection exception is encountered.
`void`	`init()` Initialises the component.
`boolean`	`isTrackingEndpoint()` Returns true if this should be considered an 'end-point' for tracking purposes, otherwise false.
`void`	`prepare()` Prepare for initialisation.
`void`	`registerAdaptrisMessageListener(AdaptrisMessageListener l)` Sets the `AdaptrisMessageListener` to use.
`void`	`registerConnection(AdaptrisConnection conn)` Sets the `AdaptrisConnection` to use.
`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.
`ComponentState`	`retrieveComponentState()` Returns the last recorde `ComponentState`.
`<T> T`	`retrieveConnection(java.lang.Class<T> type)` Return this components underlying connection.
`void`	`setConnection(AdaptrisConnection conn)` Set the connection to be used.
`void`	`setConsumer(AdaptrisMessageConsumer cons)` Sets the underlying `AdaptrisMessageConsumer`.
`void`	`setDestination(ConsumeDestination destination)` Sets the `ConsumeDestination` to use.
`void`	`setEncoder(AdaptrisMessageEncoder encoder)` Sets the `AdaptrisMessageEncoder` to use.
`void`	`setIsTrackingEndpoint(java.lang.Boolean b)`
`void`	`setMessageFactory(AdaptrisMessageFactory f)` Set the message factory used when creating AdaptrisMessage instances.
`void`	`start()` Starts the component.
`void`	`stop()` Stop the component

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

- Constructor Detail
  - StandaloneConsumer
```
public StandaloneConsumer()
```
    Creates a new instance.
  - StandaloneConsumer
```
public StandaloneConsumer(AdaptrisMessageConsumer consumer)
```
  - StandaloneConsumer
```
public StandaloneConsumer(AdaptrisConnection c)
```
  - StandaloneConsumer
```
public StandaloneConsumer(AdaptrisConnection c,
                          AdaptrisMessageConsumer amc)
```
- Method Detail
  - init
```
public void init()
          throws CoreException
```
    Description copied from interface: ComponentLifecycle
    
    Initialises the component.
    Component initialisation includes config verification, creation of connections etc.
    
    Specified by:
    
    init in interface ComponentLifecycle
    
    Throws:
    
    CoreException - wrapping any underlying Exceptions
    
    See Also:
    
    ComponentLifecycle.init()
  - start
```
public void start()
           throws CoreException
```
    Description copied from interface: ComponentLifecycle
    
    Starts the component.
    Once a component is started it should be ready to process messages. In the case of AdaptrisMessageConsumer, calling start will begin message delivery.
    
    Specified by:
    
    start in interface ComponentLifecycle
    
    Throws:
    
    CoreException - wrapping any underlying Exceptions
    
    See Also:
    
    ComponentLifecycle.start()
  - stop
```
public void stop()
```
    Description copied from interface: ComponentLifecycle
    
    Stop the component
    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
    
    Specified by:
    
    stop in interface ComponentLifecycle
    
    See Also:
    
    ComponentLifecycle.stop()
  - close
```
public void close()
```
    Description copied from interface: ComponentLifecycle
    
    Closes the component.
    A closed component should release any connections it uses, etc. and clean up completely. Throwing a RuntimeException may cause unintended consequences
    
    Specified by:
    
    close in interface ComponentLifecycle
    
    See Also:
    
    ComponentLifecycle.close()
  - retrieveConnection
```
public <T> T retrieveConnection(java.lang.Class<T> type)
```
    Description copied from interface: AdaptrisMessageWorker
    
    Return this components underlying connection.
    
    Specified by:
    
    retrieveConnection in interface AdaptrisMessageWorker
    
    Parameters:
    
    type - the type of connection to cast to.
    
    Returns:
    
    the connection
  - createQualifier
```
public java.lang.String createQualifier()
```
    Description copied from interface: MessageEventGenerator
    
    Create a qualifier for any MleMarker that is generated.
    The default implementation is to return the unique-id of the component in question, or the empty string if not configured
    
    Specified by:
    
    createQualifier in interface MessageEventGenerator
    
    Returns:
    
    the qualifier for any MleMarker that is generated.
  - getUniqueId
```
public java.lang.String getUniqueId()
```
    Description copied from interface: AdaptrisComponent
    
    Get the unique-id that is associated with this component.
    
    Specified by:
    
    getUniqueId in interface AdaptrisComponent
    
    Returns:
    
    the unique-id
  - getConnection
```
public AdaptrisConnection getConnection()
```
    Get the connection to be used.
    As this class is designed to be marshalled to XML, the getter and setter for the connection is required to be present, and simply proxies the underlying AdaptrisMessageWorker implementation.
    
    Returns:
    
    the connection
  - setConnection
```
public void setConnection(AdaptrisConnection conn)
```
    Set the connection to be used.
    As this class is designed to be marshalled to XML, the getter and setter for the connection is required to be present, and simply proxies the underlying AdaptrisMessageWorker implementation.
    
    Parameters:
    
    conn - the connection
    
    See Also:
    
    AdaptrisMessageWorker.registerConnection(AdaptrisConnection)
  - registerConnection
```
public void registerConnection(AdaptrisConnection conn)
```
    Sets the AdaptrisConnection to use. May not be null.
    
    Specified by:
    
    registerConnection in interface AdaptrisMessageWorker
    
    Parameters:
    
    conn - the AdaptrisConnection to use
  - getConsumer
```
public AdaptrisMessageConsumer getConsumer()
```
    Returns the underlying AdaptrisMessageConsumer.
    
    Returns:
    
    the underlying AdaptrisMessageConsumer
  - setConsumer
```
public void setConsumer(AdaptrisMessageConsumer cons)
```
    Sets the underlying AdaptrisMessageConsumer. May not be null.
    
    Parameters:
    
    cons - the underlying AdaptrisMessageConsumer
  - registerAdaptrisMessageListener
```
public void registerAdaptrisMessageListener(AdaptrisMessageListener l)
```
    Description copied from interface: AdaptrisMessageConsumer
    
    Sets the AdaptrisMessageListener to use.
    
    Specified by:
    
    registerAdaptrisMessageListener in interface AdaptrisMessageConsumer
    
    Parameters:
    
    l - the AdaptrisMessageListener to use
    
    See Also:
    
    #registerAdaptrisMessageListener(com.adaptris.core.AdaptrisMessageListener)
  - getDestination
```
public ConsumeDestination getDestination()
```
    Description copied from interface: AdaptrisMessageConsumer
    
    Returns the ConsumeDestination to use.
    
    Specified by:
    
    getDestination in interface AdaptrisMessageConsumer
    
    Returns:
    
    this Object's ConsumeDestination
    
    See Also:
    
    AdaptrisMessageConsumer.getDestination()
  - setDestination
```
public void setDestination(ConsumeDestination destination)
```
    Description copied from interface: AdaptrisMessageConsumer
    
    Sets the ConsumeDestination to use.
    
    Specified by:
    
    setDestination in interface AdaptrisMessageConsumer
    
    Parameters:
    
    destination - the name of the destination
    
    See Also:
    
    #setDestination(com.adaptris.core.ConsumeDestination)
  - getEncoder
```
public AdaptrisMessageEncoder getEncoder()
```
    Description copied from interface: AdaptrisMessageWorker
    
    Returns the AdaptrisMessageEncoder to use.
    
    Specified by:
    
    getEncoder in interface AdaptrisMessageWorker
    
    Returns:
    
    the AdaptrisMessageEncoder to use
    
    See Also:
    
    AdaptrisMessageWorker.getEncoder()
  - setEncoder
```
public void setEncoder(AdaptrisMessageEncoder encoder)
```
    Description copied from interface: AdaptrisMessageWorker
    
    Sets the AdaptrisMessageEncoder to use.
    
    Specified by:
    
    setEncoder in interface AdaptrisMessageWorker
    
    Parameters:
    
    encoder - the AdaptrisMessageEncoder to use
    
    See Also:
    
    (com.adaptris.core.AdaptrisMessageEncoder)
  - handleConnectionException
```
public void handleConnectionException()
                               throws CoreException
```
    Description copied from interface: AdaptrisMessageWorker
    
    Called if a connection exception is encountered. Generally this will be when a polling consumer fails to obtain input, when a producer fails to produce or when some third party thread such as JMS exception listener is invoked.
    
    Specified by:
    
    handleConnectionException in interface AdaptrisMessageWorker
    
    Throws:
    
    CoreException - wrapping underlying Exceptions
    
    See Also:
    
    AdaptrisMessageWorker.handleConnectionException()
  - encode
```
public byte[] encode(AdaptrisMessage msg)
              throws CoreException
```
    Description copied from interface: AdaptrisMessageWorker
    
    Encode the passed message using the configured AdaptrisMessageEncoder. If no AME is configured implementations should return msg.getBytes().
    
    Specified by:
    
    encode in interface AdaptrisMessageWorker
    
    Parameters:
    
    msg - the AdaptrisMessage to encode
    
    Returns:
    
    the AdaptrisMessage encoded as a byte[]
    
    Throws:
    
    CoreException - wrapping any that occur
    
    See Also:
    
    (com.adaptris.core.AdaptrisMessage)
  - decode
```
public AdaptrisMessage decode(byte[] bytes)
                       throws CoreException
```
    Description copied from interface: AdaptrisMessageWorker
    
    Decodes the passed byte[] using the configured AdaptrisMessageEncoder. If no AME is configured, implementations should just set the byte[] as the payload of a new message.
    
    Specified by:
    
    decode in interface AdaptrisMessageWorker
    
    Parameters:
    
    bytes - the byte[] to decode
    
    Returns:
    
    an AdaptrisMessage
    
    Throws:
    
    CoreException - wrapping any that occur
    
    See Also:
    
    AdaptrisMessageWorker.decode(byte[])
  - prepare
```
public void prepare()
             throws CoreException
```
    Description copied from interface: ComponentLifecycleExtension
    
    Prepare for initialisation.
    
    Specified by:
    
    prepare in interface ComponentLifecycleExtension
    
    Throws:
    
    CoreException
  - createName
```
public java.lang.String createName()
```
    Description copied from interface: MessageEventGenerator
    
    Create a name for any MleMarker that is generated.
    The default implementation is to return the classname of the component in question.
    * @return the name for any MleMarker that is generated.
    
    Specified by:
    
    createName in interface MessageEventGenerator
    
    See Also:
    
    MessageEventGenerator.createName()
  - getIsTrackingEndpoint
```
public java.lang.Boolean getIsTrackingEndpoint()
```
  - setIsTrackingEndpoint
```
public void setIsTrackingEndpoint(java.lang.Boolean b)
```
  - isTrackingEndpoint
```
public boolean isTrackingEndpoint()
```
    Description copied from interface: MessageEventGenerator
    
    Returns true if this should be considered an 'end-point' for tracking purposes, otherwise false.
    
    Specified by:
    
    isTrackingEndpoint in interface MessageEventGenerator
    
    Returns:
    
    true if this should be considered an 'end-point' for tracking purposes, otherwise false
    
    See Also:
    
    MessageEventGenerator.isTrackingEndpoint()
  - getMessageFactory
```
public AdaptrisMessageFactory getMessageFactory()
```
    Specified by:
    
    getMessageFactory in interface AdaptrisMessageWorker
    
    Returns:
    
    the messageFactory
    
    See Also:
    
    AdaptrisMessageWorker.getMessageFactory()
  - setMessageFactory
```
public void setMessageFactory(AdaptrisMessageFactory f)
```
    Description copied from interface: AdaptrisMessageWorker
    
    Set the message factory used when creating AdaptrisMessage instances.
    
    Specified by:
    
    setMessageFactory in interface AdaptrisMessageWorker
    
    Parameters:
    
    f - the messageFactory to set
    
    See Also:
    
    AdaptrisMessageWorker.setMessageFactory(AdaptrisMessageFactory)
  - changeState
```
public void changeState(ComponentState newState)
```
    Description copied from interface: StateManagedComponent
    
    Updates the state for the component ComponentState.
    
    Specified by:
    
    changeState in interface StateManagedComponent
  - retrieveComponentState
```
public ComponentState retrieveComponentState()
```
    Description copied from interface: StateManagedComponent
    
    Returns the last recorde ComponentState.
    
    Specified by:
    
    retrieveComponentState in interface StateManagedComponent
    
    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 interface StateManagedComponent
    
    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 interface StateManagedComponent
    
    Throws:
    
    CoreException - wrapping any underlying Exceptions
  - requestStop
```
public void requestStop()
```
    Description copied from interface: StateManagedComponent
    
    Request this component is stopped.
    
    Specified by:
    
    requestStop in interface StateManagedComponent
  - requestClose
```
public void requestClose()
```
    Description copied from interface: StateManagedComponent
    
    Request this component is closed.
    
    Specified by:
    
    requestClose in interface StateManagedComponent

Class StandaloneConsumer

Field Summary

Fields inherited from interface com.adaptris.core.MessageEventGenerator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.adaptris.core.AdaptrisMessageConsumer

Constructor Detail

StandaloneConsumer

StandaloneConsumer

StandaloneConsumer

StandaloneConsumer

Method Detail

init

start

stop

close

retrieveConnection

createQualifier

getUniqueId

getConnection

setConnection

registerConnection

getConsumer

setConsumer

registerAdaptrisMessageListener

getDestination

setDestination

getEncoder

setEncoder

handleConnectionException

encode

decode

prepare

createName

getIsTrackingEndpoint

setIsTrackingEndpoint

isTrackingEndpoint

getMessageFactory

setMessageFactory

changeState

retrieveComponentState

requestInit

requestStart

requestStop

requestClose