Interface AdaptrisMessageWorker

All Superinterfaces:
AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator
All Known Subinterfaces:
AdaptrisMessageConsumer, AdaptrisMessageProducer
All Known Implementing Classes:
AdaptrisMessageConsumerImp, AdaptrisMessageProducerImp, AdaptrisMessageWorkerImp, AdaptrisPollingConsumer, BaseJmsPollingConsumerImpl, BasicJettyConsumer, ChannelUnavailableConnectionErrorHandlingProducer, ConnectionErrorHandlingProducer, DefinedJmsProducer, FsConsumer, FsConsumerImpl, FsProducer, FtpConsumer, FtpConsumerImpl, FtpProducer, FtpRecursiveConsumer, HttpProducer, JdbcStoredProcedureProducer, JettyMessageConsumer, JmsAsyncProducer, JmsConsumer, JmsConsumerImpl, JmsPollingConsumer, JmsPollingConsumerImpl, JmsProducer, JmsProducerImpl, JmsSyncConsumer, JmxNotificationConsumer, LargeFsConsumer, LargeFsProducer, MovingNonDeletingFsConsumer, NonDeletingFsConsumer, NullMessageConsumer, NullMessageProducer, PasConsumer, PasPollingConsumer, PasProducer, PollingTrigger, ProduceOnlyProducerImp, PtpConsumer, PtpPollingConsumer, PtpProducer, RelaxedFtpConsumer, RelaxedFtpProducer, RequestReplyProducerBase, RequestReplyProducerImp, ResponseProducerImpl, StandaloneConsumer, StandardHttpProducer, StandardResponseProducer, TraversingFsConsumer

public interface AdaptrisMessageWorker extends AdaptrisComponent, MessageEventGenerator

Defines behaviour common to AdaptrisMessageConsumer and AdaptrisMessageProducer.

  • Method Details

    • registerConnection

      void registerConnection(AdaptrisConnection connection)

      Sets the AdaptrisConnection this component will use.

      Parameters:
      connection - the AdaptrisConnection to use
    • retrieveConnection

      <T> T retrieveConnection(Class<T> type)
      Return this components underlying connection.
      Parameters:
      type - the type of connection to cast to.
      Returns:
      the connection
    • getEncoder

      Returns the AdaptrisMessageEncoder to use.

      Returns:
      the AdaptrisMessageEncoder to use
    • setEncoder

      void setEncoder(AdaptrisMessageEncoder encoder)

      Sets the AdaptrisMessageEncoder to use.

      Parameters:
      encoder - the AdaptrisMessageEncoder to use
    • handleConnectionException

      void handleConnectionException() throws CoreException

      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.

      Throws:
      CoreException - wrapping underlying Exceptions
    • encode

      byte[] encode(AdaptrisMessage msg) throws CoreException

      Encode the passed message using the configured AdaptrisMessageEncoder. If no AME is configured implementations should return msg.getBytes().

      Parameters:
      msg - the AdaptrisMessage to encode
      Returns:
      the AdaptrisMessage encoded as a byte[]
      Throws:
      CoreException - wrapping any that occur
    • decode

      AdaptrisMessage decode(byte[] bytes) throws CoreException

      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.

      Parameters:
      bytes - the byte[] to decode
      Returns:
      an AdaptrisMessage
      Throws:
      CoreException - wrapping any that occur
    • getMessageFactory

      AdaptrisMessageFactory getMessageFactory()
      Returns:
      the messageFactory
    • setMessageFactory

      void setMessageFactory(AdaptrisMessageFactory f)
      Set the message factory used when creating AdaptrisMessage instances.
      Parameters:
      f - the messageFactory to set