Interface UserIdentity

All Known Implementing Classes:

RoleDelegateUserIdentity

public interface UserIdentity

User object that encapsulates user identity and operations such as run-as-role actions, checking isUserInRole and getUserPrincipal.

Implementations of UserIdentity should be immutable so that they may be cached by Authenticators and LoginServices.

Method Summary

Modifier and Type	Method	Description
static UserIdentity	from(Subject subject, Principal userPrincipal, String... roles)
Subject	getSubject()
Principal	getUserPrincipal()
boolean	isUserInRole(String role)	Check if the user is in a role.

Method Details

getSubject

Subject getSubject()

Returns:

The user subject

getUserPrincipal

Principal getUserPrincipal()

Returns:

The user principal

isUserInRole

boolean isUserInRole(String role)

Check if the user is in a role. This call is used to satisfy authorization calls from container code which will be using translated role names.

Parameters:

role - A role name.

Returns:

True if the user can act in that role.

from

static UserIdentity from(Subject subject,
 Principal userPrincipal,
 String... roles)