Package de.xima.fc.interfaces.auth.config

Interface IAuthenticatorConfigWrapper

All Superinterfaces:

IStringAttributesMixin, Serializable

All Known Implementing Classes:

AnonymousConfigWrapper, AnyoneConfigWrapper, DistinctUserConfigWrapper, EntityConfigWrapper, FormConfigWrapper, KerberosConfigWrapper, NtlmConfigWrapper, PasswordConfigWrapper

public interface IAuthenticatorConfigWrapper
extends IStringAttributesMixin, Serializable

Common interface for authenticator config wrapper

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IAuthenticatorClients	buildAuthClients(IFormAuthContext authCtx)	Deprecated. since version 8.0.0.
org.pac4j.core.authorization.authorizer.Authorizer	buildAuthorizer(IFormAuthContext authCtx)	Builds the authorizer base on the current data of the wrapper
Map<String,String>	getAttributes()
default String	getAuthenticatorToken()	Deprecated. since version 8.0.0.
default EAuthClientType	getAuthenticatorType()	Deprecated. since version 8.0.0.
@NotNull IClientDescriptor	getClientDescriptor()
IAuthenticatorConfigRenderer	getRenderer()	Deprecated. since version 8.0.0.

Methods inherited from interface de.xima.fc.interfaces.mixin.attributes.IStringAttributesMixin

getAttributeValue, getAttributeValueList, getAttributeValueMap, putAttribute, putAttributes, putAttributes, removeAttribute

Method Detail

getClientDescriptor

@NotNull
@NotNull IClientDescriptor getClientDescriptor()

Returns:

Descriptor of the authentication client.

Since:

8.0.0

getAttributes

Map<String,String> getAttributes()

Specified by:

getAttributes in interface IStringAttributesMixin

Returns:

custom attributes of this authenticator config

buildAuthorizer

org.pac4j.core.authorization.authorizer.Authorizer buildAuthorizer(IFormAuthContext authCtx)

Builds the authorizer base on the current data of the wrapper

Parameters:

authCtx - IFormAuthContext to build the authorizers for

Returns:

the Authorizer

buildAuthClients

@Deprecated
IAuthenticatorClients buildAuthClients(IFormAuthContext authCtx)

Deprecated.

since version 8.0.0. AuthClientCache should usually be used instead. For backwards compatibility with older plugin versions this method is still used for form logins.

Builds the authentication clients based on the current data of the wrapper

Parameters:

authCtx - IFormAuthContext to build the client for

Returns:

the Client

getRenderer

@Deprecated
IAuthenticatorConfigRenderer getRenderer()

Deprecated.

since version 8.0.0. Use AuthenticatorRendererFactory instead.

Returns:

config renderer that is used to create the rendered HTML of the authenticator config

getAuthenticatorType

@Deprecated
default EAuthClientType getAuthenticatorType()

Deprecated.

since version 8.0.0. Use IClientDescriptor.getType() instead.

Returns:

type of the authenticator config

getAuthenticatorToken

@Deprecated
default String getAuthenticatorToken()

Deprecated.

since version 8.0.0. Use IClientDescriptor.getClientName() instead.

Returns:

name (if it is a system authenticator) or callback UUID (if it is a client authenticator)