Class MimeHeaders
- java.lang.Object
-
- javax.xml.soap.MimeHeaders
-
public class MimeHeaders extends Object
A container forMimeHeader
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 SAAJ API.- See Also:
-
SOAPMessage.getAttachments()
,AttachmentPart
-
-
Constructor Summary
Constructors Constructor and Description MimeHeaders()
Constructs a defaultMimeHeaders
object initialized with an emptyVector
object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description void
addHeader(String name, String value)
Adds aMimeHeader
object with the specified name and value to thisMimeHeaders
object's list of headers.Iterator
getAllHeaders()
Returns all theMimeHeader
s in thisMimeHeaders
object.String[]
getHeader(String name)
Returns all of the values for the specified header as an array ofString
objects.Iterator
getMatchingHeaders(String[] names)
Returns all theMimeHeader
objects whose name matches a name in the given array of names.Iterator
getNonMatchingHeaders(String[] names)
Returns all of theMimeHeader
objects whose name does not match a name in the given array of names.void
removeAllHeaders()
Removes all the header entries from thisMimeHeaders
object.void
removeHeader(String name)
Remove allMimeHeader
objects whose name matches the given name.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.
-
-
-
Constructor Detail
MimeHeaders
public MimeHeaders()
Constructs a defaultMimeHeaders
object initialized with an emptyVector
object.
-
Method Detail
getHeader
public String[] getHeader(String name)
Returns all of the values for the specified header as an array ofString
objects.- Parameters:
-
name
- the name of the header for which values will be returned - Returns:
-
a
String
array with all of the values for the specified header - See Also:
-
setHeader(java.lang.String, java.lang.String)
setHeader
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. This method also removes all matching headers after the first one.Note that RFC822 headers can contain only US-ASCII characters.
- Parameters:
-
name
- aString
with the name of the header for which to search -
value
- aString
with the value that will replace the current value of the specified header - Throws:
-
IllegalArgumentException
- if there was a problem in the mime header name or the value being set - See Also:
-
getHeader(java.lang.String)
addHeader
public void addHeader(String name, String value)
Adds aMimeHeader
object with the specified name and value to thisMimeHeaders
object's list of headers.Note that RFC822 headers can contain only US-ASCII characters.
- Parameters:
-
name
- aString
with the name of the header to be added -
value
- aString
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
removeHeader
public void removeHeader(String name)
Remove allMimeHeader
objects whose name matches the given name.- Parameters:
-
name
- aString
with the name of the header for which to search
removeAllHeaders
public void removeAllHeaders()
Removes all the header entries from thisMimeHeaders
object.
getAllHeaders
public Iterator getAllHeaders()
Returns all theMimeHeader
s in thisMimeHeaders
object.- Returns:
-
an
Iterator
object over thisMimeHeaders
object's list ofMimeHeader
objects
getMatchingHeaders
public Iterator getMatchingHeaders(String[] names)
Returns all theMimeHeader
objects whose name matches a name in the given array of names.- Parameters:
-
names
- an array ofString
objects with the names for which to search - Returns:
-
an
Iterator
object over theMimeHeader
objects whose name matches one of the names in the given list
getNonMatchingHeaders
public Iterator getNonMatchingHeaders(String[] names)
Returns all of theMimeHeader
objects whose name does not match a name in the given array of names.- Parameters:
-
names
- an array ofString
objects with the names for which to search - Returns:
-
an
Iterator
object over theMimeHeader
objects whose name does not match one of the names in the given list
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.