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:

SOAPElement, org.w3c.dom.Element, org.w3c.dom.Node

public class SecurityHeader
extends SOAPElementExtension
implements 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

SecurityHeader(SOAPElement delegateHeader)

Method Summary

SOAPElement	addAttribute(Name arg0, java.lang.String arg1)
SOAPElement	addChildElement(Name arg0)
SOAPElement	addChildElement(SOAPElement arg0)
SOAPElement	addChildElement(java.lang.String arg0)
SOAPElement	addChildElement(java.lang.String arg0, java.lang.String arg1)
SOAPElement	addChildElement(java.lang.String arg0, java.lang.String arg1, java.lang.String arg2)
SOAPElement	addNamespaceDeclaration(java.lang.String arg0, java.lang.String arg1)
SOAPElement	addTextNode(java.lang.String arg0)
org.w3c.dom.Node	appendChild(org.w3c.dom.Node arg0)
void	appendChild(SecurityHeaderBlock block)
org.w3c.dom.Node	cloneNode(boolean arg0)
short	compareDocumentPosition(org.w3c.dom.Node other)
void	detachNode()
boolean	equals(java.lang.Object obj)
java.util.Iterator	getAllAttributes()
java.util.Iterator	getAllAttributesAsQNames()
SOAPElement	getAsSoapElement()
java.lang.String	getAttribute(java.lang.String arg0)
org.w3c.dom.Attr	getAttributeNode(java.lang.String arg0)
org.w3c.dom.Attr	getAttributeNodeNS(java.lang.String arg0, java.lang.String arg1)
java.lang.String	getAttributeNS(java.lang.String arg0, java.lang.String arg1)
org.w3c.dom.NamedNodeMap	getAttributes()
java.lang.String	getAttributeValue(Name arg0)
java.lang.String	getBaseURI()
java.util.Iterator	getChildElements()
java.util.Iterator	getChildElements(Name arg0)
org.w3c.dom.NodeList	getChildNodes()
SecurityHeaderBlock	getCurrentHeaderBlock(java.lang.Class implType) Get the header block to be processed next.
SOAPElement	getCurrentHeaderBlockElement()
SOAPElement	getCurrentHeaderElement()
Name	getElementName()
org.w3c.dom.NodeList	getElementsByTagName(java.lang.String arg0)
org.w3c.dom.NodeList	getElementsByTagNameNS(java.lang.String arg0, java.lang.String arg1)
java.lang.String	getEncodingStyle()
java.lang.Object	getFeature(java.lang.String feature, java.lang.String version)
org.w3c.dom.Node	getFirstChild()
SOAPElement	getFirstChildElement()
org.w3c.dom.Node	getLastChild()
java.lang.String	getLocalName()
java.util.Iterator	getNamespacePrefixes()
java.lang.String	getNamespaceURI()
java.lang.String	getNamespaceURI(java.lang.String arg0)
org.w3c.dom.Node	getNextSibling()
SOAPElement	getNextSiblingOfTimestamp()
java.lang.String	getNodeName()
short	getNodeType()
java.lang.String	getNodeValue()
org.w3c.dom.Document	getOwnerDocument()
SOAPElement	getParentElement()
org.w3c.dom.Node	getParentNode()
java.lang.String	getPrefix()
org.w3c.dom.Node	getPreviousSibling()
java.lang.String	getRole()
org.w3c.dom.TypeInfo	getSchemaTypeInfo()
java.lang.String	getTagName()
java.lang.String	getTextContent()
java.lang.Object	getUserData(java.lang.String key)
java.lang.String	getValue()
java.util.Iterator	getVisibleNamespacePrefixes()
boolean	hasAttribute(java.lang.String arg0)
boolean	hasAttributeNS(java.lang.String arg0, java.lang.String arg1)
boolean	hasAttributes()
boolean	hasChildNodes()
int	hashCode()
org.w3c.dom.Node	insertBefore(org.w3c.dom.Node arg0, org.w3c.dom.Node arg1)
void	insertBefore(SecurityHeaderBlock block, org.w3c.dom.Node elem)
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(SOAPElement blockElement)
boolean	isDefaultNamespace(java.lang.String namespaceURI)
boolean	isEqualNode(org.w3c.dom.Node arg)
boolean	isMustUnderstand()
boolean	isSameNode(org.w3c.dom.Node other)
boolean	isSupported(java.lang.String arg0, java.lang.String arg1)
java.lang.String	lookupNamespaceURI(java.lang.String prefix)
java.lang.String	lookupPrefix(java.lang.String namespaceURI)
SOAPElement	makeUsable(SOAPElement elem)
void	normalize()
void	recycleNode()
boolean	removeAttribute(Name arg0)
void	removeAttribute(java.lang.String arg0)
org.w3c.dom.Attr	removeAttributeNode(org.w3c.dom.Attr arg0)
void	removeAttributeNS(java.lang.String arg0, java.lang.String arg1)
org.w3c.dom.Node	removeChild(org.w3c.dom.Node arg0)
void	removeContents()
boolean	removeNamespaceDeclaration(java.lang.String arg0)
org.w3c.dom.Node	replaceChild(org.w3c.dom.Node arg0, org.w3c.dom.Node arg1)
void	setAttribute(java.lang.String arg0, java.lang.String arg1)
org.w3c.dom.Attr	setAttributeNode(org.w3c.dom.Attr arg0)
org.w3c.dom.Attr	setAttributeNodeNS(org.w3c.dom.Attr arg0)
void	setAttributeNS(java.lang.String arg0, java.lang.String arg1, java.lang.String arg2)
void	setCurrentHeaderElement(SOAPElement currentElement)
void	setEncodingStyle(java.lang.String arg0)
void	setIdAttribute(java.lang.String name, boolean isId)
void	setIdAttributeNode(org.w3c.dom.Attr idAttr, boolean isId)
void	setIdAttributeNS(java.lang.String namespaceURI, java.lang.String localName, boolean isId)
void	setMustUnderstand(boolean mustUnderstand)
void	setNodeValue(java.lang.String arg0)
void	setParentElement(SOAPElement arg0)
void	setPrefix(java.lang.String arg0)
void	setRole(java.lang.String roleURI)
void	setTextContent(java.lang.String textContent)
java.lang.Object	setUserData(java.lang.String key, java.lang.Object data, org.w3c.dom.UserDataHandler handler)
void	setValue(java.lang.String arg0)
java.lang.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(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,
                         org.w3c.dom.Node elem)
                  throws XWSSecurityException

