org.jboss.as.domain.management.security

Interface CallbackHandlerService

All Known Implementing Classes:

ClientCertCallbackHandler, DomainManagedServerCallbackHandler, JaasCallbackHandler, KerberosCallbackHandler, PlugInAuthenticationCallbackHandler, PropertiesCallbackHandler, UserDomainCallbackHandler, UserLdapCallbackHandler

public interface CallbackHandlerService

The interface to be implemented by all services supplying callback handlers.

Author:

Darran Lofthouse

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CallbackHandlerService.ServiceUtil

Method Summary

Modifier and Type	Method and Description
default boolean	allowGroupLoading() Where the Elytron SecurityRealm is used should group loading also be enabled?
CallbackHandler	getCallbackHandler(Map<String,Object> sharedState) Obtain a CallbackHandler instance for use during authentication.
Map<String,String>	getConfigurationOptions()
org.wildfly.security.auth.server.SecurityRealm	getElytronSecurityRealm() Get an Elytron SecurityRealm that is backed by this callback handler.
AuthMechanism	getPreferredMechanism()
default Function<Principal,Principal>	getPrincipalMapper() Get a principal mapper to be used before the realm is selected.
Set<AuthMechanism>	getSupplementaryMechanisms()
boolean	isReadyForHttpChallenge() Is this CallbackHandler ready for handling HTTP requests that involve a challenge? To be used by the HTTP interface to display an error if the administrator has not completed the set-up of their installation.

Method Detail

getPreferredMechanism

AuthMechanism getPreferredMechanism()

Returns:

The preferred authentication mechanism of the CBH.

getSupplementaryMechanisms

Set<AuthMechanism> getSupplementaryMechanisms()

Returns:

A set of additional mechanisms that can be handled by CallbackHandlers supplied by this service.

getConfigurationOptions

Map<String,String> getConfigurationOptions()

Returns:

The transport independent config options for the CallbackHandler supplied by this service.

isReadyForHttpChallenge

boolean isReadyForHttpChallenge()

Is this CallbackHandler ready for handling HTTP requests that involve a challenge? To be used by the HTTP interface to display an error if the administrator has not completed the set-up of their installation.

Returns:

indication of if this CallbackHandlerService is ready for challenge based authentication.

getCallbackHandler

CallbackHandler getCallbackHandler(Map<String,Object> sharedState)

Obtain a CallbackHandler instance for use during authentication. The service can decide if it will return a single shared CallbackHandler or a new one for each call to this method. The shared state is authentication request specific but this is the only time it will be provided, for CallbackHandlers making use of this then state specific instances should be returned.

Parameters:

sharedState - - The state to be shared between the authentication side of the call and the authorization side.

Returns:

A CallbackHandler instance.

getElytronSecurityRealm

org.wildfly.security.auth.server.SecurityRealm getElytronSecurityRealm()

Get an Elytron SecurityRealm that is backed by this callback handler.

Returns:

an Elytron SecurityRealm that is backed by this callback handler.

getPrincipalMapper

default Function<Principal,Principal> getPrincipalMapper()

Get a principal mapper to be used before the realm is selected.

Returns:

a principal mapper to be used before the realm is selected.

allowGroupLoading

default boolean allowGroupLoading()

Where the Elytron SecurityRealm is used should group loading also be enabled?

Returns:

true if group loading should be enabled, false otherwise.