Authentication.User (Jetty :: Project 12.1.3 API)

All Superinterfaces:: Authentication, Authentication.LogoutAuthentication, Request.AuthenticationState

All Known Implementing Classes:: AbstractUserAuthentication, FormAuthenticator.FormAuthentication, OpenIdAuthenticator.OpenIdAuthentication, SessionAuthentication, UserAuthentication

Enclosing interface:: Authentication

public static interface Authentication.User extends Authentication.LogoutAuthentication

A successful Authentication with User information.

Nested Class Summary

Nested classes/interfaces inherited from interface Authentication
Authentication.Challenge, Authentication.Deferred, Authentication.Failed, Authentication.Failure, Authentication.LoginAuthentication, Authentication.LogoutAuthentication, Authentication.NonAuthenticated, Authentication.ResponseSent, Authentication.SendSuccess, Authentication.User, Authentication.Wrapped
Field Summary

Fields inherited from interface Authentication
NOT_CHECKED, SEND_CONTINUE, SEND_FAILURE, SEND_SUCCESS, UNAUTHENTICATED
Method Summary

Modifier and Type

Method

Description

String

getAuthMethod()

UserIdentity

getUserIdentity()

default Principal

getUserPrincipal()

boolean

isUserInRole(UserIdentityScope scope, String role)

Methods inherited from interface Authentication.LogoutAuthentication
logout

Method Details
- getAuthMethod
  
  String getAuthMethod()
- getUserIdentity
  
  UserIdentity getUserIdentity()
- isUserInRole
  
  boolean isUserInRole(UserIdentityScope scope, String role)
- getUserPrincipal
  
  default Principal getUserPrincipal()
  
  Specified by:
  
  getUserPrincipal in interface Request.AuthenticationState
  
  Returns:
  
  The authenticated user Principal, or null if the Authentication is in a non-authenticated state.