com.adaptris.core.services.mime

Class MultipartMessageBuilder

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.services.mime.MultipartMessageBuilder

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, Service, StateManagedComponent

@ComponentProfile(summary="Creates a MIME payload from various sources",
                  since="3.9.0",
                  tag="mime")
public class MultipartMessageBuilder
extends ServiceImp

Constructs a multipart MIME payload from various sources.

Since:

3.9.0

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

Field Summary

Fields inherited from class com.adaptris.core.ServiceImp

log

Constructor Summary

Constructors

Constructor and Description
MultipartMessageBuilder()

Method Summary

Modifier and Type	Method and Description
protected void	closeService()
protected MultiPartOutput	createOutputPart(AdaptrisMessage msg)
void	doService(AdaptrisMessage msg) Apply the service to the message.
java.lang.String	getContentId()
java.lang.String	getMimeContentSubType()
MetadataFilter	getMimeHeaderFilter()
java.util.List<MimePartBuilder>	getMimeParts()
protected void	initService()
void	prepare() Prepare for initialisation.
void	setContentId(java.lang.String s) Set the Content-ID for the Multipart,
void	setMimeContentSubType(java.lang.String sub) Set the sub type for the Multipart
void	setMimeHeaderFilter(MetadataFilter filter) Set any additional headers that need to be set for this Mime Message
void	setMimeParts(java.util.List<MimePartBuilder> parts) Specify what is going to build the mime message.
MultipartMessageBuilder	withContentId(java.lang.String s)
MultipartMessageBuilder	withMimeContentSubType(java.lang.String s)
MultipartMessageBuilder	withMimeHeaderFilter(MetadataFilter filter)
MultipartMessageBuilder	withMimeParts(java.util.List<MimePartBuilder> list)
MultipartMessageBuilder	withMimeParts(MimePartBuilder... builders)

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsTrackingEndpoint, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setContinueOnFail, setIsTrackingEndpoint, setUniqueId, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultipartMessageBuilder

public MultipartMessageBuilder()

Method Detail

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Description copied from interface: Service

Apply the service to the message.

Parameters:

msg - the AdaptrisMessage to process

Throws:

ServiceException - wrapping any underlying Exceptions

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Throws:

CoreException

initService

protected void initService()
                    throws CoreException

Specified by:

initService in class ServiceImp

Throws:

CoreException

closeService

protected void closeService()

Specified by:

closeService in class ServiceImp

createOutputPart

protected MultiPartOutput createOutputPart(AdaptrisMessage msg)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getMimeParts

public java.util.List<MimePartBuilder> getMimeParts()

setMimeParts

public void setMimeParts(java.util.List<MimePartBuilder> parts)

Specify what is going to build the mime message.

Parameters:

parts - the parts that will form the mime message.

getMimeHeaderFilter

public MetadataFilter getMimeHeaderFilter()

setMimeHeaderFilter

public void setMimeHeaderFilter(MetadataFilter filter)

Set any additional headers that need to be set for this Mime Message

Parameters:

filter - the metadata filter.

getContentId

public java.lang.String getContentId()

setContentId

public void setContentId(java.lang.String s)

Set the Content-ID for the Multipart,

Parameters:

s - the Content-ID, which supports the %message{} syntax to resolve metadata; defaults to the messages unique id if no value is specified.

getMimeContentSubType

public java.lang.String getMimeContentSubType()

setMimeContentSubType

public void setMimeContentSubType(java.lang.String sub)

Set the sub type for the Multipart

Parameters:

sub - the content subtype, which supports the %message{} syntax to resolve metadata; defaults to 'mixed' if not specified.

withMimeHeaderFilter

public MultipartMessageBuilder withMimeHeaderFilter(MetadataFilter filter)

withMimeParts

public MultipartMessageBuilder withMimeParts(java.util.List<MimePartBuilder> list)

withMimeParts

public MultipartMessageBuilder withMimeParts(MimePartBuilder... builders)

withContentId

public MultipartMessageBuilder withContentId(java.lang.String s)

withMimeContentSubType

public MultipartMessageBuilder withMimeContentSubType(java.lang.String s)