|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.xml.soap.AttachmentPart
org.jboss.axis.attachments.AttachmentPartImpl
public class AttachmentPartImpl
An attachment part. * *
Constructor Summary | |
---|---|
AttachmentPartImpl()
Constructor AttachmentPart |
|
AttachmentPartImpl(javax.activation.DataHandler dh)
Constructor AttachmentPart |
Method Summary | |
---|---|
void |
addMimeHeader(String header,
String value)
Add the specified MIME header, as per JAXM. |
void |
clearContent()
Clears out the content of this
AttachmentPart object. |
void |
dispose()
|
javax.activation.DataHandler |
getActivationDataHandler()
Method getActivationDataHandler |
Iterator |
getAllMimeHeaders()
Retrieves all the headers for this
AttachmentPart object as an iterator over the
MimeHeader objects. |
Object |
getContent()
Gets the content of this AttachmentPart object
as a Java object. |
String |
getContentId()
Content ID. |
String |
getContentIdRef()
Content ID. |
String |
getContentLocation()
Content location. |
String |
getContentType()
getContentType |
javax.activation.DataHandler |
getDataHandler()
Gets the DataHandler object for this
AttachmentPart object. |
String |
getFirstMimeHeader(String header)
Get the specified MIME header. |
Iterator |
getMatchingMimeHeaders(String[] match)
Get all headers that match |
String[] |
getMimeHeader(String name)
Gets all the values of the header identified by the given String . |
Iterator |
getNonMatchingMimeHeaders(String[] match)
Get all headers that do not match |
int |
getSize()
Returns the number of bytes in this
AttachmentPart object. |
boolean |
matches(javax.xml.soap.MimeHeaders headers)
check if this Part's mimeheaders matches the one passed in. |
void |
removeAllMimeHeaders()
Removes all the MIME header entries. |
void |
removeMimeHeader(String header)
Removes all MIME headers that match the given name. |
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 newCid)
Sets Content-Id of this part. |
void |
setContentLocation(String loc)
Set content location. |
void |
setContentType(String contentType)
|
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AttachmentPartImpl()
public AttachmentPartImpl(javax.activation.DataHandler dh)
dh
- Method Detail |
---|
public javax.activation.DataHandler getActivationDataHandler()
public String getContentType()
getContentType
in interface Part
getContentType
in class javax.xml.soap.AttachmentPart
public void setContentType(String contentType)
setContentType
in class javax.xml.soap.AttachmentPart
public void addMimeHeader(String header, String value)
addMimeHeader
in interface Part
addMimeHeader
in class javax.xml.soap.AttachmentPart
header
- value
- public String getFirstMimeHeader(String header)
header
-
public boolean matches(javax.xml.soap.MimeHeaders headers)
public String getContentLocation()
getContentLocation
in interface Part
getContentLocation
in class javax.xml.soap.AttachmentPart
public void setContentLocation(String loc)
setContentLocation
in interface Part
setContentLocation
in class javax.xml.soap.AttachmentPart
loc
- public void setContentId(String newCid)
setContentId
in interface Part
setContentId
in class javax.xml.soap.AttachmentPart
newCid
- new Content-Idpublic String getContentId()
getContentId
in interface Part
getContentId
in class javax.xml.soap.AttachmentPart
public Iterator getMatchingMimeHeaders(String[] match)
getMatchingMimeHeaders
in interface Part
getMatchingMimeHeaders
in class javax.xml.soap.AttachmentPart
match
-
public Iterator getNonMatchingMimeHeaders(String[] match)
getNonMatchingMimeHeaders
in interface Part
getNonMatchingMimeHeaders
in class javax.xml.soap.AttachmentPart
match
-
public Iterator getAllMimeHeaders()
AttachmentPart
object as an iterator over the
MimeHeader
objects.
getAllMimeHeaders
in class javax.xml.soap.AttachmentPart
Iterator
object with all of the Mime
headers for this AttachmentPart
objectpublic void setMimeHeader(String name, String value)
Note that RFC822 headers can only contain US-ASCII characters.
setMimeHeader
in class javax.xml.soap.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 name
IllegalArgumentException
- if
there was a problem with the specified mime header name
or valuepublic void removeAllMimeHeaders()
removeAllMimeHeaders
in class javax.xml.soap.AttachmentPart
public void removeMimeHeader(String header)
removeMimeHeader
in class javax.xml.soap.AttachmentPart
header
- - the string name of the MIME
header/s to be removedpublic javax.activation.DataHandler getDataHandler() throws javax.xml.soap.SOAPException
DataHandler
object for this
AttachmentPart
object.
getDataHandler
in class javax.xml.soap.AttachmentPart
DataHandler
object associated with
this AttachmentPart
object
javax.xml.soap.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.
setDataHandler
in class javax.xml.soap.AttachmentPart
datahandler
- DataHandler
object to
be set
IllegalArgumentException
- if
there was a problem with the specified
DataHandler
objectpublic Object getContent() throws javax.xml.soap.SOAPException
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 JAXM-compliant implementation must, as a minimum,
return a String
object corresponding
to any content stream with a Content-Type
value of text/plain
and a
javax.xml.transform.StreamSource
object
corresponding to a content stream with a
Content-Type
value of text/xml
. 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 javax.xml.soap.AttachmentPart
AttachmentPart
object
javax.xml.soap.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.
setContent
in class javax.xml.soap.AttachmentPart
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 void dispose()
public void clearContent()
AttachmentPart
object. The MIME header portion is left
untouched.
clearContent
in class javax.xml.soap.AttachmentPart
public int getSize() throws javax.xml.soap.SOAPException
AttachmentPart
object.
getSize
in class javax.xml.soap.AttachmentPart
AttachmentPart
object
in bytes or -1 if the size cannot be determined
javax.xml.soap.SOAPException
- if the content of this
attachment is corrupted of if there was an exception
while trying to determine the size.public String[] getMimeHeader(String name)
String
.
getMimeHeader
in interface Part
getMimeHeader
in class javax.xml.soap.AttachmentPart
name
- the name of the header; example:
"Content-Type"
String
array giving the value for the
specified headersetMimeHeader(String, String)
public String getContentIdRef()
getContentIdRef
in interface Part
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |