public class AttachmentPartImpl extends AttachmentPart
AttachmentPart
interface.AttachmentPart
Constructor and Description |
---|
AttachmentPartImpl() |
AttachmentPartImpl(DataHandler handler) |
Modifier and Type | Method and Description |
---|---|
void |
addMimeHeader(String name,
String value)
Adds a MIME header with the specified name and value to this
AttachmentPart object. |
void |
clearContent()
Clears out the content of this
AttachmentPart object. |
Iterator |
getAllMimeHeaders()
Retrieves all the headers for this
AttachmentPart object
as an iterator over the MimeHeader objects. |
InputStream |
getBase64Content()
Returns an InputStream which can be used to obtain the content of AttachmentPart as Base64 encoded character data,
this method would base64 encode the raw bytes of the attachment and return.
|
Object |
getContent()
Gets the content of this
AttachmentPart object as a Java
object. |
String |
getContentId()
Gets the value of the MIME header whose name is "Content-ID".
|
String |
getContentLocation()
Gets the value of the MIME header whose name is "Content-Location".
|
String |
getContentType()
Gets the value of the MIME header whose name is "Content-Type".
|
DataHandler |
getDataHandler()
Gets the
DataHandler object for this AttachmentPart
object. |
String |
getFirstMimeHeader(String header)
Returns the first occurence of a MIME header.
|
Iterator |
getMatchingMimeHeaders(String[] names)
Retrieves all
MimeHeader objects that match a name in
the given array. |
String[] |
getMimeHeader(String name)
Gets all the values of the header identified by the given
String . |
Iterator |
getNonMatchingMimeHeaders(String[] names)
Retrieves all
MimeHeader objects whose name does
not match a name in the given array. |
InputStream |
getRawContent()
Gets the content of this AttachmentPart object as an InputStream
as if a call had been made to getContent and no DataContentHandler
had been registered for the content-type of this AttachmentPart.
|
byte[] |
getRawContentBytes()
Gets the content of this AttachmentPart object as a byte[] array as if a call had been
made to getContent and no DataContentHandler had been registered for the content-type of this AttachmentPart.
|
int |
getSize()
Returns the number of bytes in this
AttachmentPart
object. |
void |
removeAllMimeHeaders()
Removes all the MIME header entries.
|
void |
removeMimeHeader(String name)
Removes all MIME headers that match the given name.
|
void |
setBase64Content(InputStream content,
String contentType)
Sets the content of this attachment part from the Base64 source InputStream
and sets the value of the Content-Type header to the value contained in contentType,
This method would first decode the base64 input and write the resulting raw bytes to the attachment.
|
void |
setContent(Object object,
String contentType)
Sets the content of this attachment part to that of the given Object and sets the value of the Content-Type header
to the given type.
|
void |
setContentId(String contentId)
Sets the MIME header whose name is "Content-ID" with the given value.
|
void |
setContentLocation(String contentLocation)
Sets the MIME header whose name is "Content-Location" with the given value.
|
void |
setContentType(String contentType)
Sets the MIME header whose name is "Content-Type" with the given value.
|
void |
setDataHandler(DataHandler dataHandler)
Sets the given
DataHandler object as the data handler
for this AttachmentPart object. |
void |
setMimeHeader(String name,
String value)
Changes the first header entry that matches the given name
to the given value, adding a new header if no existing header
matches.
|
void |
setRawContent(InputStream content,
String contentType)
Sets the content of this attachment part to that contained by the InputStream content and sets the value of the Content-Type header to the value contained in contentType.
|
void |
setRawContentBytes(byte[] content,
int offset,
int len,
String contentType)
Sets the content of this attachment part to that contained
by the byte[] array content and sets the value of the Content-Type
header to the value contained in contentType.
|
public AttachmentPartImpl()
public AttachmentPartImpl(DataHandler handler)
public void addMimeHeader(String name, String value)
AttachmentPart
AttachmentPart
object.
Note that RFC822 headers can contain only US-ASCII characters.
addMimeHeader
in class AttachmentPart
name
- a String
giving the name of the header
to be addedvalue
- a String
giving the value of the header
to be addedpublic void clearContent()
AttachmentPart
AttachmentPart
object.
The MIME header portion is left untouched.clearContent
in class AttachmentPart
public Iterator getAllMimeHeaders()
AttachmentPart
AttachmentPart
object
as an iterator over the MimeHeader
objects.getAllMimeHeaders
in class AttachmentPart
Iterator
object with all of the Mime
headers for this AttachmentPart
objectpublic Object getContent() throws SOAPException
AttachmentPart
AttachmentPart
object as a Java
object. The type of the returned Java object depends on (1) the
DataContentHandler
object that is used to interpret the bytes
and (2) the Content-Type
given in the header.
For the MIME content types "text/plain", "text/html" and "text/xml", the
DataContentHandler
object does the conversions to and
from the Java types corresponding to the MIME types.
For other MIME types,the DataContentHandler
object
can return an InputStream
object that contains the content data
as raw bytes.
A SAAJ-compliant implementation must, as a minimum, return a
java.lang.String
object corresponding to any content
stream with a Content-Type
value of
text/plain
, a
javax.xml.transform.stream.StreamSource
object corresponding to a
content stream with a Content-Type
value of
text/xml
, a java.awt.Image
object
corresponding to a content stream with a
Content-Type
value of image/gif
or
image/jpeg
. For those content types that an
installed DataContentHandler
object does not understand, the
DataContentHandler
object is required to return a
java.io.InputStream
object with the raw bytes.
getContent
in class AttachmentPart
AttachmentPart
objectSOAPException
- if there is no content set into this
AttachmentPart
object or if there was a data
transformation errorpublic DataHandler getDataHandler() throws SOAPException
AttachmentPart
DataHandler
object for this AttachmentPart
object.getDataHandler
in class AttachmentPart
DataHandler
object associated with this
AttachmentPart
objectSOAPException
- if there is no data in
this AttachmentPart
objectpublic Iterator getMatchingMimeHeaders(String[] names)
AttachmentPart
MimeHeader
objects that match a name in
the given array.getMatchingMimeHeaders
in class AttachmentPart
names
- a String
array with the name(s) of the
MIME headers to be returnedIterator
objectpublic String[] getMimeHeader(String name)
AttachmentPart
String
.getMimeHeader
in class AttachmentPart
name
- the name of the header; example: "Content-Type"String
array giving the value for the
specified headerAttachmentPart.setMimeHeader(java.lang.String, java.lang.String)
public String getFirstMimeHeader(String header)
header
- the mime headerpublic Iterator getNonMatchingMimeHeaders(String[] names)
AttachmentPart
MimeHeader
objects whose name does
not match a name in the given array.getNonMatchingMimeHeaders
in class AttachmentPart
names
- a String
array with the name(s) of the
MIME headers not to be returnedAttachmentPart
object
except those that match one of the names in the
given array. The nonmatching MIME headers are returned as an
Iterator
object.public int getSize() throws SOAPException
AttachmentPart
AttachmentPart
object.getSize
in class AttachmentPart
AttachmentPart
object in bytes
or -1 if the size cannot be determinedSOAPException
- if the content of this attachment is
corrupted of if there was an exception while trying
to determine the size.public void removeAllMimeHeaders()
AttachmentPart
removeAllMimeHeaders
in class AttachmentPart
public void removeMimeHeader(String name)
AttachmentPart
removeMimeHeader
in class AttachmentPart
name
- the string name of the MIME header/s to
be removedpublic void setContent(Object object, String contentType)
setContent
in class AttachmentPart
object
- the Java object that makes up the content for this attachment partcontentType
- the MIME string that specifies the type of the contentIllegalArgumentException
- if the contentType does not match the type of the content object,
or if there was no DataContentHandler object for this content objectAttachmentPart.getContent()
public void setDataHandler(DataHandler dataHandler)
AttachmentPart
DataHandler
object as the data handler
for this AttachmentPart
object. Typically, on an incoming
message, the data handler is automatically set. When
a message is being created and populated with content, the
setDataHandler
method can be used to get data from
various data sources into the message.setDataHandler
in class AttachmentPart
dataHandler
- the DataHandler
object to be setpublic void setMimeHeader(String name, String value)
AttachmentPart
Note that RFC822 headers can only contain US-ASCII characters.
setMimeHeader
in class AttachmentPart
name
- a String
giving the name of the header
for which to searchvalue
- a String
giving the value to be set for
the header whose name matches the given namepublic String getContentId()
AttachmentPart
getContentId
in class AttachmentPart
String
giving the value of the
"Content-ID" header or null
if there
is noneAttachmentPart.setContentId(java.lang.String)
public String getContentLocation()
AttachmentPart
getContentLocation
in class AttachmentPart
String
giving the value of the
"Content-Location" header or null
if there
is nonepublic String getContentType()
AttachmentPart
getContentType
in class AttachmentPart
String
giving the value of the
"Content-Type" header or null
if there
is nonepublic void setContentId(String contentId)
AttachmentPart
setContentId
in class AttachmentPart
contentId
- a String
giving the value of the
"Content-ID" headerAttachmentPart.getContentId()
public void setContentLocation(String contentLocation)
AttachmentPart
setContentLocation
in class AttachmentPart
contentLocation
- a String
giving the value of the
"Content-Location" headerpublic void setContentType(String contentType)
AttachmentPart
setContentType
in class AttachmentPart
contentType
- a String
giving the value of the
"Content-Type" headerpublic InputStream getBase64Content() throws SOAPException
getBase64Content
in class AttachmentPart
SOAPException
- if there is no content set into this AttachmentPart object or if there was a data transformation error.public InputStream getRawContent() throws SOAPException
getRawContent
in class AttachmentPart
SOAPException
- if there is no content set into this AttachmentPart object or if there was a data transformation error.AttachmentPart.getRawContentBytes()
public byte[] getRawContentBytes() throws SOAPException
getRawContentBytes
in class AttachmentPart
SOAPException
- if there is no content set into this AttachmentPart object or if there was a data transformation error.public void setBase64Content(InputStream content, String contentType) throws SOAPException
setBase64Content
in class AttachmentPart
content
- the base64 encoded data to add to the attachment partcontentType
- the value to set into the Content-Type headerSOAPException
- if an there is an error in setting the contentNullPointerException
- if content is nullpublic void setRawContent(InputStream content, String contentType) throws SOAPException
setRawContent
in class AttachmentPart
content
- the raw data to add to the attachment partcontentType
- the value to set into the Content-Type headerSOAPException
- if an there is an error in setting the contentNullPointerException
- if content is nullpublic void setRawContentBytes(byte[] content, int offset, int len, String contentType) throws SOAPException
setRawContentBytes
in class AttachmentPart
content
- the raw data to add to the attachment partcontentType
- the value to set into the Content-Type headeroffset
- the offset in the byte array of the contentlen
- the number of bytes that form the contentSOAPException
- if an there is an error in setting the content or content is nullCopyright © 2018 JBoss by Red Hat. All rights reserved.