org.jboss.as.domain.management.security

Class PlugInAuthenticationCallbackHandler

java.lang.Object

org.jboss.as.domain.management.security.PlugInAuthenticationCallbackHandler

All Implemented Interfaces:

CallbackHandlerService, org.jboss.msc.Service, org.jboss.msc.value.Value<CallbackHandlerService>

public class PlugInAuthenticationCallbackHandler
extends Object
implements org.jboss.msc.service.Service<CallbackHandlerService>, CallbackHandlerService

CallbackHandlerService to integrate the plug-ins.

Author:

Darran Lofthouse

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlugInAuthenticationCallbackHandler.ServiceUtil

Field Summary

Fields inherited from interface org.jboss.msc.service.Service

NULL, NULL_VALUE

Method Summary

Modifier and Type	Method and Description
CallbackHandler	getCallbackHandler(Map<String,Object> sharedState) Obtain a CallbackHandler instance for use during authentication.
protected Map<String,String>	getConfiguration()
Map<String,String>	getConfigurationOptions()
org.wildfly.security.auth.server.SecurityRealm	getElytronSecurityRealm() Get an Elytron SecurityRealm that is backed by this callback handler.
protected PlugInLoaderService	getPlugInLoader()
org.jboss.msc.value.InjectedValue<PlugInLoaderService>	getPlugInLoaderServiceValue()
protected String	getPlugInName()
AuthMechanism	getPreferredMechanism()
protected String	getRealmName()
Set<AuthMechanism>	getSupplementaryMechanisms()
CallbackHandlerService	getValue()
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.
void	start(org.jboss.msc.service.StartContext context)
void	stop(org.jboss.msc.service.StopContext context)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.msc.service.Service

start, stop

Methods inherited from interface org.jboss.msc.Service

newInstance

Methods inherited from interface org.jboss.as.domain.management.security.CallbackHandlerService

allowGroupLoading, getPrincipalMapper

Method Detail

getValue

public CallbackHandlerService getValue()
                                throws IllegalStateException,
                                       IllegalArgumentException

Specified by:

getValue in interface org.jboss.msc.value.Value<CallbackHandlerService>

Throws:

IllegalStateException

IllegalArgumentException

getPreferredMechanism

public AuthMechanism getPreferredMechanism()

Specified by:

getPreferredMechanism in interface CallbackHandlerService

Returns:

The preferred authentication mechanism of the CBH.

getSupplementaryMechanisms

public Set<AuthMechanism> getSupplementaryMechanisms()

Specified by:

getSupplementaryMechanisms in interface CallbackHandlerService

Returns:

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

getConfigurationOptions

public Map<String,String> getConfigurationOptions()

Specified by:

getConfigurationOptions in interface CallbackHandlerService

Returns:

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

isReadyForHttpChallenge

public boolean isReadyForHttpChallenge()

Description copied from interface: CallbackHandlerService

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.

Specified by:

isReadyForHttpChallenge in interface CallbackHandlerService

Returns:

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

getCallbackHandler

public CallbackHandler getCallbackHandler(Map<String,Object> sharedState)

Description copied from interface: CallbackHandlerService

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.

Specified by:

getCallbackHandler in interface CallbackHandlerService

Parameters:

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

Returns:

A CallbackHandler instance.

getElytronSecurityRealm

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

Description copied from interface: CallbackHandlerService

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

Specified by:

getElytronSecurityRealm in interface CallbackHandlerService

Returns:

an Elytron SecurityRealm that is backed by this callback handler.

getPlugInLoaderServiceValue

public org.jboss.msc.value.InjectedValue<PlugInLoaderService> getPlugInLoaderServiceValue()

start

public void start(org.jboss.msc.service.StartContext context)
           throws org.jboss.msc.service.StartException

Throws:

org.jboss.msc.service.StartException

stop

public void stop(org.jboss.msc.service.StopContext context)

getRealmName

protected String getRealmName()

getPlugInName

protected String getPlugInName()

getConfiguration

protected Map<String,String> getConfiguration()

getPlugInLoader

protected PlugInLoaderService getPlugInLoader()