|
| |
|
| java.lang.Object
 javax.xml.soap.MimeHeaders
All known Subclasses: org.apache.axis2.saaj.MimeHeadersEx,
| MimeHeaders | | public class MimeHeaders (Code) | | A container for MimeHeader objects, which represent the MIME headers present in a
MIME part of a message.
This class is used primarily when an application wants to retrieve specific attachments based
on certain MIME headers and values. This class will most likely be used by implementations of
AttachmentPart and other MIME dependent parts of the JAXM API.
See Also: SOAPMessage.getAttachments
See Also: SOAPMessage.getAttachments()
See Also: AttachmentPart
See Also: AttachmentPart |
| Inner Class :class MatchingIterator implements Iterator | |
| Constructor Summary | |
| public | MimeHeaders()
Constructs a default MimeHeaders object initialized with an empty
Vector object. |
| Method Summary | |
| public void | addHeader(String name, String value)
Adds a MimeHeader object with the specified name and value to this
MimeHeaders object's list of headers. | | public Iterator | getAllHeaders()
Returns all the headers in this MimeHeaders object. | | public String[] | getHeader(String name)
Returns all of the values for the specified header as an array of String
objects. | | public Iterator | getMatchingHeaders(String names)
Returns all the MimeHeader objects whose name matches a name in the given array
of names. | | public Iterator | getNonMatchingHeaders(String names)
Returns all of the MimeHeader objects whose name does not match a name in the
given array of names. | | public void | removeAllHeaders()
Removes all the header entries from this MimeHeaders object. | | public void | removeHeader(String name)
Remove all MimeHeader objects whose name matches the the given name. | | public void | setHeader(String name, String value)
Replaces the current value of the first header entry whose name matches the given name with
the given value, adding a new header if no existing header name matches. |
| MimeHeaders | | public MimeHeaders()(Code) | | Constructs a default MimeHeaders object initialized with an empty
Vector object.
|
| addHeader | | public void addHeader(String name, String value)(Code) | | Adds a MimeHeader object with the specified name and value to this
MimeHeaders object's list of headers.
Note that RFC822 headers can contain only US-ASCII characters.
Parameters:
name - a String with the name of the header to be added
Parameters:
value - a String with the value of the header to be added
throws:
IllegalArgumentException - if there was a problem in the mime header name or value being added |
| getAllHeaders | | public Iterator getAllHeaders()(Code) | | Returns all the headers in this MimeHeaders object.
an Iterator object over this MimeHeaders object's list of MimeHeader objects |
| getHeader | | public String[] getHeader(String name)(Code) | | Returns all of the values for the specified header as an array of String
objects.
Parameters:
name - the name of the header for which values will be returned a String array with all of the values for the specified header
See Also: MimeHeaders.setHeader(String,String)
See Also: setHeader(java.lang.String,
See Also: java.lang.String) |
| getMatchingHeaders | | public Iterator getMatchingHeaders(String names)(Code) | | Returns all the MimeHeader objects whose name matches a name in the given array
of names.
Parameters:
names - an array of String objects with the names for which to search an Iterator object over the MimeHeader objects whose namematches one of the names in the given list |
| getNonMatchingHeaders | | public Iterator getNonMatchingHeaders(String names)(Code) | | Returns all of the MimeHeader objects whose name does not match a name in the
given array of names.
Parameters:
names - an array of String objects with the names for which to search an Iterator object over the MimeHeader objects whose namedoes not match one of the names in the given list |
| removeAllHeaders | | public void removeAllHeaders()(Code) | | Removes all the header entries from this MimeHeaders object.
|
| removeHeader | | public void removeHeader(String name)(Code) | | Remove all MimeHeader objects whose name matches the the given name.
Parameters:
name - a String with the name of the header for which to search |
| setHeader | | public void setHeader(String name, String value)(Code) | | Replaces the current value of the first header entry whose name matches the given name with
the given value, adding a new header if no existing header name matches. This method also
removes all matching headers after the first one.
Note that RFC822 headers can contain only US-ASCII characters.
Parameters:
name - a String with the name of the header for which to search
Parameters:
value - a String with the value that will replace the current value of thespecified header
throws:
IllegalArgumentException - if there was a problem in the mime header name or the value being set
See Also: MimeHeaders.getHeader(String)
See Also: getHeader(java.lang.String) |
|
|
|