Module org.apache.santuario.xmlsec

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

Class HKDFParamsImpl

java.lang.Object

org.apache.xml.security.utils.ElementProxy

org.apache.xml.security.encryption.keys.content.derivedKey.HKDFParamsImpl

All Implemented Interfaces:

KDFParams

public class HKDFParamsImpl
extends ElementProxy
implements KDFParams

Class HKDFParamsImpl is an DOM representation of the HKDF Parameters.

Field Summary

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

baseURI, LOG

Constructor Summary

Constructors

Constructor	Description
HKDFParamsImpl(Document doc)	Constructor creates a new HKDFParamsImpl instance.
HKDFParamsImpl(Element element, String baseURI)	Constructor HKDFParamsImpl from existing XML element

Method Summary

Modifier and Type	Method	Description
String	getBaseLocalName()	Returns the localname of the Elements of the sub-class.
String	getBaseNamespace()	Returns the namespace of the Elements of the sub-class.
String	getInfo()	Returns the hex encoded Info attribute
Integer	getKeyLength()	Returns the keyLength attribute value.
String	getLocalElementValue(String elementName)
String	getPRFAlgorithm()	Returns the DigestMethod algorithm value.
String	getSalt()	Returns the Salt Element value.
void	setInfo(String info)	Sets the Info attribute
void	setKeyLength(Integer keyLength)	Sets the keyLength attribute.
void	setLocalElementValue(String value, String elementName)
void	setPRFAlgorithm(String hmacHashAlgorithm)	Sets the DigestMethod Element
void	setSalt(String salt)	Sets the Salt Element

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 Detail

HKDFParamsImpl

public HKDFParamsImpl(Document doc)

Constructor creates a new HKDFParamsImpl instance.

Parameters:

doc - the Document in which to create the DOM tree

HKDFParamsImpl

public HKDFParamsImpl(Element element,
                      String baseURI)
               throws XMLSecurityException

Constructor HKDFParamsImpl from existing XML element

Parameters:

element - the element to use as source

baseURI - the URI of the resource where the XML instance was stored

Throws:

XMLSecurityException - if the construction fails for any reason

Method Detail

setPRFAlgorithm

public void setPRFAlgorithm(String hmacHashAlgorithm)

Sets the DigestMethod Element

Parameters:

hmacHashAlgorithm - is the digest method URI value.

getPRFAlgorithm

public String getPRFAlgorithm()

Returns the DigestMethod algorithm value.

Returns:

the digest method URI value.

setInfo

public void setInfo(String info)

Sets the Info attribute

Parameters:

info - hex encoded string for the info attribute

getInfo

public String getInfo()

Returns the hex encoded Info attribute

Returns:

the info attribute value.

setKeyLength

public void setKeyLength(Integer keyLength)

Sets the keyLength attribute. If the keyLength value null, the attribute is ignored.

Parameters:

keyLength - length of the derived key in bytes.

getKeyLength

public Integer getKeyLength()

Returns the keyLength attribute value.

Returns:

the keyLength attribute value.

setSalt

public void setSalt(String salt)

Sets the Salt Element

Parameters:

salt - is base64 encoded bytearray.

getSalt

public String getSalt()

Returns the Salt Element value.

Returns:

the salt value is base64 encoded bytearray value.

getBaseLocalName

public String getBaseLocalName()

Description copied from class: ElementProxy

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.

getBaseNamespace

public String getBaseNamespace()

Description copied from class: ElementProxy

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

Specified by:

getBaseNamespace in class ElementProxy

Returns:

the namespace of the Elements of the sub-class.

setLocalElementValue

public void setLocalElementValue(String value,
                                 String elementName)

getLocalElementValue

public String getLocalElementValue(String elementName)