Package org.forgerock.openam.auth.node.api

Class IdentifiedIdentity

java.lang.Object

org.forgerock.openam.auth.node.api.IdentifiedIdentity

@Supported
public final class IdentifiedIdentity
extends Object

Simple class that captures the username and identityType of an identity.

Creation of an identified identity indicates the identity has been confirmed to exist.

Note that there are many ways of identifying an identity through a journey and the presence of an IdentifiedIdentity is not evidence that sufficient authentication has taken place.

Constructor Summary

Constructors

Constructor	Description
IdentifiedIdentity(String username, IdType identityType)	Create an instance of IdentifiedIdentity with the given username and identityType.

Method Summary

Modifier and Type	Method	Description
IdType	getIdentityType()	Retrieves the identityType for this IdentifiedIdentity instance.
String	getUsername()	Retrieves the username for this IdentifiedIdentity instance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

IdentifiedIdentity

@Supported
public IdentifiedIdentity(String username,
 IdType identityType)

Create an instance of IdentifiedIdentity with the given username and identityType.

Creation of an identified identity indicates the identity has been confirmed to exist.

Parameters:

username - A non-null String denoting the username of the identified identity.

identityType - A non-null String denoting the type of the identity.

Method Details

getUsername

@Supported
public String getUsername()

Retrieves the username for this IdentifiedIdentity instance.

Returns:

The username for this instance.

getIdentityType

@Supported
public IdType getIdentityType()

Retrieves the identityType for this IdentifiedIdentity instance.

Returns:

The identityType for this instance.