Package com.sun.identity.saml2.protocol

Interface NewID

All Known Implementing Classes:

NewIDImpl

public interface NewID

This interface identifies the new identifier in an ManageNameIDRequest message.

Method Summary

Modifier and Type	Method	Description
NewEncryptedID	encrypt(Key recipientPublicKey, String dataEncAlgorithm, int dataEncStrength, String recipientEntityID)	Returns an NewEncryptedID object.
String	getValue()	Returns the value of the NewID URI.
String	toXMLString()	Returns a String representation of this Object.
String	toXMLString(boolean includeNSPrefix, boolean declareNS)	Returns a String representation of this Object.

Method Detail

getValue

String getValue()

Returns the value of the NewID URI.

Returns:

value of the NewID URI.

toXMLString

String toXMLString()
            throws SAML2Exception

Returns a String representation of this Object.

Returns:

a String representation of this Object.

Throws:

SAML2Exception - if cannot convert to String.

toXMLString

String toXMLString(boolean includeNSPrefix,
                   boolean declareNS)
            throws SAML2Exception

Returns a String representation of this Object.

Parameters:

includeNSPrefix - determines whether or not the namespace qualifier is prepended to the Element when converted

declareNS - determines whether or not the namespace is declared within the Element.

Returns:

a String representation of this Object.

Throws:

SAML2Exception - if cannot convert to String.

encrypt

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

Returns an NewEncryptedID 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:

NewEncryptedID object

Throws:

SAML2Exception - if error occurs during the encryption process.