Package com.adaptris.core.services.splitter

Class MimePartSplitter

java.lang.Object
com.adaptris.core.services.splitter.MessageSplitterImp
com.adaptris.core.services.splitter.MimePartSplitter
All Implemented Interfaces:
MessageSplitter
public class MimePartSplitter extends MessageSplitterImp

Implementation of MessageSplitter which allows a single AdaptrisMessage that contains multiple mime parts to be split into AdaptrisMessage[].

The Message must be a mime encoded message.

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

  • Constructor Details

    • MimePartSplitter

      public MimePartSplitter()

  • Method Details

    • splitMessage

      public List<AdaptrisMessage> splitMessage(AdaptrisMessage msg) throws CoreException
      Description copied from interface: MessageSplitter

      Splits an AdaptrisMessage into some number of AdaptrisMessage objects. Preservation of metadata is down to the implementation.

      If this method returns a CloseableIterable, it must be closed by the caller! This contract cannot be clearly expressed in Java code without breaking the API in uncomfortable ways for things just returning a List, which is why this method is only declared to return Iterable.

      Parameters:
      msg - the msg to split
      Returns:
      an Iterable of AdaptrisMessage
      Throws:
      CoreException - wrapping any other exception
      See Also:

    • getPreserveHeaders

      public Boolean getPreserveHeaders()
      Get the preserve headers flag.
      Returns:
      the flag.

    • setPreserveHeaders

      public void setPreserveHeaders(Boolean b)
      Set the preserve headers flag.

      If set to true, then an attempt is made to copy all the headers from the mime part as metadata to the AdaptrisMessage object. Each header can optionally be prefixed with the value specfied by the value of getHeaderPrefix()

      Parameters:
      b - true or false.
      See Also:

    • preserveHeaders

      public boolean preserveHeaders()

    • setHeaderPrefix

      public void setHeaderPrefix(String s)
      Set the header prefix.

      The header prefix is used to prefix any headers that are preserved from the Mime Part

      Parameters:
      s - the prefix.

    • getHeaderPrefix

      public String getHeaderPrefix()
      Get the header prefix.
      Returns:
      the header prefix