com.ibm.mfp.server.registration.external.model

Class AuthenticatedUser

java.lang.Object

com.ibm.mfp.server.registration.external.model.AuthenticatedUser

public class AuthenticatedUser
extends java.lang.Object

User identity information, including ID and display name, the name of the security check that authenticated the user and the authentication time.

Constructor Summary

Constructors

Constructor and Description
AuthenticatedUser() Reserved for internal use.
AuthenticatedUser(java.lang.String id, java.lang.String displayName, java.lang.String securityCheckName) Constructs an AuthenticatedUser that has no attributes.
AuthenticatedUser(java.lang.String id, java.lang.String displayName, java.lang.String securityCheckName, java.util.Map attributes) Constructs an AuthenticatedUser.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.Map	getAttributes() Gets the custom attributes of the user, as a map of attribute name and attribute value.
long	getAuthenticatedAt() Gets the time when the user was authenticated.
java.lang.String	getAuthenticatedBy() Gets the name of the security check that authenticated the user.
java.lang.String	getDisplayName() Gets the display name of the user.
java.lang.String	getId() Gets the user ID assigned by the security check.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticatedUser

public AuthenticatedUser()

Reserved for internal use. Security checks should use one of the other constructors.

AuthenticatedUser

public AuthenticatedUser(java.lang.String id,
                 java.lang.String displayName,
                 java.lang.String securityCheckName)

Constructs an AuthenticatedUser that has no attributes.
The time of authentication is set to the current time.

Parameters:

id - the ID of the user

displayName - the display name

securityCheckName - the name of the security check that authenticated the user

AuthenticatedUser

public AuthenticatedUser(java.lang.String id,
                 java.lang.String displayName,
                 java.lang.String securityCheckName,
                 java.util.Map attributes)

Constructs an AuthenticatedUser.
The time of authentication is set to the current time.

Parameters:

id - the ID of the user

displayName - the display name

securityCheckName - the name of the security check that authenticated the user

attributes - custom attributes of the user, provided as a map of attribute name and value. Can be null, which is the same as an empty map.

Method Detail

getAuthenticatedAt

public long getAuthenticatedAt()

Gets the time when the user was authenticated.
The time is given in milliseconds since Unix epoch.

Returns:

the time when the user was authenticated, in milliseconds since Unix epoch

getAuthenticatedBy

public java.lang.String getAuthenticatedBy()

Gets the name of the security check that authenticated the user.

Returns:

the name of the security check that authenticated the user

getId

public java.lang.String getId()

Gets the user ID assigned by the security check.

Returns:

the user ID

getDisplayName

public java.lang.String getDisplayName()

Gets the display name of the user.

Returns:

the display name

getAttributes

public java.util.Map getAttributes()

Gets the custom attributes of the user, as a map of attribute name and attribute value.

Returns:

the custom attributes of the user, as a map of attribute name and attribute value

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object