com.sun.identity.saml2.assertion

Interface NameID

All Superinterfaces:

NameIDType

All Known Implementing Classes:

NameIDImpl, NameIDImplWithoutSPNameQualifier

public interface NameID
extends NameIDType

The NameID is used in various SAML assertion constructs such as Subject and SubjectConfirmation elements, and in various protocol messages.

Method Summary

Modifier and Type	Method and Description
EncryptedID	encrypt(Key recipientPublicKey, String dataEncAlgorithm, int dataEncStrength, String recipientEntityID) Returns an EncryptedID object.

Methods inherited from interface com.sun.identity.saml2.assertion.NameIDType

getFormat, getNameQualifier, getSPNameQualifier, getSPProvidedID, getValue, isMutable, makeImmutable, setFormat, setNameQualifier, setSPNameQualifier, setSPProvidedID, setValue, toXMLString, toXMLString

Method Detail

encrypt

EncryptedID encrypt(Key recipientPublicKey,
                    String dataEncAlgorithm,
                    int dataEncStrength,
                    String recipientEntityID)
             throws SAML2Exception

Returns an EncryptedID object.

Parameters:

recipientPublicKey - Public key used to encrypt the data encryption (secret) key, it is the public key of the recipient of the XML document to be encrypted.

dataEncAlgorithm - Data encryption algorithm.

dataEncStrength - Data encryption strength.

recipientEntityID - Unique identifier of the recipient, it is used as the index to the cached secret key so that the key can be reused for the same recipient; It can be null in which case the secret key will be generated every time and will not be cached and reused. Note that the generation of a secret key is a relatively expensive operation.

Returns:

EncryptedID object

Throws:

SAML2Exception - if error occurs during the encryption process.