org.jboss.as.domain.management.security

Class DomainManagedServerCallbackHandler

java.lang.Object

org.jboss.as.domain.management.security.DomainManagedServerCallbackHandler

All Implemented Interfaces:

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

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

A callback handler for servers connecting back to the local host-controller When a server is started, the process is given a generated authKey from the initiating host-controller, that it uses to connect back to the host-controller after start HostControllerConnection.

Author:

Ken Wills

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DomainManagedServerCallbackHandler.ServiceUtil

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOMAIN_SERVER_AUTH_PREFIX
static String	DOMAIN_SERVER_AUTH_REALM
static org.jboss.msc.service.ServiceName	SERVICE_NAME

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

NULL, NULL_VALUE

Constructor Summary

Constructors

Constructor and Description
DomainManagedServerCallbackHandler()

Method Summary

Modifier and Type	Method and Description
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()
Function<Principal,Principal>	getPrincipalMapper() Get a principal mapper to be used before the realm is selected.
org.jboss.msc.inject.Injector<CallbackHandler>	getServerCallbackHandlerInjector()
Set<AuthMechanism>	getSupplementaryMechanisms()
DomainManagedServerCallbackHandler	getValue()
void	handle(Callback[] callbacks)
static void	install(org.jboss.msc.service.ServiceTarget serviceTarget)
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

newInstance

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

allowGroupLoading

Field Detail

SERVICE_NAME

public static final org.jboss.msc.service.ServiceName SERVICE_NAME

DOMAIN_SERVER_AUTH_REALM

public static final String DOMAIN_SERVER_AUTH_REALM

DOMAIN_SERVER_AUTH_PREFIX

public static final String DOMAIN_SERVER_AUTH_PREFIX

Constructor Detail

DomainManagedServerCallbackHandler

public DomainManagedServerCallbackHandler()

Method Detail

install

public static void install(org.jboss.msc.service.ServiceTarget serviceTarget)

getServerCallbackHandlerInjector

public org.jboss.msc.inject.Injector<CallbackHandler> getServerCallbackHandlerInjector()

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.

start

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

Specified by:

start in interface org.jboss.msc.Service

Throws:

org.jboss.msc.service.StartException

stop

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

Specified by:

stop in interface org.jboss.msc.Service

getValue

public DomainManagedServerCallbackHandler getValue()
                                            throws IllegalStateException,
                                                   IllegalArgumentException

Specified by:

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

Throws:

IllegalStateException

IllegalArgumentException

handle

public void handle(Callback[] callbacks)
            throws IOException,
                   UnsupportedCallbackException

Specified by:

handle in interface CallbackHandler

Throws:

IOException

UnsupportedCallbackException

getPrincipalMapper

public Function<Principal,Principal> getPrincipalMapper()

Description copied from interface: CallbackHandlerService

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

Specified by:

getPrincipalMapper in interface CallbackHandlerService

Returns:

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