Module org.apache.santuario.xmlsec

Package org.apache.xml.security.keys.content

Class KeyValue

java.lang.Object

org.apache.xml.security.utils.ElementProxy

org.apache.xml.security.utils.SignatureElementProxy

org.apache.xml.security.keys.content.KeyValue

All Implemented Interfaces:

KeyInfoContent

public class KeyValue
extends SignatureElementProxy
implements KeyInfoContent

The KeyValue element contains a single public key that may be useful in validating the signature. Structured formats for defining DSA (REQUIRED) and RSA (RECOMMENDED) public keys are defined in Signature Algorithms (section 6.4). The KeyValue element may include externally defined public keys values represented as PCDATA or element types from an external namespace.

Field Summary

Fields inherited from class org.apache.xml.security.utils.ElementProxy

baseURI, LOG

Constructor Summary

Constructors

Constructor	Description
KeyValue(Document doc, PublicKey pk)	Constructor KeyValue
KeyValue(Document doc, DSAKeyValue dsaKeyValue)	Constructor KeyValue
KeyValue(Document doc, RSAKeyValue rsaKeyValue)	Constructor KeyValue
KeyValue(Document doc, Element unknownKeyValue)	Constructor KeyValue
KeyValue(Element element, String baseURI)	Constructor KeyValue

Method Summary

Modifier and Type	Method	Description
String	getBaseLocalName()	Returns the localname of the Elements of the sub-class.
PublicKey	getPublicKey()	Method getPublicKey
static boolean	isSupportedKeyType(PublicKey publicKey)	Verifies that the XML KeyValue encoding is supported for the given key type.

Methods inherited from class org.apache.xml.security.utils.SignatureElementProxy

getBaseNamespace

Methods inherited from class org.apache.xml.security.utils.ElementProxy

addBase64Element, addBase64Text, addBigIntegerElement, addReturnToSelf, addText, addTextElement, appendOther, appendSelf, appendSelf, createElementForFamily, createElementForFamilyLocal, createText, getBaseURI, getBigIntegerFromChildElement, getBytesFromTextChild, getDefaultPrefix, getDocument, getElement, getElementPlusReturns, getFirstChild, getLocalAttribute, getTextFromChildElement, getTextFromTextChild, length, registerDefaultPrefixes, setDefaultPrefix, setDocument, setElement, setElement, setLocalAttribute, setLocalIdAttribute, setXPathNamespaceContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

KeyValue

public KeyValue(Document doc,
 DSAKeyValue dsaKeyValue)

Constructor KeyValue

Parameters:

doc -

dsaKeyValue -

KeyValue

public KeyValue(Document doc,
 RSAKeyValue rsaKeyValue)

Constructor KeyValue

Parameters:

doc -

rsaKeyValue -

KeyValue

public KeyValue(Document doc,
 Element unknownKeyValue)

Constructor KeyValue

Parameters:

doc -

unknownKeyValue -

KeyValue

public KeyValue(Document doc,
 PublicKey pk)

Constructor KeyValue

Parameters:

doc -

pk -

KeyValue

public KeyValue(Element element,
 String baseURI)
         throws XMLSecurityException

Constructor KeyValue

Parameters:

element -

baseURI -

Throws:

XMLSecurityException

Method Details

isSupportedKeyType

public static boolean isSupportedKeyType(PublicKey publicKey)

Verifies that the XML KeyValue encoding is supported for the given key type. If the encoding is supported, it returns true else false.

Returns:

true if the public key has a KeyValue encoding, false otherwise.

getPublicKey

public PublicKey getPublicKey()
                       throws XMLSecurityException

Method getPublicKey

Returns:

the public key

Throws:

XMLSecurityException

getBaseLocalName

public String getBaseLocalName()

Returns the localname of the Elements of the sub-class.

Specified by:

getBaseLocalName in class ElementProxy

Returns:

the localname of the Elements of the sub-class.