Package org.keycloak.models
Enum ImpersonationSessionNote
- All Implemented Interfaces:
Serializable
,Comparable<ImpersonationSessionNote>
,UserSessionNoteDescriptor
public enum ImpersonationSessionNote
extends Enum<ImpersonationSessionNote>
implements UserSessionNoteDescriptor
Session note metadata for impersonation details stored in user session notes.
-
Enum Constant Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ImpersonationSessionNote
Returns the enum constant of this type with the specified name.static ImpersonationSessionNote[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
IMPERSONATOR_ID
-
IMPERSONATOR_USERNAME
-
IMPERSONATOR_CLIENT
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
getDisplayName
- Specified by:
getDisplayName
in interfaceUserSessionNoteDescriptor
- Returns:
- A human-readable name for the session note. This should tell the end user what the session note contains
-
getTokenClaim
- Specified by:
getTokenClaim
in interfaceUserSessionNoteDescriptor
- Returns:
- Token claim name/path to store the user session note value in.
-