Package org.keycloak.protocol.saml.mappers

Class AuthnContextClassRefMapper

java.lang.Object

org.keycloak.protocol.saml.mappers.AbstractSAMLProtocolMapper

org.keycloak.protocol.saml.mappers.AuthnContextClassRefMapper

All Implemented Interfaces:

ProtocolMapper, SAMLLoginResponseMapper, ConfiguredProvider, EnvironmentDependentProviderFactory, Provider, ProviderFactory<ProtocolMapper>

public class AuthnContextClassRefMapper
extends AbstractSAMLProtocolMapper
implements SAMLLoginResponseMapper, EnvironmentDependentProviderFactory

Mapper to assign the used AuthnContextClassRef in the AunthContext response.

Author:

rmartinc

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHN_CONTEXT_CLASS_REF_CATEGORY
protected static final org.jboss.logging.Logger	logger
static final String	PROVIDER_ID

Constructor Summary

Constructors

Constructor	Description
AuthnContextClassRefMapper()

Method Summary

Modifier and Type	Method	Description
static ProtocolMapperModel	create(String name)
List<ProviderConfigProperty>	getConfigProperties()
String	getDisplayCategory()
String	getDisplayType()
String	getHelpText()
String	getId()
boolean	isSupported(Config.Scope config)	Check if the provider is supported and should be available based on the provider configuration.
ResponseType	transformLoginResponse(ResponseType response, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)

Methods inherited from class org.keycloak.protocol.saml.mappers.AbstractSAMLProtocolMapper

close, create, getProtocol, init, postInit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig

Methods inherited from interface org.keycloak.protocol.ProtocolMapper

getEffectiveModel, getPriority, validateConfig

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

AUTHN_CONTEXT_CLASS_REF_CATEGORY

public static final String AUTHN_CONTEXT_CLASS_REF_CATEGORY

See Also:

• Constant Field Values

logger

protected static final org.jboss.logging.Logger logger

Constructor Details

AuthnContextClassRefMapper

public AuthnContextClassRefMapper()

Method Details

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

getId

public String getId()

Specified by:

getId in interface ProviderFactory<ProtocolMapper>

getDisplayType

public String getDisplayType()

Specified by:

getDisplayType in interface ProtocolMapper

getDisplayCategory

public String getDisplayCategory()

Specified by:

getDisplayCategory in interface ProtocolMapper

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

transformLoginResponse

public ResponseType transformLoginResponse(ResponseType response,
 ProtocolMapperModel mappingModel,
 KeycloakSession session,
 UserSessionModel userSession,
 ClientSessionContext clientSessionCtx)

Specified by:

transformLoginResponse in interface SAMLLoginResponseMapper

isSupported

public boolean isSupported(Config.Scope config)

Description copied from interface: EnvironmentDependentProviderFactory

Check if the provider is supported and should be available based on the provider configuration.

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Parameters:

config - the provider configuration

Returns:

true if the provider is supported. Otherwise, false.

create

public static ProtocolMapperModel create(String name)