com.sun.xml.ws.api.message
Interface MessageHeaders

All Known Implementing Classes:

HeaderList, SAAJMessageHeaders

public interface MessageHeaders

Interface representing all the headers of a Message

Method Summary

boolean	add(Header header)
boolean	addOrReplace(Header header) Replaces an existing Header or adds a new Header.
Header	get(javax.xml.namespace.QName name, boolean markAsUnderstood)
Header	get(java.lang.String nsUri, java.lang.String localName, boolean markAsUnderstood)
java.util.Iterator<Header>	getHeaders()
java.util.Iterator<Header>	getHeaders(javax.xml.namespace.QName headerName, boolean markAsUnderstood)
java.util.Iterator<Header>	getHeaders(java.lang.String nsUri, boolean markAsUnderstood) Get all headers in specified namespace
java.util.Iterator<Header>	getHeaders(java.lang.String nsUri, java.lang.String localName, boolean markAsUnderstood)
java.util.Set<javax.xml.namespace.QName>	getNotUnderstoodHeaders(java.util.Set<java.lang.String> roles, java.util.Set<javax.xml.namespace.QName> knownHeaders, WSBinding binding) Returns a Set of QNames of headers that satisfy ALL the following conditions: (a) Have mustUnderstand = true (b) have NOT been explicitly marked as understood (c) If roles argument is non-null, the header has isIgnorable = false for the roles argument and SOAP version (d) If non-null binding is passed in, are NOT understood by the binding (e) If (d) is met, the header is NOT in the knownHeaders list passed in
java.util.Set<javax.xml.namespace.QName>	getUnderstoodHeaders() Return a Set of QNames of headers that have been explicitly marked as understood.
boolean	isUnderstood(Header header) True if the header has been explicitly marked understood, false otherwise
boolean	isUnderstood(javax.xml.namespace.QName header) True if the header has been explicitly marked understood, false otherwise
boolean	isUnderstood(java.lang.String nsUri, java.lang.String header) True if the header has been explicitly marked understood, false otherwise
Header	remove(javax.xml.namespace.QName name)
Header	remove(java.lang.String nsUri, java.lang.String localName)
void	understood(Header header)
void	understood(javax.xml.namespace.QName name)
void	understood(java.lang.String nsUri, java.lang.String localName)

Method Detail

understood

void understood(Header header)

understood

void understood(javax.xml.namespace.QName name)

understood

void understood(java.lang.String nsUri,
                java.lang.String localName)

get

Header get(java.lang.String nsUri,
           java.lang.String localName,
           boolean markAsUnderstood)

get

Header get(javax.xml.namespace.QName name,
           boolean markAsUnderstood)

getHeaders

java.util.Iterator<Header> getHeaders(java.lang.String nsUri,
                                      java.lang.String localName,
                                      boolean markAsUnderstood)

getHeaders

java.util.Iterator<Header> getHeaders(java.lang.String nsUri,
                                      boolean markAsUnderstood)

Get all headers in specified namespace

Parameters:

nsUri -

markAsUnderstood -

Returns:

getHeaders

java.util.Iterator<Header> getHeaders(javax.xml.namespace.QName headerName,
                                      boolean markAsUnderstood)

getHeaders

java.util.Iterator<Header> getHeaders()

add

boolean add(Header header)

remove

Header remove(javax.xml.namespace.QName name)

remove

Header remove(java.lang.String nsUri,
              java.lang.String localName)

addOrReplace

boolean addOrReplace(Header header)

Replaces an existing Header or adds a new Header.

Order doesn't matter in headers, so this method does not make any guarantee as to where the new header is inserted.

Returns:

always true. Don't use the return value.

getUnderstoodHeaders

java.util.Set<javax.xml.namespace.QName> getUnderstoodHeaders()

Return a Set of QNames of headers that have been explicitly marked as understood. If none have been marked, this method could return null

getNotUnderstoodHeaders

java.util.Set<javax.xml.namespace.QName> getNotUnderstoodHeaders(java.util.Set<java.lang.String> roles,
                                                                 java.util.Set<javax.xml.namespace.QName> knownHeaders,
                                                                 WSBinding binding)

Returns a Set of QNames of headers that satisfy ALL the following conditions: (a) Have mustUnderstand = true (b) have NOT been explicitly marked as understood (c) If roles argument is non-null, the header has isIgnorable = false for the roles argument and SOAP version (d) If non-null binding is passed in, are NOT understood by the binding (e) If (d) is met, the header is NOT in the knownHeaders list passed in

Parameters:

roles -

knownHeaders -

binding -

Returns:

isUnderstood

boolean isUnderstood(Header header)

True if the header has been explicitly marked understood, false otherwise

Parameters:

header -

Returns:

isUnderstood

boolean isUnderstood(javax.xml.namespace.QName header)

True if the header has been explicitly marked understood, false otherwise

Parameters:

header -

Returns:

isUnderstood

boolean isUnderstood(java.lang.String nsUri,
                     java.lang.String header)

True if the header has been explicitly marked understood, false otherwise

Parameters:

header -

Returns: