Package com.adaptris.core.lms

Class LargeFsConsumer

  • All Implemented Interfaces:
    AdaptrisComponent, AdaptrisMessageConsumer, AdaptrisMessageWorker, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, StateManagedComponent
    @ComponentProfile(summary="Pickup messages from the filesystem with large message support",
                  tag="consumer,fs,filesystem",
                  metadata={"originalname","fsFileSize","lastmodified","fsConsumeDir","_interlokMessageConsumedFrom","fsParentDir"},
                  recommended=NullConnection.class)
public class LargeFsConsumer
extends FsConsumer

    File system implementation of AdaptrisMessageConsumer with large message support.

    • If a file based url is used. e.g. file:///c:/path/to/my/directory or file:////path/to/my/directory then the patch is considered to be fully qualified
    • If just a path is returned, then it is considered to be relative to the current working directory. e.g. if /opt/fred is used, and the adapter is installed to /opt/adapter, then the fully qualified name is /opt/adapter/opt/fred.

    On windows based platforms, you should always use a file based url.

    Additionally the behaviour of this consumer is subtly different from the standard FsConsumer :

    • Encoding is supported if you use a FileBackedMimeEncoder.
    • The default AdaptrisMessageFactory implementation is FileBackedMessageFactory
    • If, at runtime, the MessageFactory implementation is not FileBackedMessageFactory, then behaviour changes to be identical to to the existing FsConsumer and uses the configured FsWorker

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