Package org.opensaml.xmlsec.encryption

Interface AgreementMethod

All Superinterfaces:

ElementExtensibleXMLObject, XMLObject

All Known Implementing Classes:

AgreementMethodImpl

public interface AgreementMethod
extends XMLObject, ElementExtensibleXMLObject

XMLObject representing XML Encryption, version 20021210, AgreementMethod element.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALGORITHM_ATTRIBUTE_NAME	Algorithm attribute name.
static final String	DEFAULT_ELEMENT_LOCAL_NAME	Element local name.
static final QName	DEFAULT_ELEMENT_NAME	Default element name.
static final String	TYPE_LOCAL_NAME	Local name of the XSI type.
static final QName	TYPE_NAME	QName of the XSI type.

Method Summary

Modifier and Type	Method	Description
String	getAlgorithm()	Gets the algorithm URI attribute value for this agreement method.
KANonce	getKANonce()	Get the nonce child element used to introduce variability into the generation of keying material.
OriginatorKeyInfo	getOriginatorKeyInfo()	Get the child element containing the key generation material for the originator.
RecipientKeyInfo	getRecipientKeyInfo()	Get the child element containing the key generation material for the recipient.
void	setAlgorithm(String newAlgorithm)	Sets the algorithm URI attribute value for this agreement method.
void	setKANonce(KANonce newKANonce)	Set the nonce child element used to introduce variability into the generation of keying material.
void	setOriginatorKeyInfo(OriginatorKeyInfo newOriginatorKeyInfo)	Set the child element containing the key generation material for the originator.
void	setRecipientKeyInfo(RecipientKeyInfo newRecipientKeyInfo)	Set the child element containing the key generation material for the recipient.

Methods inherited from interface org.opensaml.core.xml.ElementExtensibleXMLObject

getUnknownXMLObjects, getUnknownXMLObjects

Methods inherited from interface org.opensaml.core.xml.XMLObject

detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

Field Details

DEFAULT_ELEMENT_LOCAL_NAME

static final String DEFAULT_ELEMENT_LOCAL_NAME

Element local name.

See Also:

• Constant Field Values

DEFAULT_ELEMENT_NAME

static final QName DEFAULT_ELEMENT_NAME

Default element name.

TYPE_LOCAL_NAME

static final String TYPE_LOCAL_NAME

Local name of the XSI type.

See Also:

• Constant Field Values

TYPE_NAME

static final QName TYPE_NAME

QName of the XSI type.

ALGORITHM_ATTRIBUTE_NAME

static final String ALGORITHM_ATTRIBUTE_NAME

Algorithm attribute name.

See Also:

• Constant Field Values

Method Details

getAlgorithm

@Nullable
String getAlgorithm()

Gets the algorithm URI attribute value for this agreement method.

Returns:

the algorithm URI attribute value

setAlgorithm

void setAlgorithm(@Nullable
 String newAlgorithm)

Sets the algorithm URI attribute value for this agreement method.

Parameters:

newAlgorithm - the new algorithm URI attribute value

getKANonce

@Nullable
KANonce getKANonce()

Get the nonce child element used to introduce variability into the generation of keying material.

Returns:

the KA-Nonce child element

setKANonce

void setKANonce(@Nullable
 KANonce newKANonce)

Set the nonce child element used to introduce variability into the generation of keying material.

Parameters:

newKANonce - the new KA-Nonce child element

getOriginatorKeyInfo

@Nullable
OriginatorKeyInfo getOriginatorKeyInfo()

Get the child element containing the key generation material for the originator.

Returns:

the OriginatorKeyInfo child element

setOriginatorKeyInfo

void setOriginatorKeyInfo(@Nullable
 OriginatorKeyInfo newOriginatorKeyInfo)

Set the child element containing the key generation material for the originator.

Parameters:

newOriginatorKeyInfo - the new OriginatorKeyInfo child element

getRecipientKeyInfo

@Nullable
RecipientKeyInfo getRecipientKeyInfo()

Get the child element containing the key generation material for the recipient.

Returns:

the RecipientKeyInfo child element

setRecipientKeyInfo

void setRecipientKeyInfo(@Nullable
 RecipientKeyInfo newRecipientKeyInfo)

Set the child element containing the key generation material for the recipient.

Parameters:

newRecipientKeyInfo - the new RecipientKeyInfo child element