IAuthenticatorConfigWrapper (FORMCYCLE: BOM 7.4.0 API)

All Superinterfaces:

IStringAttributesMixin, Serializable

All Known Implementing Classes:

AnonymousConfigWrapper, AnyoneConfigWrapper, 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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`IAuthenticatorClients`	`buildAuthClients(IFormAuthContext authCtx)`	Builds the authentication clients based on the current data of the wrapper
`org.pac4j.core.authorization.authorizer.Authorizer`	`buildAuthorizer(IFormAuthContext authCtx)`	Builds the authorizer base on the current data of the wrapper
`Map<String,String>`	`getAttributes()`
`String`	`getAuthenticatorToken()`
`EAuthClientType`	`getAuthenticatorType()`
`IAuthenticatorConfigRenderer`	`getRenderer()`

Methods inherited from interface de.xima.fc.interfaces.mixin.attributes.IStringAttributesMixin
getAttributeValue, getAttributeValueList, getAttributeValueMap, putAttribute, putAttributes, putAttributes, removeAttribute

- Method Detail
  - getAuthenticatorType
```
EAuthClientType getAuthenticatorType()
```
    Returns:
    
    type of the authenticator config
  - getAuthenticatorToken
```
String getAuthenticatorToken()
```
    Returns:
    
    name (if it is a system authenticator) or callback UUID (if it is a client authenticator)
  - getAttributes
```
Map<String,String> getAttributes()
```
    Specified by:
    
    getAttributes in interface IStringAttributesMixin
    
    Returns:
    
    custom attributes of this authenticator config
  - getRenderer
```
IAuthenticatorConfigRenderer getRenderer()
```
    Returns:
    
    config renderer that is used to create the rendered HTML of the authenticator config
  - buildAuthClients
```
IAuthenticatorClients buildAuthClients(IFormAuthContext authCtx)
```
    Builds the authentication clients based on the current data of the wrapper
    
    Parameters:
    
    authCtx - IFormAuthContext to build the client for
    
    Returns:
    
    the Client
  - 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