Package com.sun.xml.wss.core

Class SecurityHeader

java.lang.Object

com.sun.xml.wss.impl.misc.SOAPElementExtension

com.sun.xml.wss.core.SecurityHeader

All Implemented Interfaces:

javax.xml.soap.Node, javax.xml.soap.SOAPElement, Element, Node

public class SecurityHeader
extends SOAPElementExtension
implements javax.xml.soap.SOAPElement

Author:

XWS-Security Development Team

Field Summary

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

Constructors

Constructor	Description
SecurityHeader(javax.xml.soap.SOAPElement delegateHeader)

Method Summary

Modifier and Type	Method	Description
javax.xml.soap.SOAPElement	addAttribute(javax.xml.soap.Name arg0, String arg1)
javax.xml.soap.SOAPElement	addChildElement(String arg0)
javax.xml.soap.SOAPElement	addChildElement(String arg0, String arg1)
javax.xml.soap.SOAPElement	addChildElement(String arg0, String arg1, String arg2)
javax.xml.soap.SOAPElement	addChildElement(javax.xml.soap.Name arg0)
javax.xml.soap.SOAPElement	addChildElement(javax.xml.soap.SOAPElement arg0)
javax.xml.soap.SOAPElement	addNamespaceDeclaration(String arg0, String arg1)
javax.xml.soap.SOAPElement	addTextNode(String arg0)
void	appendChild(SecurityHeaderBlock block)
Node	appendChild(Node arg0)
Node	cloneNode(boolean arg0)
short	compareDocumentPosition(Node other)
void	detachNode()
boolean	equals(Object obj)
Iterator	getAllAttributes()
Iterator	getAllAttributesAsQNames()
javax.xml.soap.SOAPElement	getAsSoapElement()
String	getAttribute(String arg0)
Attr	getAttributeNode(String arg0)
Attr	getAttributeNodeNS(String arg0, String arg1)
String	getAttributeNS(String arg0, String arg1)
NamedNodeMap	getAttributes()
String	getAttributeValue(javax.xml.soap.Name arg0)
String	getBaseURI()
Iterator	getChildElements()
Iterator	getChildElements(javax.xml.soap.Name arg0)
NodeList	getChildNodes()
SecurityHeaderBlock	getCurrentHeaderBlock(Class implType)	Get the header block to be processed next.
javax.xml.soap.SOAPElement	getCurrentHeaderBlockElement()
javax.xml.soap.SOAPElement	getCurrentHeaderElement()
javax.xml.soap.Name	getElementName()
NodeList	getElementsByTagName(String arg0)
NodeList	getElementsByTagNameNS(String arg0, String arg1)
String	getEncodingStyle()
Object	getFeature(String feature, String version)
Node	getFirstChild()
javax.xml.soap.SOAPElement	getFirstChildElement()
Node	getLastChild()
String	getLocalName()
Iterator	getNamespacePrefixes()
String	getNamespaceURI()
String	getNamespaceURI(String arg0)
Node	getNextSibling()
javax.xml.soap.SOAPElement	getNextSiblingOfTimestamp()
String	getNodeName()
short	getNodeType()
String	getNodeValue()
Document	getOwnerDocument()
javax.xml.soap.SOAPElement	getParentElement()
Node	getParentNode()
String	getPrefix()
Node	getPreviousSibling()
String	getRole()
TypeInfo	getSchemaTypeInfo()
String	getTagName()
String	getTextContent()
Object	getUserData(String key)
String	getValue()
Iterator	getVisibleNamespacePrefixes()
boolean	hasAttribute(String arg0)
boolean	hasAttributeNS(String arg0, String arg1)
boolean	hasAttributes()
boolean	hasChildNodes()
int	hashCode()
void	insertBefore(SecurityHeaderBlock block, Node elem)
Node	insertBefore(Node arg0, Node arg1)
void	insertHeaderBlock(SecurityHeaderBlock block)	Inserts the header block at the top of the security header, i.e, the block becomes the first child element of the security header.
void	insertHeaderBlockElement(javax.xml.soap.SOAPElement blockElement)
boolean	isDefaultNamespace(String namespaceURI)
boolean	isEqualNode(Node arg)
boolean	isMustUnderstand()
boolean	isSameNode(Node other)
boolean	isSupported(String arg0, String arg1)
String	lookupNamespaceURI(String prefix)
String	lookupPrefix(String namespaceURI)
javax.xml.soap.SOAPElement	makeUsable(javax.xml.soap.SOAPElement elem)
void	normalize()
void	recycleNode()
void	removeAttribute(String arg0)
boolean	removeAttribute(javax.xml.soap.Name arg0)
Attr	removeAttributeNode(Attr arg0)
void	removeAttributeNS(String arg0, String arg1)
Node	removeChild(Node arg0)
void	removeContents()
boolean	removeNamespaceDeclaration(String arg0)
Node	replaceChild(Node arg0, Node arg1)
void	setAttribute(String arg0, String arg1)
Attr	setAttributeNode(Attr arg0)
Attr	setAttributeNodeNS(Attr arg0)
void	setAttributeNS(String arg0, String arg1, String arg2)
void	setCurrentHeaderElement(javax.xml.soap.SOAPElement currentElement)
void	setEncodingStyle(String arg0)
void	setIdAttribute(String name, boolean isId)
void	setIdAttributeNode(Attr idAttr, boolean isId)
void	setIdAttributeNS(String namespaceURI, String localName, boolean isId)
void	setMustUnderstand(boolean mustUnderstand)
void	setNodeValue(String arg0)
void	setParentElement(javax.xml.soap.SOAPElement arg0)
void	setPrefix(String arg0)
void	setRole(String roleURI)
void	setTextContent(String textContent)
Object	setUserData(String key, Object data, UserDataHandler handler)
void	setValue(String arg0)
String	toString()
void	updateTopMostSoapElement()