Throws:

XWSSecurityException

appendChild

public void appendChild(SecurityHeaderBlock block)
                 throws XWSSecurityException

Throws:

XWSSecurityException

insertHeaderBlockElement

public void insertHeaderBlockElement(SOAPElement blockElement)
                              throws XWSSecurityException

Throws:

XWSSecurityException

getCurrentHeaderBlock

public SecurityHeaderBlock getCurrentHeaderBlock(java.lang.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 SOAPElement getCurrentHeaderBlockElement()

setCurrentHeaderElement

public void setCurrentHeaderElement(SOAPElement currentElement)
                             throws XWSSecurityException

Throws:

XWSSecurityException

getCurrentHeaderElement

public SOAPElement getCurrentHeaderElement()

updateTopMostSoapElement

public void updateTopMostSoapElement()

getFirstChildElement

public SOAPElement getFirstChildElement()

getNextSiblingOfTimestamp

public SOAPElement getNextSiblingOfTimestamp()

getAsSoapElement

public SOAPElement getAsSoapElement()

setRole

public void setRole(java.lang.String roleURI)

getRole

public java.lang.String getRole()

setMustUnderstand

public void setMustUnderstand(boolean mustUnderstand)

isMustUnderstand

public boolean isMustUnderstand()

addAttribute

public SOAPElement addAttribute(Name arg0,
                                java.lang.String arg1)
                         throws SOAPException

Specified by:

addAttribute in interface SOAPElement

Throws:

SOAPException

addChildElement

public SOAPElement addChildElement(java.lang.String arg0)
                            throws SOAPException

Specified by:

addChildElement in interface SOAPElement

Throws:

SOAPException

addChildElement

public SOAPElement addChildElement(java.lang.String arg0,
                                   java.lang.String arg1)
                            throws SOAPException

Specified by:

addChildElement in interface SOAPElement

Throws:

SOAPException

addChildElement

public SOAPElement addChildElement(java.lang.String arg0,
                                   java.lang.String arg1,
                                   java.lang.String arg2)
                            throws SOAPException

Specified by:

addChildElement in interface SOAPElement

Throws:

SOAPException

addChildElement

public SOAPElement addChildElement(Name arg0)
                            throws SOAPException

Specified by:

addChildElement in interface SOAPElement

Throws:

SOAPException

addChildElement

public SOAPElement addChildElement(SOAPElement arg0)
                            throws SOAPException

Specified by:

addChildElement in interface SOAPElement

Throws:

SOAPException

addNamespaceDeclaration

public SOAPElement addNamespaceDeclaration(java.lang.String arg0,
                                           java.lang.String arg1)
                                    throws SOAPException

Specified by:

addNamespaceDeclaration in interface SOAPElement

Throws:

SOAPException

addTextNode

public SOAPElement addTextNode(java.lang.String arg0)
                        throws SOAPException

Specified by:

addTextNode in interface SOAPElement

Throws:

SOAPException

appendChild

public org.w3c.dom.Node appendChild(org.w3c.dom.Node arg0)
                             throws org.w3c.dom.DOMException

Specified by:

appendChild in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

makeUsable

public SOAPElement makeUsable(SOAPElement elem)
                       throws XWSSecurityException

Throws:

XWSSecurityException

cloneNode

public org.w3c.dom.Node cloneNode(boolean arg0)

Specified by:

cloneNode in interface org.w3c.dom.Node

detachNode

public void detachNode()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getAllAttributes

public java.util.Iterator getAllAttributes()

Specified by:

getAllAttributes in interface SOAPElement

getAttribute

public java.lang.String getAttribute(java.lang.String arg0)

Specified by:

getAttribute in interface org.w3c.dom.Element

getAttributeNode

public org.w3c.dom.Attr getAttributeNode(java.lang.String arg0)

Specified by:

getAttributeNode in interface org.w3c.dom.Element

getAttributeNodeNS

public org.w3c.dom.Attr getAttributeNodeNS(java.lang.String arg0,
                                           java.lang.String arg1)

Specified by:

getAttributeNodeNS in interface org.w3c.dom.Element

getAttributeNS

public java.lang.String getAttributeNS(java.lang.String arg0,
                                       java.lang.String arg1)

Specified by:

getAttributeNS in interface org.w3c.dom.Element

getAttributes

public org.w3c.dom.NamedNodeMap getAttributes()

Specified by:

getAttributes in interface org.w3c.dom.Node

getAttributeValue

public java.lang.String getAttributeValue(Name arg0)

Specified by:

getAttributeValue in interface SOAPElement

getChildElements

public java.util.Iterator getChildElements()

Specified by:

getChildElements in interface SOAPElement

getChildElements

public java.util.Iterator getChildElements(Name arg0)

Specified by:

getChildElements in interface SOAPElement

getChildNodes

public org.w3c.dom.NodeList getChildNodes()

Specified by:

getChildNodes in interface org.w3c.dom.Node

getElementName

public Name getElementName()

Specified by:

getElementName in interface SOAPElement

getElementsByTagName

public org.w3c.dom.NodeList getElementsByTagName(java.lang.String arg0)

Specified by:

getElementsByTagName in interface org.w3c.dom.Element

getElementsByTagNameNS

public org.w3c.dom.NodeList getElementsByTagNameNS(java.lang.String arg0,
                                                   java.lang.String arg1)

Specified by:

getElementsByTagNameNS in interface org.w3c.dom.Element

getEncodingStyle

public java.lang.String getEncodingStyle()

Specified by:

getEncodingStyle in interface SOAPElement

getFirstChild

public org.w3c.dom.Node getFirstChild()

Specified by:

getFirstChild in interface org.w3c.dom.Node

getLastChild

public org.w3c.dom.Node getLastChild()

Specified by:

getLastChild in interface org.w3c.dom.Node

getLocalName

public java.lang.String getLocalName()

Specified by:

getLocalName in interface org.w3c.dom.Node

getNamespacePrefixes

public java.util.Iterator getNamespacePrefixes()

Specified by:

getNamespacePrefixes in interface SOAPElement

getNamespaceURI

public java.lang.String getNamespaceURI()

Specified by:

getNamespaceURI in interface org.w3c.dom.Node

getNamespaceURI

public java.lang.String getNamespaceURI(java.lang.String arg0)

Specified by:

getNamespaceURI in interface SOAPElement

getNextSibling

public org.w3c.dom.Node getNextSibling()

Specified by:

getNextSibling in interface org.w3c.dom.Node

getNodeName

public java.lang.String getNodeName()

Specified by:

getNodeName in interface org.w3c.dom.Node

getNodeType

public short getNodeType()

Specified by:

getNodeType in interface org.w3c.dom.Node

getNodeValue

public java.lang.String getNodeValue()
                              throws org.w3c.dom.DOMException

Specified by:

getNodeValue in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

getOwnerDocument

public org.w3c.dom.Document getOwnerDocument()

Specified by:

getOwnerDocument in interface org.w3c.dom.Node

getParentElement

public SOAPElement getParentElement()

getParentNode

public org.w3c.dom.Node getParentNode()

Specified by:

getParentNode in interface org.w3c.dom.Node

getPrefix

public java.lang.String getPrefix()

Specified by:

getPrefix in interface org.w3c.dom.Node

getPreviousSibling

public org.w3c.dom.Node getPreviousSibling()

Specified by:

getPreviousSibling in interface org.w3c.dom.Node

getTagName

public java.lang.String getTagName()

Specified by:

getTagName in interface org.w3c.dom.Element

getValue

public java.lang.String getValue()

getVisibleNamespacePrefixes

public java.util.Iterator getVisibleNamespacePrefixes()

Specified by:

getVisibleNamespacePrefixes in interface SOAPElement

hasAttribute

public boolean hasAttribute(java.lang.String arg0)

Specified by:

hasAttribute in interface org.w3c.dom.Element

hasAttributeNS

public boolean hasAttributeNS(java.lang.String arg0,
                              java.lang.String arg1)

Specified by:

hasAttributeNS in interface org.w3c.dom.Element

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface org.w3c.dom.Node

hasChildNodes

public boolean hasChildNodes()

Specified by:

hasChildNodes in interface org.w3c.dom.Node

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

insertBefore

public org.w3c.dom.Node insertBefore(org.w3c.dom.Node arg0,
                                     org.w3c.dom.Node arg1)
                              throws org.w3c.dom.DOMException

Specified by:

insertBefore in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

isSupported

public boolean isSupported(java.lang.String arg0,
                           java.lang.String arg1)

Specified by:

isSupported in interface org.w3c.dom.Node

normalize

public void normalize()

Specified by:

normalize in interface org.w3c.dom.Node

recycleNode

public void recycleNode()

removeAttribute

public void removeAttribute(java.lang.String arg0)
                     throws org.w3c.dom.DOMException

Specified by:

removeAttribute in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

removeAttribute

public boolean removeAttribute(Name arg0)

Specified by:

removeAttribute in interface SOAPElement

removeAttributeNode

public org.w3c.dom.Attr removeAttributeNode(org.w3c.dom.Attr arg0)
                                     throws org.w3c.dom.DOMException

Specified by:

removeAttributeNode in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

removeAttributeNS

public void removeAttributeNS(java.lang.String arg0,
                              java.lang.String arg1)
                       throws org.w3c.dom.DOMException

Specified by:

removeAttributeNS in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

removeChild

public org.w3c.dom.Node removeChild(org.w3c.dom.Node arg0)
                             throws org.w3c.dom.DOMException

Specified by:

removeChild in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

removeContents

public void removeContents()

Specified by:

removeContents in interface SOAPElement

removeNamespaceDeclaration

public boolean removeNamespaceDeclaration(java.lang.String arg0)

Specified by:

removeNamespaceDeclaration in interface SOAPElement

replaceChild

public org.w3c.dom.Node replaceChild(org.w3c.dom.Node arg0,
                                     org.w3c.dom.Node arg1)
                              throws org.w3c.dom.DOMException

Specified by:

replaceChild in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

setAttribute

public void setAttribute(java.lang.String arg0,
                         java.lang.String arg1)
                  throws org.w3c.dom.DOMException

Specified by:

setAttribute in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

setAttributeNode

public org.w3c.dom.Attr setAttributeNode(org.w3c.dom.Attr arg0)
                                  throws org.w3c.dom.DOMException

Specified by:

setAttributeNode in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

setAttributeNodeNS

public org.w3c.dom.Attr setAttributeNodeNS(org.w3c.dom.Attr arg0)
                                    throws org.w3c.dom.DOMException

Specified by:

setAttributeNodeNS in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

setAttributeNS

public void setAttributeNS(java.lang.String arg0,
                           java.lang.String arg1,
                           java.lang.String arg2)
                    throws org.w3c.dom.DOMException

Specified by:

setAttributeNS in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

setEncodingStyle

public void setEncodingStyle(java.lang.String arg0)
                      throws SOAPException

Specified by:

setEncodingStyle in interface SOAPElement

Throws:

SOAPException

setNodeValue

public void setNodeValue(java.lang.String arg0)
                  throws org.w3c.dom.DOMException

Specified by:

setNodeValue in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

setParentElement

public void setParentElement(SOAPElement arg0)
                      throws SOAPException

Throws:

SOAPException

setPrefix

public void setPrefix(java.lang.String arg0)
               throws org.w3c.dom.DOMException

Specified by:

setPrefix in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

setValue

public void setValue(java.lang.String arg0)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getBaseURI

public java.lang.String getBaseURI()

Specified by:

getBaseURI in interface org.w3c.dom.Node

compareDocumentPosition

public short compareDocumentPosition(org.w3c.dom.Node other)
                              throws org.w3c.dom.DOMException

Specified by:

compareDocumentPosition in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

getTextContent

public java.lang.String getTextContent()
                                throws org.w3c.dom.DOMException

Specified by:

getTextContent in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

setTextContent

public void setTextContent(java.lang.String textContent)
                    throws org.w3c.dom.DOMException

Specified by:

setTextContent in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

isSameNode

public boolean isSameNode(org.w3c.dom.Node other)

Specified by:

isSameNode in interface org.w3c.dom.Node

lookupPrefix

public java.lang.String lookupPrefix(java.lang.String namespaceURI)

Specified by:

lookupPrefix in interface org.w3c.dom.Node

isDefaultNamespace

public boolean isDefaultNamespace(java.lang.String namespaceURI)

Specified by:

isDefaultNamespace in interface org.w3c.dom.Node

lookupNamespaceURI

public java.lang.String lookupNamespaceURI(java.lang.String prefix)

Specified by:

lookupNamespaceURI in interface org.w3c.dom.Node

isEqualNode

public boolean isEqualNode(org.w3c.dom.Node arg)

Specified by:

isEqualNode in interface org.w3c.dom.Node

getFeature

public java.lang.Object getFeature(java.lang.String feature,
                                   java.lang.String version)

Specified by:

getFeature in interface org.w3c.dom.Node

setUserData

public java.lang.Object setUserData(java.lang.String key,
                                    java.lang.Object data,
                                    org.w3c.dom.UserDataHandler handler)

Specified by:

setUserData in interface org.w3c.dom.Node

getUserData

public java.lang.Object getUserData(java.lang.String key)

Specified by:

getUserData in interface org.w3c.dom.Node

setIdAttribute

public void setIdAttribute(java.lang.String name,
                           boolean isId)
                    throws org.w3c.dom.DOMException

Specified by:

setIdAttribute in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

setIdAttributeNode

public void setIdAttributeNode(org.w3c.dom.Attr idAttr,
                               boolean isId)
                        throws org.w3c.dom.DOMException

Specified by:

setIdAttributeNode in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

setIdAttributeNS

public void setIdAttributeNS(java.lang.String namespaceURI,
                             java.lang.String localName,
                             boolean isId)
                      throws org.w3c.dom.DOMException

Specified by:

setIdAttributeNS in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

getSchemaTypeInfo

public org.w3c.dom.TypeInfo getSchemaTypeInfo()

Specified by:

getSchemaTypeInfo in interface org.w3c.dom.Element

getAllAttributesAsQNames

public java.util.Iterator getAllAttributesAsQNames()

Specified by:

getAllAttributesAsQNames in interface SOAPElement