public class Attachments extends Object implements OMAttachmentAccessor
Constructor and Description |
---|
Attachments()
Use this constructor when instantiating this to store the attachments set programatically
through the SwA API.
|
Attachments(InputStream inStream,
String contentTypeString)
Sets file cache to false.
|
Attachments(InputStream inStream,
String contentTypeString,
boolean fileCacheEnable,
String attachmentRepoDir,
String fileThreshold)
Moves the pointer to the beginning of the first MIME part.
|
Attachments(InputStream inStream,
String contentTypeString,
boolean fileCacheEnable,
String attachmentRepoDir,
String fileThreshold,
int contentLength)
Moves the pointer to the beginning of the first MIME part.
|
Attachments(LifecycleManager manager,
InputStream inStream,
String contentTypeString,
boolean fileCacheEnable,
String attachmentRepoDir,
String fileThreshold)
Moves the pointer to the beginning of the first MIME part.
|
Attachments(LifecycleManager manager,
InputStream inStream,
String contentTypeString,
boolean fileCacheEnable,
String attachmentRepoDir,
String fileThreshold,
int contentLength)
Moves the pointer to the beginning of the first MIME part.
|
Modifier and Type | Method and Description |
---|---|
void |
addDataHandler(String contentID,
DataHandler dataHandler)
Programatically adding an SOAP with Attachments(SwA) Attachment.
|
String[] |
getAllContentIDs()
Get the content IDs of all MIME parts in the message.
|
String |
getAttachmentSpecType()
Identify the type of message (MTOM or SOAP with attachments) represented by this object.
|
List |
getContentIDList()
Get the content IDs of the already loaded MIME parts in the message.
|
Set |
getContentIDSet()
Get the content IDs of all MIME parts in the message.
|
long |
getContentLength()
If the Attachments is backed by an InputStream, then this
method returns the length of the message contents
(Length of the entire message - Length of the Transport Headers)
|
DataHandler |
getDataHandler(String contentID)
Get the
DataHandler object for the MIME part with a given content ID. |
InputStream |
getIncomingAttachmentsAsSingleStream()
Deprecated.
As of Axiom 1.2.13, this method is no longer supported.
|
IncomingAttachmentStreams |
getIncomingAttachmentStreams()
Stream based access
|
LifecycleManager |
getLifecycleManager() |
Map |
getMap()
Get a map of all MIME parts in the message.
|
String |
getRootPartContentID()
Get the content ID of the root part of the MIME message.
|
String |
getRootPartContentType()
Get the content type of the root part of the MIME message.
|
InputStream |
getRootPartInputStream()
Get an input stream for the root part of the MIME message.
|
InputStream |
getRootPartInputStream(boolean preserve)
Get an input stream for the root part of the MIME message.
|
String |
getSOAPPartContentID()
Deprecated.
Use
getRootPartContentID() instead. |
String |
getSOAPPartContentType()
Deprecated.
Use
getRootPartContentType() instead. |
InputStream |
getSOAPPartInputStream()
Deprecated.
Use
getRootPartInputStream() instead. |
void |
removeDataHandler(String blobContentID)
Removes the DataHandler corresponding to the given contenID.
|
void |
setLifecycleManager(LifecycleManager manager) |
public Attachments(LifecycleManager manager, InputStream inStream, String contentTypeString, boolean fileCacheEnable, String attachmentRepoDir, String fileThreshold) throws OMException
inStream
- contentTypeString
- fileCacheEnable
- attachmentRepoDir
- OMException
public Attachments(LifecycleManager manager, InputStream inStream, String contentTypeString, boolean fileCacheEnable, String attachmentRepoDir, String fileThreshold, int contentLength) throws OMException
inStream
- contentTypeString
- fileCacheEnable
- attachmentRepoDir
- fileThreshold
- contentLength
- OMException
public Attachments(InputStream inStream, String contentTypeString, boolean fileCacheEnable, String attachmentRepoDir, String fileThreshold) throws OMException
inStream
- contentTypeString
- fileCacheEnable
- attachmentRepoDir
- OMException
public Attachments(InputStream inStream, String contentTypeString, boolean fileCacheEnable, String attachmentRepoDir, String fileThreshold, int contentLength) throws OMException
inStream
- contentTypeString
- fileCacheEnable
- attachmentRepoDir
- fileThreshold
- contentLength
- OMException
public Attachments(InputStream inStream, String contentTypeString) throws OMException
inStream
- contentTypeString
- OMException
public Attachments()
public LifecycleManager getLifecycleManager()
public void setLifecycleManager(LifecycleManager manager)
public String getAttachmentSpecType()
MTOMConstants.MTOM_TYPE
, MTOMConstants.SWA_TYPE
or
MTOMConstants.SWA_TYPE_12
constants.OMException
- if the message doesn't have one of the supported types (i.e. is neither MTOM nor
SOAP with attachments) or if the instance was not created from a streampublic DataHandler getDataHandler(String contentID)
DataHandler
object for the MIME part with a given content ID. The returned
instance MAY implement DataHandlerExt
in which case the caller can use that API to
stream the content of the part. In addition, the DataSource
linked to the returned
DataHandler
MAY be of type SizeAwareDataSource
in which case the caller can
use that interface to determine the size of the MIME part.getDataHandler
in interface OMAttachmentAccessor
contentID
- the raw content ID (without the surrounding angle brackets and cid:
prefix) of the MIME partDataHandler
of the MIME part referred by the content ID or
null
if the MIME part referred by the content ID does not existpublic void addDataHandler(String contentID, DataHandler dataHandler)
contentID
- dataHandler
- public void removeDataHandler(String blobContentID)
blobContentID
- public InputStream getSOAPPartInputStream() throws OMException
getRootPartInputStream()
instead.OMException
public String getSOAPPartContentID()
getRootPartContentID()
instead.public String getSOAPPartContentType()
getRootPartContentType()
instead.public InputStream getRootPartInputStream() throws OMException
getRootPartContentID()
method. Note that a new
stream is returned each time this method is called, i.e. the method does not consume the root
part. Instead it loads the root part into memory so that it can be read several times.OMException
public InputStream getRootPartInputStream(boolean preserve) throws OMException
getRootPartInputStream()
, but can be instructed to consume the root part. This
allows streaming of the root part. If that feature is used, the root part will not be loaded
into memory unless an attempt is made to access another part of the MIME message, in which
case the remaining (i.e. unconsumed) content of the root part will be buffered. If the
feature is not enabled, then this method behaves in the same way as
getRootPartInputStream()
.preserve
- true
if the content of the root part should be fetched into memory so
that it can be read several times, false
if the root part should be
consumedOMException
public String getRootPartContentID()
public String getRootPartContentType()
getRootPartContentID()
method.OMException
- if the content type could not be determinedpublic IncomingAttachmentStreams getIncomingAttachmentStreams() throws IllegalStateException
IncomingAttachmentStreams
IllegalStateException
- if application has alreadt started using Part's directlypublic String[] getAllContentIDs()
public Set getContentIDSet()
public Map getMap()
DataHandler
objects as values.public List getContentIDList()
getAllContentIDs()
or getContentIDSet()
should be used
instead.public long getContentLength() throws IOException
IOException
public InputStream getIncomingAttachmentsAsSingleStream() throws IllegalStateException
IllegalStateException
Copyright © 2004–2018 The Apache Software Foundation. All rights reserved.