org.apache.xml.security.encryption.params

Class ConcatKDFParams

java.lang.Object

org.apache.xml.security.encryption.params.KeyDerivationParameters

org.apache.xml.security.encryption.params.ConcatKDFParams

public class ConcatKDFParams
extends KeyDerivationParameters

Class ConcatKDFParams is used to specify parameters for the ConcatKDF key derivation algorithm.

See Also:

XML Encryption syntax and Processing Version 1.1, 5.8.1 The ConcatKDF Key Derivation Algorithm

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConcatKDFParams.Builder The ConcatKDF key derivation algorithm parameters builder.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConcatKDFParams(int keyBitLength, String digestAlgorithm) Constructor ConcatKDFParams with specified digest algorithm

Method Summary

Modifier and Type	Method and Description
static ConcatKDFParams.Builder	createBuilder(int keyBitLength, String digestAlgorithm) Create a new ConcatKDF key derivation algorithm parameters builder.
String	getAlgorithmID()
String	getDigestAlgorithm() Method return the digest algorithm.
String	getPartyUInfo()
String	getPartyVInfo()
String	getSuppPrivInfo()
String	getSuppPubInfo()
void	setAlgorithmID(String algorithmID)
void	setDigestAlgorithm(String digestAlgorithm)
void	setPartyUInfo(String partyUInfo)
void	setPartyVInfo(String partyVInfo)
void	setSuppPrivInfo(String suppPrivInfo)
void	setSuppPubInfo(String suppPubInfo)

Methods inherited from class org.apache.xml.security.encryption.params.KeyDerivationParameters

getAlgorithm, getKeyBitLength, getKeyLength

Methods inherited from class java.lang.Object

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

Constructor Detail

ConcatKDFParams

protected ConcatKDFParams(int keyBitLength,
                          String digestAlgorithm)

Constructor ConcatKDFParams with specified digest algorithm

Parameters:

keyBitLength - the length of the derived key in bits

digestAlgorithm - the digest algorithm to use

Method Detail

getDigestAlgorithm

public String getDigestAlgorithm()

Method return the digest algorithm. In case of algorithm is not set, the "default" algorithm SHA256 digest algorithm is returned.

Returns:

the digest algorithm

setDigestAlgorithm

public void setDigestAlgorithm(String digestAlgorithm)

getAlgorithmID

public String getAlgorithmID()

setAlgorithmID

public void setAlgorithmID(String algorithmID)

getPartyUInfo

public String getPartyUInfo()

setPartyUInfo

public void setPartyUInfo(String partyUInfo)

getPartyVInfo

public String getPartyVInfo()

setPartyVInfo

public void setPartyVInfo(String partyVInfo)

getSuppPubInfo

public String getSuppPubInfo()

setSuppPubInfo

public void setSuppPubInfo(String suppPubInfo)

getSuppPrivInfo

public String getSuppPrivInfo()

setSuppPrivInfo

public void setSuppPrivInfo(String suppPrivInfo)

createBuilder

public static ConcatKDFParams.Builder createBuilder(int keyBitLength,
                                                    String digestAlgorithm)

Create a new ConcatKDF key derivation algorithm parameters builder.

Parameters:

keyBitLength - the length of the derived key in bits

digestAlgorithm - the digest algorithm to use

Returns:

a new ConcatKDF builder to configure the key derivation parameters