Package com.adaptris.core.services.mime
Class MimePartSelector
- java.lang.Object
-
- com.adaptris.core.ServiceImp
-
- com.adaptris.core.services.mime.MimePartSelector
-
- All Implemented Interfaces:
AdaptrisComponent
,ComponentLifecycle
,ComponentLifecycleExtension
,MessageEventGenerator
,Service
,StateManagedComponent
@ComponentProfile(summary="Select a mime-part from the message and discards the others", tag="service") public class MimePartSelector extends ServiceImp
Choose a specific mime part from an existing multipart message to become the payload of the AdaptrisMessage.In the adapter configuration file this class is aliased as mime-part-selector-service 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 Description MimePartSelector()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
closeService()
void
doService(AdaptrisMessage msg)
Apply the service to the message.java.lang.String
getHeaderPrefix()
java.lang.Boolean
getMarkAsNonMime()
java.lang.String
getPartHeaderPrefix()
java.lang.Boolean
getPreserveHeadersAsMetadata()
java.lang.Boolean
getPreservePartHeadersAsMetadata()
PartSelector
getSelector()
protected void
initService()
void
prepare()
Prepare for initialisation.void
setHeaderPrefix(java.lang.String s)
Specify the header prefix to be used when preserving parsed mime headers.void
setMarkAsNonMime(java.lang.Boolean b)
After processing, mark the AdaptrisMessage as non longer being MimeEncoded.void
setPartHeaderPrefix(java.lang.String s)
Specify the header prefix to be used when preserving the parts headers.void
setPreserveHeadersAsMetadata(java.lang.Boolean b)
Specify whether to preserve parsed mime headers as metadata.void
setPreservePartHeadersAsMetadata(java.lang.Boolean b)
Specify whether to preserve the parts headers as metadata.void
setSelector(PartSelector mps)
Set the mime part selector.-
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
-
-
-
-
Method Detail
-
doService
public void doService(AdaptrisMessage msg) throws ServiceException
Description copied from interface:Service
Apply the service to the message.
- Parameters:
msg
- theAdaptrisMessage
to process- Throws:
ServiceException
- wrapping any underlyingException
s- See Also:
Service.doService(com.adaptris.core.AdaptrisMessage)
-
initService
protected void initService() throws CoreException
- Specified by:
initService
in classServiceImp
- Throws:
CoreException
-
closeService
protected void closeService()
- Specified by:
closeService
in classServiceImp
-
getPreserveHeadersAsMetadata
public java.lang.Boolean getPreserveHeadersAsMetadata()
- Returns:
- the preserveHeadersAsMetadata
-
setPreserveHeadersAsMetadata
public void setPreserveHeadersAsMetadata(java.lang.Boolean b)
Specify whether to preserve parsed mime headers as metadata.- Parameters:
b
- the preserveHeadersAsMetadata to set, default is false
-
getHeaderPrefix
public java.lang.String getHeaderPrefix()
- Returns:
- the headerPrefix
-
setHeaderPrefix
public void setHeaderPrefix(java.lang.String s)
Specify the header prefix to be used when preserving parsed mime headers.- Parameters:
s
- the headerPrefix to set, default is ""
-
getPartHeaderPrefix
public java.lang.String getPartHeaderPrefix()
- Returns:
- the partHeaderPrefix
-
setPartHeaderPrefix
public void setPartHeaderPrefix(java.lang.String s)
Specify the header prefix to be used when preserving the parts headers.- Parameters:
s
- the partHeaderPrefix to set, default is ""
-
getPreservePartHeadersAsMetadata
public java.lang.Boolean getPreservePartHeadersAsMetadata()
- Returns:
- the preservePartHeadersAsMetadata
-
setPreservePartHeadersAsMetadata
public void setPreservePartHeadersAsMetadata(java.lang.Boolean b)
Specify whether to preserve the parts headers as metadata.- Parameters:
b
- the preservePartHeadersAsMetadata to set, default false.
-
getSelector
public PartSelector getSelector()
- Returns:
- the selector
-
setSelector
public void setSelector(PartSelector mps)
Set the mime part selector.- Parameters:
mps
- the selector to set
-
getMarkAsNonMime
public java.lang.Boolean getMarkAsNonMime()
- Returns:
- the markAsNonMime
-
setMarkAsNonMime
public void setMarkAsNonMime(java.lang.Boolean b)
After processing, mark the AdaptrisMessage as non longer being MimeEncoded.- Parameters:
b
- the markAsNonMime to set- See Also:
CoreConstants.MSG_MIME_ENCODED
-
prepare
public void prepare() throws CoreException
Description copied from interface:ComponentLifecycleExtension
Prepare for initialisation.- Throws:
CoreException
-
-