Methods inherited from class com.sun.xml.wss.impl.misc.SOAPElementExtension

addAttribute, addChildElement, createQName, getAttributeValue, getChildElements, getElementQName, removeAttribute, setElementQName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.xml.soap.SOAPElement

addAttribute, addChildElement, createQName, getAttributeValue, getChildElements, getElementQName, removeAttribute, setElementQName

Constructor Detail

SecurityHeader

public SecurityHeader(javax.xml.soap.SOAPElement delegateHeader)

Method Detail

insertHeaderBlock

public void insertHeaderBlock(SecurityHeaderBlock block)
                       throws XWSSecurityException

Inserts the header block at the top of the security header, i.e, the block becomes the first child element of the security header. This method will be used on the sender side.

Throws:

XWSSecurityException

insertBefore

public void insertBefore(SecurityHeaderBlock block,
                         Node elem)
                  throws XWSSecurityException

Throws:

XWSSecurityException

appendChild

public void appendChild(SecurityHeaderBlock block)
                 throws XWSSecurityException

Throws:

XWSSecurityException

insertHeaderBlockElement

public void insertHeaderBlockElement(javax.xml.soap.SOAPElement blockElement)
                              throws XWSSecurityException

Throws:

XWSSecurityException

getCurrentHeaderBlock

public SecurityHeaderBlock getCurrentHeaderBlock(Class implType)
                                          throws XWSSecurityException

Get the header block to be processed next. This method will be used on the receiver side.

Throws:

XWSSecurityException

getCurrentHeaderBlockElement

public javax.xml.soap.SOAPElement getCurrentHeaderBlockElement()

setCurrentHeaderElement

public void setCurrentHeaderElement(javax.xml.soap.SOAPElement currentElement)
                             throws XWSSecurityException

Throws:

XWSSecurityException

getCurrentHeaderElement

public javax.xml.soap.SOAPElement getCurrentHeaderElement()

updateTopMostSoapElement

public void updateTopMostSoapElement()

getFirstChildElement

public javax.xml.soap.SOAPElement getFirstChildElement()

getNextSiblingOfTimestamp

public javax.xml.soap.SOAPElement getNextSiblingOfTimestamp()

getAsSoapElement

public javax.xml.soap.SOAPElement getAsSoapElement()

setRole

public void setRole(String roleURI)

getRole

public String getRole()

setMustUnderstand

