@ComponentProfile(summary="Creates a MIME payload from various sources", since="3.9.0", tag="mime") public class MultipartMessageBuilder extends ServiceImp
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.
log
CONFIRMATION_ID_KEY
Constructor and Description |
---|
MultipartMessageBuilder() |
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) |
changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsTrackingEndpoint, getLookupName, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setContinueOnFail, setIsTrackingEndpoint, setLookupName, setUniqueId, start, stop
public void doService(AdaptrisMessage msg) throws ServiceException
Service
Apply the service to the message.
msg
- the AdaptrisMessage
to processServiceException
- wrapping any underlying Exception
spublic void prepare() throws CoreException
ComponentLifecycleExtension
CoreException
protected void initService() throws CoreException
initService
in class ServiceImp
CoreException
protected void closeService()
closeService
in class ServiceImp
protected MultiPartOutput createOutputPart(AdaptrisMessage msg) throws java.lang.Exception
java.lang.Exception
public java.util.List<MimePartBuilder> getMimeParts()
public void setMimeParts(java.util.List<MimePartBuilder> parts)
parts
- the parts that will form the mime message.public MetadataFilter getMimeHeaderFilter()
public void setMimeHeaderFilter(MetadataFilter filter)
filter
- the metadata filter.public java.lang.String getContentId()
public void setContentId(java.lang.String s)
s
- the Content-ID, which supports the %message{}
syntax to resolve metadata;
defaults to the messages unique id if no value is specified.public java.lang.String getMimeContentSubType()
public void setMimeContentSubType(java.lang.String sub)
sub
- the content subtype, which supports the %message{}
syntax to resolve
metadata; defaults to 'mixed' if not specified.public MultipartMessageBuilder withMimeHeaderFilter(MetadataFilter filter)
public MultipartMessageBuilder withMimeParts(java.util.List<MimePartBuilder> list)
public MultipartMessageBuilder withMimeParts(MimePartBuilder... builders)
public MultipartMessageBuilder withContentId(java.lang.String s)
public MultipartMessageBuilder withMimeContentSubType(java.lang.String s)