AdaptrisMessageConsumer (Interlok Core/Base)

All Superinterfaces:

AdaptrisComponent, AdaptrisMessageWorker, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator

All Known Implementing Classes:

AdaptrisMessageConsumerImp, AdaptrisPollingConsumer, BaseJmsPollingConsumerImpl, BasicJettyConsumer, FsConsumer, FsConsumerImpl, FtpConsumer, FtpConsumerImpl, FtpRecursiveConsumer, JettyMessageConsumer, JmsConsumer, JmsConsumerImpl, JmsPollingConsumer, JmsPollingConsumerImpl, JmsSyncConsumer, JmxNotificationConsumer, LargeFsConsumer, MovingNonDeletingFsConsumer, NonDeletingFsConsumer, NullMessageConsumer, PasConsumer, PasPollingConsumer, PollingTrigger, PtpConsumer, PtpPollingConsumer, RelaxedFtpConsumer, StandaloneConsumer, TraversingFsConsumer
```
public interface AdaptrisMessageConsumer
extends AdaptrisMessageWorker
```
Implementations of AdaptrisMessageConsumer obtain data, convert it into an AdaptrisMessage and pass the message to the registered AdaptrisMessageListener.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default java.lang.String`	`consumeLocationKey()`	Return the specific metadata key that contains the consume location.
`void`	`registerAdaptrisMessageListener(AdaptrisMessageListener listener)`	Sets the `AdaptrisMessageListener` to use.

Methods inherited from interface com.adaptris.core.AdaptrisComponent
getUniqueId

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
```
void registerAdaptrisMessageListener(AdaptrisMessageListener listener)
```
    Sets the AdaptrisMessageListener to use.
    
    Parameters:
    
    listener - the AdaptrisMessageListener to use
  - consumeLocationKey
```
default java.lang.String consumeLocationKey()
```
    Return the specific metadata key that contains the consume location.
    if specified; then the workflow will attempt to set "_interlokMessageConsumedFrom" as a standard metadata key. If not explicitly overriden, then this metadata key is not available.
    
    Returns:
    
    the metadata key;
    
    Since:
    
    3.9.0
    
    Implementation Note:
    
    The default implementation returns null, indicating there is no way to standardise the consume location.