public void setMustUnderstand(boolean mustUnderstand)

isMustUnderstand

public boolean isMustUnderstand()

addAttribute

public javax.xml.soap.SOAPElement addAttribute(javax.xml.soap.Name arg0,
                                               String arg1)
                                        throws javax.xml.soap.SOAPException

Specified by:

addAttribute in interface javax.xml.soap.SOAPElement

Throws:

javax.xml.soap.SOAPException

addChildElement

public javax.xml.soap.SOAPElement addChildElement(String arg0)
                                           throws javax.xml.soap.SOAPException

Specified by:

addChildElement in interface javax.xml.soap.SOAPElement

Throws:

javax.xml.soap.SOAPException

addChildElement

public javax.xml.soap.SOAPElement addChildElement(String arg0,
                                                  String arg1)
                                           throws javax.xml.soap.SOAPException

Specified by:

addChildElement in interface javax.xml.soap.SOAPElement

Throws:

javax.xml.soap.SOAPException

addChildElement

public javax.xml.soap.SOAPElement addChildElement(String arg0,
                                                  String arg1,
                                                  String arg2)
                                           throws javax.xml.soap.SOAPException

Specified by:

addChildElement in interface javax.xml.soap.SOAPElement

Throws:

javax.xml.soap.SOAPException

addChildElement

public javax.xml.soap.SOAPElement addChildElement(javax.xml.soap.Name arg0)
                                           throws javax.xml.soap.SOAPException

Specified by:

addChildElement in interface javax.xml.soap.SOAPElement

Throws:

javax.xml.soap.SOAPException

addChildElement

public javax.xml.soap.SOAPElement addChildElement(javax.xml.soap.SOAPElement arg0)
                                           throws javax.xml.soap.SOAPException

Specified by:

addChildElement in interface javax.xml.soap.SOAPElement

Throws:

javax.xml.soap.SOAPException

addNamespaceDeclaration

public javax.xml.soap.SOAPElement addNamespaceDeclaration(String arg0,
                                                          String arg1)
                                                   throws javax.xml.soap.SOAPException

Specified by:

addNamespaceDeclaration in interface javax.xml.soap.SOAPElement

Throws:

javax.xml.soap.SOAPException

addTextNode

public javax.xml.soap.SOAPElement addTextNode(String arg0)
                                       throws javax.xml.soap.SOAPException

Specified by:

addTextNode in interface javax.xml.soap.SOAPElement

Throws:

javax.xml.soap.SOAPException

appendChild

public Node appendChild(Node arg0)
                 throws DOMException

Specified by:

appendChild in interface Node

Throws:

DOMException

makeUsable

public javax.xml.soap.SOAPElement makeUsable(javax.xml.soap.SOAPElement elem)
                                      throws XWSSecurityException

Throws:

XWSSecurityException

cloneNode

public Node cloneNode(boolean arg0)

Specified by:

cloneNode in interface Node

detachNode

public void detachNode()

Specified by:

detachNode in interface javax.xml.soap.Node

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getAllAttributes

public Iterator getAllAttributes()

Specified by:

getAllAttributes in interface javax.xml.soap.SOAPElement

getAttribute

public String getAttribute(String arg0)

Specified by:

getAttribute in interface Element

getAttributeNode

public Attr getAttributeNode(String arg0)

Specified by:

getAttributeNode in interface Element

getAttributeNodeNS

public Attr getAttributeNodeNS(String arg0,
                               String arg1)

Specified by:

getAttributeNodeNS in interface Element

getAttributeNS

public String getAttributeNS(String arg0,
                             String arg1)

Specified by:

getAttributeNS in interface Element

getAttributes

public NamedNodeMap getAttributes()

Specified by:

getAttributes in interface Node

getAttributeValue

public String getAttributeValue(javax.xml.soap.Name arg0)

Specified by:

getAttributeValue in interface javax.xml.soap.SOAPElement

getChildElements

public Iterator getChildElements()

Specified by:

getChildElements in interface javax.xml.soap.SOAPElement

getChildElements

public Iterator getChildElements(javax.xml.soap.Name arg0)

Specified by:

