org.apache.axis

Interface Part

All Superinterfaces:
java.io.Serializable
Known Implementing Classes:
AttachmentPart, SOAPPart

public interface Part
extends java.io.Serializable

A part of a MIME message. Typically, in a MIME message there will be one SOAPPart containing the SOAP message, and 0 or more AttachmentParts instances containing each of the attachments.

Method Summary

void
addMimeHeader(String header, String value)
Add the specified MIME header, as per JAXM.
String
getContentId()
Get the content ID.
String
getContentIdRef()
Content ID.
String
getContentLocation()
Get the content location.
String
getContentType()
Get the content type.
java.util.Iterator
getMatchingMimeHeaders(String[] match)
Get an Iterator over all headers that match any item in match.
String[]
getMimeHeader(String name)
Gets all the values of the MimeHeader object in this SOAPPart object that is identified by the given String.
java.util.Iterator
getNonMatchingMimeHeaders(String[] match)
Get all headers that do not match.
void
setContentId(String newCid)
Sets Content-Id of this part.
void
setContentLocation(String loc)
Set content location.

Method Details

addMimeHeader

public void addMimeHeader(String header,
                          String value)
Add the specified MIME header, as per JAXM.
Parameters:
header - the MIME header name
value - the value associated with the header

getContentId

public String getContentId()
Get the content ID.
Returns:
the content ID

getContentIdRef

public String getContentIdRef()
Content ID.
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.

getContentLocation

public String getContentLocation()
Get the content location.
Returns:
a String giving the location

getContentType

public String getContentType()
Get the content type.
Returns:
the content type String

getMatchingMimeHeaders

public java.util.Iterator getMatchingMimeHeaders(String[] match)
Get an Iterator over all headers that match any item in match.

getMimeHeader

public String[] getMimeHeader(String name)
Gets all the values of the MimeHeader object in this SOAPPart object that is identified by the given String.
Parameters:
name - the name of the header; example: "Content-Type"
Returns:
a String array giving all the values for the specified header
See Also:
setMimeHeader(java.lang.String, java.lang.String)

getNonMatchingMimeHeaders

public java.util.Iterator getNonMatchingMimeHeaders(String[] match)
Get all headers that do not match.

setContentId

public void setContentId(String newCid)
Sets Content-Id of this part. already defined.
Parameters:
newCid - new Content-Id

setContentLocation

public void setContentLocation(String loc)
Set content location.
Parameters:
loc - the new location

Copyright © 2005 Apache Web Services Project. All Rights Reserved.