Package org.forgerock.am.saml2.profile

Class Saml2SsoResult

java.lang.Object

org.forgerock.am.saml2.profile.Saml2SsoResult

public class Saml2SsoResult
extends Object

This POJO contains information collated during SAML2 response processing.

Constructor Summary

Constructors

Constructor	Description
Saml2SsoResult(String universalId, NameID nameId, Set<PrivateKey> decryptionKeys, boolean shouldPersistNameId)	Constructor.

Method Summary

Modifier and Type	Method	Description
Set<PrivateKey>	getDecryptionKeys()	Returns the decryption keys that can be used to decrypt the attributes in the assertion.
NameID	getNameId()	Returns the NameID object from the assertion.
String	getUniversalId()	Returns the user's universal ID.
boolean	shouldPersistNameId()	Returns whether the NameID mapping should be stored in the user data store.

Methods inherited from class java.lang.Object

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

Constructor Details

Saml2SsoResult

public Saml2SsoResult(String universalId,
 NameID nameId,
 Set<PrivateKey> decryptionKeys,
 boolean shouldPersistNameId)

Constructor.

Parameters:

universalId - The user's universal ID. May be null if the account mapping was unsuccessful.

nameId - The the potentially decrypted NameID object.

decryptionKeys - The decryption keys to use when SAML2 attributes need to be decrypted.

shouldPersistNameId - Whether the account link needs to be persisted.

Method Details

getUniversalId

public String getUniversalId()

Returns the user's universal ID.

Returns:

The user's universal ID. May be null.

getNameId

public NameID getNameId()

Returns the NameID object from the assertion.

Returns:

The NameID object.

getDecryptionKeys

public Set<PrivateKey> getDecryptionKeys()

Returns the decryption keys that can be used to decrypt the attributes in the assertion.

Returns:

The decryption keys.

shouldPersistNameId

public boolean shouldPersistNameId()

Returns whether the NameID mapping should be stored in the user data store.

Returns:

Whether the NameID mapping should be stored in the user data store.