getChildElements in interface javax.xml.soap.SOAPElement

getChildNodes

public NodeList getChildNodes()

Specified by:

getChildNodes in interface Node

getElementName

public javax.xml.soap.Name getElementName()

Specified by:

getElementName in interface javax.xml.soap.SOAPElement

getElementsByTagName

public NodeList getElementsByTagName(String arg0)

Specified by:

getElementsByTagName in interface Element

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String arg0,
                                       String arg1)

Specified by:

getElementsByTagNameNS in interface Element

getEncodingStyle

public String getEncodingStyle()

Specified by:

getEncodingStyle in interface javax.xml.soap.SOAPElement

getFirstChild

public Node getFirstChild()

Specified by:

getFirstChild in interface Node

getLastChild

public Node getLastChild()

Specified by:

getLastChild in interface Node

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface Node

getNamespacePrefixes

public Iterator getNamespacePrefixes()

Specified by:

getNamespacePrefixes in interface javax.xml.soap.SOAPElement

getNamespaceURI

public String getNamespaceURI()

Specified by:

getNamespaceURI in interface Node

getNamespaceURI

public String getNamespaceURI(String arg0)

Specified by:

getNamespaceURI in interface javax.xml.soap.SOAPElement

getNextSibling

public Node getNextSibling()

Specified by:

getNextSibling in interface Node

getNodeName

public String getNodeName()

Specified by:

getNodeName in interface Node

getNodeType

public short getNodeType()

Specified by:

getNodeType in interface Node

getNodeValue

public String getNodeValue()
                    throws DOMException

Specified by:

getNodeValue in interface Node

Throws:

DOMException

getOwnerDocument

public Document getOwnerDocument()

Specified by:

getOwnerDocument in interface Node

getParentElement

public javax.xml.soap.SOAPElement getParentElement()

Specified by:

getParentElement in interface javax.xml.soap.Node

getParentNode

public Node getParentNode()

Specified by:

getParentNode in interface Node

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface Node

getPreviousSibling

public Node getPreviousSibling()

Specified by:

getPreviousSibling in interface Node

getTagName

public String getTagName()

Specified by:

getTagName in interface Element

getValue

public String getValue()

Specified by:

getValue in interface javax.xml.soap.Node

getVisibleNamespacePrefixes

public Iterator getVisibleNamespacePrefixes()

Specified by:

getVisibleNamespacePrefixes in interface javax.xml.soap.SOAPElement

hasAttribute

public boolean hasAttribute(String arg0)

Specified by:

hasAttribute in interface Element

hasAttributeNS

public boolean hasAttributeNS(String arg0,
                              String arg1)

Specified by:

hasAttributeNS in interface Element

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface Node

hasChildNodes

public boolean hasChildNodes()

Specified by:

hasChildNodes in interface Node

hashCode

public int hashCode()

Overrides:

hashCode in class Object

insertBefore

public Node insertBefore(Node arg0,
                         Node arg1)
                  throws DOMException

Specified by:

insertBefore in interface Node

Throws:

DOMException

isSupported

public boolean isSupported(String arg0,
                           String arg1)

Specified by:

isSupported in interface Node

normalize

public void normalize()

Specified by:

normalize in interface Node

recycleNode

public void recycleNode()

Specified by:

recycleNode in interface javax.xml.soap.Node

removeAttribute

public void removeAttribute(String arg0)
                     throws DOMException

Specified by:

removeAttribute in interface Element

Throws:

DOMException

removeAttribute

public boolean removeAttribute(javax.xml.soap.Name arg0)

Specified by:

removeAttribute in interface javax.xml.soap.SOAPElement

removeAttributeNode

public Attr removeAttributeNode(Attr arg0)
                         throws DOMException

Specified by:

removeAttributeNode in interface Element

Throws:

DOMException

removeAttributeNS

public void removeAttributeNS(String arg0,
                              String arg1)
                       throws DOMException

Specified by:

removeAttributeNS in interface Element

Throws:

DOMException

removeChild

public Node removeChild(Node arg0)
                 throws DOMException

Specified by:

removeChild in interface Node

Throws:

DOMException

removeContents

public void removeContents()

