UserIdentityScope (EE9 :: Nested 12.0.22 API)

public interface UserIdentityScope

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

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

Method Summary

Modifier and Type

Method

Description

static String

deRefRole(UserIdentityScope scope, String role)

ContextHandler

getContextHandler()

String

getContextPath()

String

getName()

Map<String,String>

getRoleRefMap()

Method Details
- getContextHandler
  
  ContextHandler getContextHandler()
  
  Returns:
  
  The context handler that the identity is being considered within
- getContextPath
  
  String getContextPath()
  
  Returns:
  
  The context path that the identity is being considered within
- getName
  
  String getName()
  
  Returns:
  
  The name of the identity context. Typically this is the servlet name.
- getRoleRefMap
  
  Map<String,String> getRoleRefMap()
  
  Returns:
  
  A map of role reference names that converts from names used by application code to names used by the context deployment.
- deRefRole
  
  static String deRefRole(UserIdentityScope scope, String role)