- All Known Implementing Classes:
HeaderList
,SAAJMessageHeaders
public interface MessageHeaders
Interface representing all the headers of a
Message
-
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
addOrReplace
(Header header) asList()
ReturnsHeader
instances in aList
.getHeaders
(String nsUri, boolean markAsUnderstood) Get all headers in specified namespacegetHeaders
(String nsUri, String localName, boolean markAsUnderstood) getHeaders
(QName headerName, boolean markAsUnderstood) 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 inReturn a Set of QNames of headers that have been explicitly marked as understood.boolean
boolean
isUnderstood
(Header header) True if the header has been explicitly marked understood, false otherwiseboolean
isUnderstood
(String nsUri, String header) True if the header has been explicitly marked understood, false otherwiseboolean
isUnderstood
(QName header) True if the header has been explicitly marked understood, false otherwisevoid
void
understood
(Header header) void
understood
(String nsUri, String localName) void
understood
(QName name)
-
Method Details
-
understood
-
understood
-
understood
-
get
-
get
-
getHeaders
-
getHeaders
Get all headers in specified namespace -
getHeaders
-
getHeaders
-
hasHeaders
boolean hasHeaders() -
add
-
remove
-
remove
-
replace
-
addOrReplace
Replaces an existingHeader
or adds a newHeader
.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
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
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 -
isUnderstood
True if the header has been explicitly marked understood, false otherwise -
isUnderstood
True if the header has been explicitly marked understood, false otherwise -
isUnderstood
True if the header has been explicitly marked understood, false otherwise -
asList
ReturnsHeader
instances in aList
.- Returns:
List
containingHeader
instances
-