|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.xml.soap.AttachmentPart
org.apache.axis2.saaj.AttachmentPartImpl
Constructor Summary | |
AttachmentPartImpl()
|
Method Summary | |
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. |
void |
detachAttachmentFile()
Detach the attachment file from this class, so it is not cleaned up. |
Iterator |
getAllMimeHeaders()
Retrieves all the headers for this
AttachmentPart object as an iterator over the
MimeHeader objects. |
String |
getAttachmentFile()
Get the filename of this attachment. |
Object |
getContent()
Gets the content of this AttachmentPart object as a Java
object. |
javax.activation.DataHandler |
getDataHandler()
Gets the DataHandler object for this
AttachmentPart object. |
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. |
org.apache.axiom.om.OMText |
getOMText()
Retrieve the OMText |
int |
getSize()
Returns the number of bytes in this
AttachmentPart object. |
org.apache.axiom.om.impl.dom.TextImpl |
getText(org.apache.axiom.om.impl.dom.DocumentImpl doc)
|
boolean |
isAttachmentReferenced()
|
boolean |
matches(MimeHeaders headers)
Check whether at least one of the headers of this object matches a provided header |
void |
removeAllMimeHeaders()
Removes all the MIME header entries. |
void |
removeMimeHeader(String header)
Removes all MIME headers that match the given name. |
protected void |
setAttachmentFile(String path)
Set the filename of this attachment part. |
void |
setAttachmentReferenced(boolean attachmentReferenced)
|
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 |
setDataHandler(javax.activation.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. |
Methods inherited from class javax.xml.soap.AttachmentPart |
getContentId, getContentLocation, getContentType, setContentId, setContentLocation, setContentType |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public AttachmentPartImpl()
Method Detail |
public boolean matches(MimeHeaders headers)
headers
-
headers
parameter,
false if none of the headers of this AttachmentPart matches
at least one of the header in the provided headers
parameterpublic boolean isAttachmentReferenced()
public void setAttachmentReferenced(boolean attachmentReferenced)
public int getSize() throws SOAPException
AttachmentPart
object.
AttachmentPart
object
in bytes or -1 if the size cannot be determined
SOAPException
- if the content of this
attachment is corrupted of if there was an exception
while trying to determine the size.public void clearContent()
AttachmentPart
object. The MIME header portion is left
untouched.
public Object getContent() throws SOAPException
AttachmentPart
object as a Java
object. The type of the returned Java object depends on
DataContentHandler
object that is used to interpret the bytes
Content-Type
given in the headerDataContentHandler
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 JAXM-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.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.
AttachmentPart
object
SOAPException
- if there is no content set
into this AttachmentPart
object or if there
was a data transformation errorpublic void setContent(Object object, String contentType)
Object
and sets the value of the
Content-Type
header to the given type. The type of the
Object
should correspond to the value given for
the Content-Type
. This depends on the particular
set of DataContentHandler
objects in use.
object
- the Java object that makes up
the content for this attachment partcontentType
- the MIME string that
specifies the type of the content
IllegalArgumentException
- if
the contentType does not match the type of the content
object, or if there was no
DataContentHandler
object for this content
objectgetContent()
public javax.activation.DataHandler getDataHandler() throws SOAPException
DataHandler
object for this
AttachmentPart
object.
DataHandler
object associated with
this AttachmentPart
object
SOAPException
- if there is
no data in this AttachmentPart
objectpublic void setDataHandler(javax.activation.DataHandler datahandler)
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.
datahandler
- DataHandler
object to
be set
IllegalArgumentException
- if
there was a problem with the specified
DataHandler
objectpublic void removeMimeHeader(String header)
header
- - the string name of the MIME
header/s to be removedpublic void removeAllMimeHeaders()
public String[] getMimeHeader(String name)
String
.
name
- the name of the header; example:
"Content-Type"
String
array giving the value for the
specified headersetMimeHeader(java.lang.String, java.lang.String)
public void setMimeHeader(String name, String value)
Note that RFC822 headers can only contain US-ASCII characters.
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 name
IllegalArgumentException
- if
there was a problem with the specified mime header name
or valuepublic void addMimeHeader(String name, String value)
AttachmentPart
object.
Note that RFC822 headers can contain only US-ASCII characters.
name
- a String
giving the
name of the header to be addedvalue
- a String
giving the
value of the header to be added
IllegalArgumentException
- if
there was a problem with the specified mime header name
or valuepublic Iterator getAllMimeHeaders()
AttachmentPart
object as an iterator over the
MimeHeader
objects.
Iterator
object with all of the Mime
headers for this AttachmentPart
objectpublic Iterator getMatchingMimeHeaders(String[] names)
MimeHeader
objects that match
a name in the given array.
names
- a String
array with
the name(s) of the MIME headers to be returned
Iterator
objectpublic Iterator getNonMatchingMimeHeaders(String[] names)
MimeHeader
objects whose name
does not match a name in the given array.
names
- a String
array with
the name(s) of the MIME headers not to be returned
AttachmentPart
object except those that match one
of the names in the given array. The nonmatching MIME
headers are returned as an Iterator
object.public org.apache.axiom.om.OMText getOMText() throws SOAPException
SOAPException
- If omText is not availablepublic org.apache.axiom.om.impl.dom.TextImpl getText(org.apache.axiom.om.impl.dom.DocumentImpl doc)
protected void setAttachmentFile(String path)
path
- the new file pathpublic void detachAttachmentFile()
null
.
public String getAttachmentFile()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |