com.sun.xml.wss.core

Class KeyInfoHeaderBlock

java.lang.Object

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

com.sun.xml.wss.impl.misc.SecurityHeaderBlockImpl

com.sun.xml.wss.core.KeyInfoHeaderBlock

All Implemented Interfaces:

SecurityHeaderBlock, SOAPElement, Element, Node

public class KeyInfoHeaderBlock
extends SecurityHeaderBlockImpl

Corresponds to the schema representation for a KeyInfo.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SignatureSpecNS
static String	SignatureSpecNSprefix
static String	TAG_KEYINFO

Fields inherited from class com.sun.xml.wss.impl.misc.SecurityHeaderBlockImpl

delegateElement

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 and Description
KeyInfoHeaderBlock(Document ownerDoc) constructor that creates an empty KeyInfo
KeyInfoHeaderBlock(org.apache.xml.security.keys.KeyInfo keyinfo) constructor that takes Apache KeyInfo
KeyInfoHeaderBlock(SOAPElement element) parse and create the KeyInfo element

Method Summary

Modifier and Type	Method and Description
void	addBinarySecret(SOAPElement binarySecret) Method addBinarySecret
void	addDSAKeyValue(SOAPElement dsakeyvalue) Method add
void	addEncryptedKey(EncryptedKeyToken reference) Method addEncryptedKey
void	addKeyName(SOAPElement keyname) Method add.
void	addKeyName(String keynameString) Method addKeyName.
void	addKeyValue(PublicKey pk) Method addKeyValue
void	addKeyValue(SOAPElement keyvalue) Method addKeyValue
void	addMgmtData(SOAPElement mgmtdata) Method add
void	addMgmtData(String mgmtdata) Method addMgmtData
void	addPGPData(SOAPElement pgpdata) Method addPGPData
void	addRetrievalMethod(SOAPElement retrievalmethod) Method addRetrievalMethod
void	addRetrievalMethod(String URI, org.apache.xml.security.transforms.Transforms transforms, String type) Method addRetrievalMethod
void	addRSAKeyValue(SOAPElement rsakeyvalue) Method add
void	addSecurityTokenReference(SecurityTokenReference reference) Method addSecurityTokenReference
void	addSPKIData(SOAPElement spkidata) Method add
void	addUnknownElement(SOAPElement element) Method addUnknownElement
void	addUnknownKeyValue(SOAPElement unknownKeyValueElement) Method addKeyValue
void	addX509Data(SOAPElement x509data) Method addX509Data
void	addX509Data(org.apache.xml.security.keys.content.X509Data x509Data)
int	binarySecretCount() Method binarySecretCount
boolean	containsBinarySecret() Method containsBinarySecret
boolean	containsEncryptedKeyToken() Method containsEncryptedKeyToken
boolean	containsKeyName() Method containsKeyName
boolean	containsKeyValue() Method containsKeyValue
boolean	containsMgmtData() Method containsMgmtData
boolean	containsPGPData() Method containsPGPData
boolean	containsRetrievalMethod() Method containsRetrievalMethod
boolean	containsSecurityTokenReference() Method containsSecurityTokenReference
boolean	containsSPKIData() Method containsSPKIData
boolean	containsUnknownElement() Method containsUnknownElement
boolean	containsX509Data() Method containsX509Data
int	encryptedKeyTokenCount() Method encryptedKeyTokenCount
static SecurityHeaderBlock	fromSoapElement(SOAPElement element)
SOAPElement	getAsSoapElement() Method to return the KeyInfo as a SOAPElement.
BinarySecret	getBinarySecret(int index)
EncryptedKeyToken	getEncryptedKey(int index) Method getEncryptedKey
String	getId() Method getId
org.apache.xml.security.keys.KeyInfo	getKeyInfo() Method getKeyInfo
SOAPElement	getKeyName(int index) Method getKeyName
String	getKeyNameString(int index) Method getKeyNameString
org.apache.xml.security.keys.content.KeyValue	getKeyValue(int index) Method getKeyValue
SOAPElement	getKeyValueElement(int index) Method getKeyValueElement
SOAPElement	getMgmtData(int index) Method getMgmtData
SOAPElement	getPGPData(int index) Method getPGPData
SOAPElement	getRetrievalMethod(int index) Method getRetrievalMethod
SecurityTokenReference	getSecurityTokenReference(int index) Method getSecurityTokenReference
SOAPElement	getSPKIData(int index) Method getSPKIData
SOAPElement	getUnknownElement(int index) Method getUnknownElement
org.apache.xml.security.keys.content.X509Data	getX509Data(int index) Method getX509Data
SOAPElement	getX509DataElement(int index) Method getX509DataElement
int	keyNameCount() Method keyNameCount
int	keyValueCount() Method keyValueCount
int	mgmtDataCount() Method mgmtDataCount
int	pgpDataCount() Method pgpDataCount
int	retrievalMethodCount() Method retrievalMethodCount
void	saveChanges() This method should be called when changes are made inside an object through its reference obtained from any of the get methods of this class.
int	securityTokenReferenceCount() Method securityTokenReferenceCount
void	setBaseURI(String uri) Method setBaseURI : BaseURI accepted by Apache KeyInfo Ctor
void	setDocument(Document doc) setDocument
void	setId(String id) Method setId
int	spkiDataCount() Method spkiDataCount
int	unknownElementCount() Method unknownElementCount
int	x509DataCount() Method x509DataCount

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

addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, appendChild, cloneNode, compareDocumentPosition, detachNode, equals, fromSoapElement, getAllAttributes, getAllAttributesAsQNames, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getBaseURI, getChildElements, getChildElements, getChildNodes, getElementName, getElementsByTagName, getElementsByTagNameNS, getEncodingStyle, getFeature, getFirstChild, getLastChild, getLocalName, getNamespacePrefixes, getNamespaceURI, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPreviousSibling, getSchemaTypeInfo, getSoapFactory, getTagName, getTextContent, getUserData, getValue, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, hasAttributes, hasChildNodes, insertBefore, isBSP, isBSP, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, recycleNode, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, removeContents, removeNamespaceDeclaration, replaceChild, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setEncodingStyle, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setNodeValue, setParentElement, setPrefix, setSOAPElement, setTextContent, setUserData, setValue, setWsuIdAttr

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, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.xml.soap.SOAPElement

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

Field Detail

SignatureSpecNS

public static final String SignatureSpecNS

See Also:

Constant Field Values

SignatureSpecNSprefix

public static final String SignatureSpecNSprefix

See Also:

Constant Field Values

TAG_KEYINFO

public static final String TAG_KEYINFO

See Also:

Constant Field Values

Constructor Detail

KeyInfoHeaderBlock

public KeyInfoHeaderBlock(Document ownerDoc)
                   throws XWSSecurityException

constructor that creates an empty KeyInfo

Parameters:

ownerDoc - the OwnerDocument of the KeyInfo

Throws:

XWSSecurityException

KeyInfoHeaderBlock

public KeyInfoHeaderBlock(org.apache.xml.security.keys.KeyInfo keyinfo)
                   throws XWSSecurityException

constructor that takes Apache KeyInfo

Parameters:

keyinfo - the KeyInfo from XML DSIG

Throws:

XWSSecurityException

KeyInfoHeaderBlock

public KeyInfoHeaderBlock(SOAPElement element)
                   throws XWSSecurityException

parse and create the KeyInfo element

Parameters:

element - the KeyInfo element NOTE : this constructor assumes a fully initialized XML KeyInfo No additions are allowed on the keyinfo, only we can get existing values. For example addkeyName() will have no impact on the KeyInfo will not append a KeyName child to the KeyInfo.

Throws:

XWSSecurityException

Method Detail

addKeyName

public void addKeyName(String keynameString)

Method addKeyName.

Parameters:

keynameString -

addBinarySecret

public void addBinarySecret(SOAPElement binarySecret)

Method addBinarySecret

Parameters:

binarySecret -

addKeyName

public void addKeyName(SOAPElement keyname)
                throws XWSSecurityException

Method add.

Parameters:

keyname -

Throws:

XWSSecurityException

addKeyValue

public void addKeyValue(PublicKey pk)

Method addKeyValue

Parameters:

pk -

addUnknownKeyValue

public void addUnknownKeyValue(SOAPElement unknownKeyValueElement)

Method addKeyValue

Parameters:

unknownKeyValueElement -

addDSAKeyValue

public void addDSAKeyValue(SOAPElement dsakeyvalue)
                    throws XWSSecurityException

Method add

Parameters:

dsakeyvalue -

Throws:

XWSSecurityException

addRSAKeyValue

public void addRSAKeyValue(SOAPElement rsakeyvalue)
                    throws XWSSecurityException

Method add

Parameters:

rsakeyvalue -

Throws:

XWSSecurityException

addKeyValue

public void addKeyValue(SOAPElement keyvalue)
                 throws XWSSecurityException

Method addKeyValue

Parameters:

keyvalue -

Throws:

XWSSecurityException

addMgmtData

public void addMgmtData(String mgmtdata)

Method addMgmtData

Parameters:

mgmtdata -

addMgmtData

public void addMgmtData(SOAPElement mgmtdata)
                 throws XWSSecurityException

Method add

Parameters:

mgmtdata -

Throws:

XWSSecurityException

addPGPData

public void addPGPData(SOAPElement pgpdata)
                throws XWSSecurityException

Method addPGPData

Parameters:

pgpdata -

Throws:

XWSSecurityException

addRetrievalMethod

public void addRetrievalMethod(String URI,
                               org.apache.xml.security.transforms.Transforms transforms,
                               String type)

Method addRetrievalMethod

Parameters:

URI -

transforms -

type -

addRetrievalMethod

public void addRetrievalMethod(SOAPElement retrievalmethod)
                        throws XWSSecurityException

Method addRetrievalMethod

Parameters:

retrievalmethod -

Throws:

XWSSecurityException

addSPKIData

public void addSPKIData(SOAPElement spkidata)
                 throws XWSSecurityException

Method add

Parameters:

spkidata -

Throws:

XWSSecurityException

addX509Data

public void addX509Data(SOAPElement x509data)
                 throws XWSSecurityException

Method addX509Data

Parameters:

x509data -

Throws:

XWSSecurityException

addUnknownElement

public void addUnknownElement(SOAPElement element)

Method addUnknownElement

Parameters:

element -

keyNameCount

public int keyNameCount()

Method keyNameCount

keyValueCount

public int keyValueCount()

Method keyValueCount

mgmtDataCount

public int mgmtDataCount()

Method mgmtDataCount

pgpDataCount

public int pgpDataCount()

Method pgpDataCount

retrievalMethodCount

public int retrievalMethodCount()

Method retrievalMethodCount

spkiDataCount

public int spkiDataCount()

Method spkiDataCount

x509DataCount

public int x509DataCount()

Method x509DataCount

unknownElementCount

public int unknownElementCount()

Method unknownElementCount

getKeyName

public SOAPElement getKeyName(int index)
                       throws XWSSecurityException

Method getKeyName

Parameters:

index - 0 is the lowest index

Throws:

XWSSecurityException

getKeyNameString

public String getKeyNameString(int index)
                        throws XWSSecurityException

Method getKeyNameString

Parameters:

index - 0 is the lowest index

Throws:

XWSSecurityException

getKeyValueElement

public SOAPElement getKeyValueElement(int index)
                               throws XWSSecurityException

Method getKeyValueElement

Parameters:

index - 0 is the lowest index

Throws:

XWSSecurityException

getKeyValue

public org.apache.xml.security.keys.content.KeyValue getKeyValue(int index)
                                                          throws XWSSecurityException

Method getKeyValue

Parameters:

index - 0 is the lowest index

Throws:

XWSSecurityException

getMgmtData

public SOAPElement getMgmtData(int index)
                        throws XWSSecurityException

Method getMgmtData

Parameters:

index - 0 is the lowest index

Throws:

XWSSecurityException

getPGPData

public SOAPElement getPGPData(int index)
                       throws XWSSecurityException

Method getPGPData

Parameters:

index - 0 is the lowest index

Throws:

XWSSecurityException

getRetrievalMethod

public SOAPElement getRetrievalMethod(int index)
                               throws XWSSecurityException

Method getRetrievalMethod

Parameters:

index - 0 is the lowest index

Throws:

XWSSecurityException

getSPKIData

public SOAPElement getSPKIData(int index)
                        throws XWSSecurityException

Method getSPKIData

Parameters:

index - 0 is the lowest index

Throws:

XWSSecurityException

getX509DataElement

public SOAPElement getX509DataElement(int index)
                               throws XWSSecurityException

Method getX509DataElement

Parameters:

index - 0 is the lowest index

Throws:

XWSSecurityException

getX509Data

public org.apache.xml.security.keys.content.X509Data getX509Data(int index)
                                                          throws XWSSecurityException

Method getX509Data

Parameters:

index - 0 is the lowest index

Throws:

XWSSecurityException

getUnknownElement

public SOAPElement getUnknownElement(int index)
                              throws XWSSecurityException

Method getUnknownElement

Parameters:

index - 0 is the lowest index

Throws:

XWSSecurityException

containsKeyName

public boolean containsKeyName()

Method containsKeyName

containsKeyValue

public boolean containsKeyValue()

Method containsKeyValue

containsMgmtData

public boolean containsMgmtData()

Method containsMgmtData

containsPGPData

public boolean containsPGPData()

Method containsPGPData

containsRetrievalMethod

public boolean containsRetrievalMethod()

Method containsRetrievalMethod

containsSPKIData

public boolean containsSPKIData()

Method containsSPKIData

containsUnknownElement

public boolean containsUnknownElement()

Method containsUnknownElement

containsX509Data

public boolean containsX509Data()

Method containsX509Data

addSecurityTokenReference

public void addSecurityTokenReference(SecurityTokenReference reference)
                               throws XWSSecurityException

Method addSecurityTokenReference

Parameters:

reference -

Throws:

XWSSecurityException

getSecurityTokenReference

public SecurityTokenReference getSecurityTokenReference(int index)
                                                 throws XWSSecurityException

Method getSecurityTokenReference

Parameters:

index -

Returns:

the index^th token reference element from the KeyInfo 0 is the lowest index.

Throws:

XWSSecurityException

securityTokenReferenceCount

public int securityTokenReferenceCount()

Method securityTokenReferenceCount

Returns:

the count of security token references

containsSecurityTokenReference

public boolean containsSecurityTokenReference()

Method containsSecurityTokenReference

Returns:

true if this KeyInfo contains wsse:SecurityTokenReference's

addEncryptedKey

public void addEncryptedKey(EncryptedKeyToken reference)
                     throws XWSSecurityException

Method addEncryptedKey

Parameters:

reference -

Throws:

XWSSecurityException

getEncryptedKey

public EncryptedKeyToken getEncryptedKey(int index)
                                  throws XWSSecurityException

Method getEncryptedKey

Parameters:

index -

Returns:

the index^th token reference element from the KeyInfo 0 is the lowest index.

Throws:

XWSSecurityException

encryptedKeyTokenCount

public int encryptedKeyTokenCount()

Method encryptedKeyTokenCount

Returns:

the count of encrypted key token references

containsEncryptedKeyToken

public boolean containsEncryptedKeyToken()

Method containsEncryptedKeyToken

Returns:

true if this KeyInfo contains wsse:SecurityTokenReference's

getBinarySecret

public BinarySecret getBinarySecret(int index)
                             throws XWSSecurityException

Throws:

XWSSecurityException

binarySecretCount

public int binarySecretCount()

Method binarySecretCount

Returns:

the count of binarySecret tokens

containsBinarySecret

public boolean containsBinarySecret()

Method containsBinarySecret

Returns:

true if this KeyInfo contains BinarySecret

setId

public void setId(String id)

Method setId

getId

public String getId()

Method getId

Specified by:

getId in interface SecurityHeaderBlock

Overrides:

getId in class SecurityHeaderBlockImpl

Returns:

the id

getKeyInfo

public final org.apache.xml.security.keys.KeyInfo getKeyInfo()

Method getKeyInfo

Returns:

the XML DSIG KeyInfo which is wrapped by this class

setBaseURI

public void setBaseURI(String uri)

Method setBaseURI : BaseURI accepted by Apache KeyInfo Ctor

Parameters:

uri - Base URI to be used as context for all relative URIs.

getAsSoapElement

public SOAPElement getAsSoapElement()
                             throws XWSSecurityException

Method to return the KeyInfo as a SOAPElement.

Specified by:

getAsSoapElement in interface SecurityHeaderBlock

Overrides:

getAsSoapElement in class SecurityHeaderBlockImpl

Returns:

SOAPElement

Throws:

XWSSecurityException - If owner soap document is not set.

See Also:

setDocument(Document)

setDocument

public void setDocument(Document doc)

setDocument

Parameters:

doc - The owner Document of this KeyInfo

saveChanges

public void saveChanges()

This method should be called when changes are made inside an object through its reference obtained from any of the get methods of this class. As an example, if getKeyInfo() call is made and then changes are made inside the keyInfo, this method should be called to reflect changes when getAsSoapElement() is called finally.

fromSoapElement

public static SecurityHeaderBlock fromSoapElement(SOAPElement element)
                                           throws XWSSecurityException

Throws:

XWSSecurityException

addX509Data

public void addX509Data(org.apache.xml.security.keys.content.X509Data x509Data)
                 throws XWSSecurityException

Throws:

XWSSecurityException