com.sun.identity.saml2.assertion
Interface NameID
- All Superinterfaces:
- NameIDType
- 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 |
EncryptedID |
encrypt(java.security.Key recipientPublicKey,
java.lang.String dataEncAlgorithm,
int dataEncStrength,
java.lang.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 |
encrypt
public EncryptedID encrypt(java.security.Key recipientPublicKey,
java.lang.String dataEncAlgorithm,
int dataEncStrength,
java.lang.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.
Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.