Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
javax.xml.soap.AttachmentPart
org.apache.axis.attachments.AttachmentPart
Field Summary | |
protected static Log |
|
Constructor Summary | |
| |
|
Method Summary | |
void |
|
void |
|
void |
|
void |
|
protected void |
|
DataHandler |
|
Iterator |
|
String |
|
Object |
|
String |
|
String |
|
String |
|
String |
|
DataHandler |
|
String |
|
Iterator |
|
String[] |
|
Iterator |
|
int |
|
boolean |
|
void |
|
void |
|
protected void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
Methods inherited from class javax.xml.soap.AttachmentPart | |
addMimeHeader , clearContent , getAllMimeHeaders , getContent , getContentId , getContentLocation , getContentType , getDataHandler , getMatchingMimeHeaders , getMimeHeader , getNonMatchingMimeHeaders , getSize , removeAllMimeHeaders , removeMimeHeader , setContent , setContentId , setContentLocation , setContentType , setDataHandler , setMimeHeader |
public AttachmentPart()
Bulds a newAttachmentPart
.
public AttachmentPart(DataHandler dh)
Bulds a newAttachmentPart
with aDataHandler
.
- Parameters:
dh
- theDataHandler
public void addMimeHeader(String header, String value)
Add the specified MIME header, as per JAXM.
- Specified by:
- addMimeHeader in interface Part
- Overrides:
- addMimeHeader in interface AttachmentPart
- Parameters:
header
-value
-
public void clearContent()
Clears out the content of thisAttachmentPart
object. The MIME header portion is left untouched.
- Overrides:
- clearContent in interface AttachmentPart
public void detachAttachmentFile()
Detach the attachment file from this class, so it is not cleaned up. This has the side-effect of making subsequent calls to getAttachmentFile() returnnull
.
public void dispose()
when an attachment part is disposed, any associated files are deleted, and the datahandler itself nulled. The object is no longer completely usable, at this point
protected void finalize() throws Throwable
On death, we clean up our file.
public DataHandler getActivationDataHandler()
Get the data handler.
- Returns:
- the activation
DataHandler
public Iterator getAllMimeHeaders()
Retrieves all the headers for thisAttachmentPart
object as an iterator over theMimeHeader
objects.
- Overrides:
- getAllMimeHeaders in interface AttachmentPart
- Returns:
- an
Iterator
object with all of the Mime headers for thisAttachmentPart
object
public String getAttachmentFile()
Get the filename of this attachment.
- Returns:
- the filename or null for an uncached file
public Object getContent() throws SOAPException
Gets the content of thisAttachmentPart
object as a Java object. The type of the returned Java object depends on (1) theDataContentHandler
object that is used to interpret the bytes and (2) theContent-Type
given in the header. For the MIME content types "text/plain", "text/html" and "text/xml", theDataContentHandler
object does the conversions to and from the Java types corresponding to the MIME types. For other MIME types,theDataContentHandler
object can return anInputStream
object that contains the content data as raw bytes. A JAXM-compliant implementation must, as a minimum, return ajava.lang.String
object corresponding to any content stream with aContent-Type
value oftext/plain
and ajavax.xml.transform.StreamSource
object corresponding to a content stream with aContent-Type
value oftext/xml
. For those content types that an installedDataContentHandler
object does not understand, theDataContentHandler
object is required to return ajava.io.InputStream
object with the raw bytes.
- Overrides:
- getContent in interface AttachmentPart
- Returns:
- a Java object with the content of this
AttachmentPart
object
- Throws:
SOAPException
- if there is no content set into thisAttachmentPart
object or if there was a data transformation error
public String getContentId()
Get the content ID.
- Specified by:
- getContentId in interface Part
- Overrides:
- getContentId in interface AttachmentPart
- Returns:
- the content ID
public String getContentIdRef()
Content ID.
- Specified by:
- getContentIdRef in interface Part
- Returns:
- the contentId reference value that should be used directly as an href in a SOAP element to reference this attachment. Not part of JAX-RPC, JAX-M, SAAJ, etc.
public String getContentLocation()
Get the content location.
- Specified by:
- getContentLocation in interface Part
- Overrides:
- getContentLocation in interface AttachmentPart
- Returns:
- a
String
giving the location
public String getContentType()
getContentType
- Specified by:
- getContentType in interface Part
- Overrides:
- getContentType in interface AttachmentPart
- Returns:
- content type
public DataHandler getDataHandler() throws SOAPException
Gets theDataHandler
object for thisAttachmentPart
object.
- Overrides:
- getDataHandler in interface AttachmentPart
- Returns:
- the
DataHandler
object associated with thisAttachmentPart
object
- Throws:
SOAPException
- if there is no data in thisAttachmentPart
object
public String getFirstMimeHeader(String header)
Get the specified MIME header.
- Parameters:
header
-
- Returns:
public Iterator getMatchingMimeHeaders(String[] match)
Get anIterator
over all headers that match any item inmatch
.
- Specified by:
- getMatchingMimeHeaders in interface Part
public String[] getMimeHeader(String name)
Gets all the values of the header identified by the givenString
.
- Specified by:
- getMimeHeader in interface Part
- Overrides:
- getMimeHeader in interface AttachmentPart
- Parameters:
name
- the name of the header; example: "Content-Type"
- Returns:
- a
String
array giving the value for the specified header
- See Also:
setMimeHeader(java.lang.String, java.lang.String)
public Iterator getNonMatchingMimeHeaders(String[] match)
Get all headers that do not match.
- Specified by:
- getNonMatchingMimeHeaders in interface Part
public int getSize() throws SOAPException
Returns the number of bytes in thisAttachmentPart
object.
- Overrides:
- getSize in interface AttachmentPart
- Returns:
- the size of this
AttachmentPart
object in bytes or -1 if the size cannot be determined
- Throws:
SOAPException
- if the content of this attachment is corrupted of if there was an exception while trying to determine the size.
public boolean matches(MimeHeaders headers)
check if this Part's mimeheaders matches the one passed in. TODO: Am not sure about the logic.
- Parameters:
headers
- theMimeHeaders
to check
- Returns:
- true if all header name, values in
headers
are found, false otherwise
public void removeAllMimeHeaders()
Removes all the MIME header entries.
- Overrides:
- removeAllMimeHeaders in interface AttachmentPart
public void removeMimeHeader(String header)
Removes all MIME headers that match the given name.
- Overrides:
- removeMimeHeader in interface AttachmentPart
- Parameters:
header
- - the string name of the MIME header/s to be removed
protected void setAttachmentFile(String path)
Set the filename of this attachment part.
- Parameters:
path
- the new file path
public void setContent(Object object, String contentType)
Sets the content of this attachment part to that of the givenObject
and sets the value of theContent-Type
header to the given type. The type of theObject
should correspond to the value given for theContent-Type
. This depends on the particular set ofDataContentHandler
objects in use.
- Overrides:
- setContent in interface AttachmentPart
- Parameters:
object
- the Java object that makes up the content for this attachment partcontentType
- the MIME string that specifies the type of the content
- See Also:
getContent()
public void setContentId(String newCid)
Sets Content-Id of this part. already defined.
- Specified by:
- setContentId in interface Part
- Overrides:
- setContentId in interface AttachmentPart
- Parameters:
newCid
- new Content-Id
public void setContentLocation(String loc)
Set content location.
- Specified by:
- setContentLocation in interface Part
- Overrides:
- setContentLocation in interface AttachmentPart
- Parameters:
loc
- the new location
public void setDataHandler(DataHandler datahandler)
Sets the givenDataHandler
object as the data handler for thisAttachmentPart
object. Typically, on an incoming message, the data handler is automatically set. When a message is being created and populated with content, thesetDataHandler
method can be used to get data from various data sources into the message.
- Overrides:
- setDataHandler in interface AttachmentPart
- Parameters:
datahandler
-DataHandler
object to be set
public 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. This method also removes all matching headers but the first. Note that RFC822 headers can only contain US-ASCII characters.
- Overrides:
- setMimeHeader in interface AttachmentPart
- Parameters:
name
- aString
giving the name of the header for which to searchvalue
- aString
giving the value to be set for the header whose name matches the given name