public class UserSessionNoteMapper extends AbstractOIDCProtocolMapper implements OIDCAccessTokenMapper, OIDCIDTokenMapper, OIDCAccessTokenResponseMapper
| Modifier and Type | Field and Description |
|---|---|
static String |
PROVIDER_ID |
TOKEN_MAPPER_CATEGORY| Constructor and Description |
|---|
UserSessionNoteMapper() |
| Modifier and Type | Method and Description |
|---|---|
static ProtocolMapperModel |
createClaimMapper(String name,
String userSessionNote,
String tokenClaimName,
String jsonType,
boolean accessToken,
boolean idToken) |
static ProtocolMapperModel |
createUserSessionNoteMapper(UserSessionNoteDescriptor userSessionNoteDescriptor)
For session notes defined using a
UserSessionNoteDescriptor enum |
List<ProviderConfigProperty> |
getConfigProperties() |
String |
getDisplayCategory() |
String |
getDisplayType() |
String |
getHelpText() |
String |
getId() |
protected void |
setClaim(AccessTokenResponse accessTokenResponse,
ProtocolMapperModel mappingModel,
UserSessionModel userSession,
KeycloakSession keycloakSession,
ClientSessionContext clientSessionCtx)
Intended to be overridden in
ProtocolMapper implementations to add claims to an token. |
protected void |
setClaim(IDToken token,
ProtocolMapperModel mappingModel,
UserSessionModel userSession)
Intended to be overridden in
ProtocolMapper implementations to add claims to an token. |
close, create, getProtocol, init, postInit, setClaim, transformAccessToken, transformAccessTokenResponse, transformIDToken, transformUserInfoTokenclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waittransformAccessTokentransformIDTokentransformAccessTokenResponsegetPriority, validateConfigorderpublic static final String PROVIDER_ID
public List<ProviderConfigProperty> getConfigProperties()
getConfigProperties in interface ConfiguredProviderpublic String getId()
getId in interface ProviderFactory<ProtocolMapper>public String getDisplayType()
getDisplayType in interface ProtocolMapperpublic String getDisplayCategory()
getDisplayCategory in interface ProtocolMapperpublic String getHelpText()
getHelpText in interface ConfiguredProviderprotected void setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
AbstractOIDCProtocolMapperProtocolMapper implementations to add claims to an token.setClaim in class AbstractOIDCProtocolMapperprotected void setClaim(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
AbstractOIDCProtocolMapperProtocolMapper implementations to add claims to an token.setClaim in class AbstractOIDCProtocolMapperpublic static ProtocolMapperModel createClaimMapper(String name, String userSessionNote, String tokenClaimName, String jsonType, boolean accessToken, boolean idToken)
public static ProtocolMapperModel createUserSessionNoteMapper(UserSessionNoteDescriptor userSessionNoteDescriptor)
UserSessionNoteDescriptor enumuserSessionNoteDescriptor - User session note descriptor for which to create a protocol mapper model.Copyright © 2021 JBoss by Red Hat. All rights reserved.