UserIdentity (Jetty :: Project 9.4.56.v20240826 API)

All Known Subinterfaces:

UserIdentity.UnauthenticatedUserIdentity

All Known Implementing Classes:

DefaultUserIdentity, OpenIdUserIdentity, SpnegoUserIdentity
```
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.

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface UserIdentity.Scope
A UserIdentity Scope.

static interface UserIdentity.UnauthenticatedUserIdentity

Field Summary

Fields
Modifier and Type Field Description

static UserIdentity UNAUTHENTICATED_IDENTITY

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`javax.security.auth.Subject`	`getSubject()`
`java.security.Principal`	`getUserPrincipal()`
`boolean`	`isUserInRole(java.lang.String role, UserIdentity.Scope scope)`	Check if the user is in a role.

- Field Detail
  - UNAUTHENTICATED_IDENTITY
```
static final UserIdentity UNAUTHENTICATED_IDENTITY
```
- Method Detail
  - getSubject
```
javax.security.auth.Subject getSubject()
```
    Returns:
    
    The user subject
  - getUserPrincipal
```
java.security.Principal getUserPrincipal()
```
    Returns:
    
    The user principal
  - isUserInRole
```
boolean isUserInRole(java.lang.String role,
                     UserIdentity.Scope scope)
```
    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.
    
    scope - the scope
    
    Returns:
    
    True if the user can act in that role.