Specified by:

removeContents in interface javax.xml.soap.SOAPElement

removeNamespaceDeclaration

public boolean removeNamespaceDeclaration(String arg0)

Specified by:

removeNamespaceDeclaration in interface javax.xml.soap.SOAPElement

replaceChild

public Node replaceChild(Node arg0,
                         Node arg1)
                  throws DOMException

Specified by:

replaceChild in interface Node

Throws:

DOMException

setAttribute

public void setAttribute(String arg0,
                         String arg1)
                  throws DOMException

Specified by:

setAttribute in interface Element

Throws:

DOMException

setAttributeNode

public Attr setAttributeNode(Attr arg0)
                      throws DOMException

Specified by:

setAttributeNode in interface Element

Throws:

DOMException

setAttributeNodeNS

public Attr setAttributeNodeNS(Attr arg0)
                        throws DOMException

Specified by:

setAttributeNodeNS in interface Element

Throws:

DOMException

setAttributeNS

public void setAttributeNS(String arg0,
                           String arg1,
                           String arg2)
                    throws DOMException

Specified by:

setAttributeNS in interface Element

Throws:

DOMException

setEncodingStyle

public void setEncodingStyle(String arg0)
                      throws javax.xml.soap.SOAPException

Specified by:

setEncodingStyle in interface javax.xml.soap.SOAPElement

Throws:

javax.xml.soap.SOAPException

setNodeValue

public void setNodeValue(String arg0)
                  throws DOMException

Specified by:

setNodeValue in interface Node

Throws:

DOMException

setParentElement

public void setParentElement(javax.xml.soap.SOAPElement arg0)
                      throws javax.xml.soap.SOAPException

Specified by:

setParentElement in interface javax.xml.soap.Node

Throws:

javax.xml.soap.SOAPException

setPrefix

public void setPrefix(String arg0)
               throws DOMException

Specified by:

setPrefix in interface Node

Throws:

DOMException

setValue

public void setValue(String arg0)

Specified by:

setValue in interface javax.xml.soap.Node

toString

public String toString()

Overrides:

toString in class Object

getBaseURI

public String getBaseURI()

Specified by:

getBaseURI in interface Node

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException

Specified by:

compareDocumentPosition in interface Node

Throws:

DOMException

getTextContent

public String getTextContent()
                      throws DOMException

Specified by:

getTextContent in interface Node

Throws:

DOMException

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

Specified by:

setTextContent in interface Node

Throws:

DOMException

isSameNode

public boolean isSameNode(Node other)

Specified by:

isSameNode in interface Node

lookupPrefix

public String lookupPrefix(String namespaceURI)

Specified by:

lookupPrefix in interface Node

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)

Specified by:

isDefaultNamespace in interface Node

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)

Specified by:

lookupNamespaceURI in interface Node

isEqualNode

public boolean isEqualNode(Node arg)

Specified by:

isEqualNode in interface Node

getFeature

public Object getFeature(String feature,
                         String version)

Specified by:

getFeature in interface Node

setUserData

public Object setUserData(String key,
                          Object data,
                          UserDataHandler handler)

Specified by:

setUserData in interface Node

getUserData

public Object getUserData(String key)

Specified by:

getUserData in interface Node

setIdAttribute

public void setIdAttribute(String name,
                           boolean isId)
                    throws DOMException

Specified by:

setIdAttribute in interface Element

Throws:

DOMException

setIdAttributeNode

public void setIdAttributeNode(Attr idAttr,
                               boolean isId)
                        throws DOMException

Specified by:

setIdAttributeNode in interface Element

Throws:

DOMException

setIdAttributeNS

public void setIdAttributeNS(String namespaceURI,
                             String localName,
                             boolean isId)
                      throws DOMException

Specified by:

setIdAttributeNS in interface Element

Throws:

DOMException

getSchemaTypeInfo

public TypeInfo getSchemaTypeInfo()

Specified by:

getSchemaTypeInfo in interface Element

getAllAttributesAsQNames

public Iterator getAllAttributesAsQNames()

Specified by:

getAllAttributesAsQNames in interface javax.xml.soap.SOAPElement