Package com.sun.identity.saml2.protocol.impl

Class NewIDImpl

java.lang.Object

com.sun.identity.saml2.protocol.impl.NewIDImpl

All Implemented Interfaces:

NewID

public class NewIDImpl
extends Object
implements NewID

This class identifies the new ID entitie in an ManageNameIDRequest message.

Field Summary

Fields

Modifier and Type	Field	Description
String	elementName

Constructor Summary

Constructors

Constructor	Description
NewIDImpl(String value)	Constructor to create the NewID Object.
NewIDImpl(Element element)	Constructor to create the NewID Object.

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

Methods inherited from class java.lang.Object

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

Field Detail

elementName

public final String elementName

See Also:

Constant Field Values

Constructor Detail

NewIDImpl

public NewIDImpl(Element element)
          throws SAML2Exception

Constructor to create the NewID Object.

Parameters:

element - Document Element of NewID Object.

Throws:

SAML2Exception - if NewID cannot be created.

NewIDImpl

public NewIDImpl(String value)
          throws SAML2Exception

Constructor to create the NewID Object.

Parameters:

value - of the NewID.

Throws:

SAML2Exception - if NewID cannot be created.

Method Detail

getValue

public String getValue()

Returns the value of the NewID URI.

Specified by:

getValue in interface NewID

Returns:

value of the NewID URI.

See Also:

NewIDImpl(String)

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns a String representation of this Object.

Specified by:

toXMLString in interface NewID

Returns:

a String representation of this Object.

Throws:

SAML2Exception - if cannot convert to String.

toXMLString

public String toXMLString(boolean includeNSPrefix,
                          boolean declareNS)
                   throws SAML2Exception

Returns a String representation

Specified by:

toXMLString in interface NewID

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

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

Returns an NewEncryptedID object.

Specified by:

encrypt in interface NewID

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.