org.jboss.as.domain.management.security

Class PropertiesCallbackHandler

java.lang.Object

org.jboss.as.domain.management.security.PropertiesFileLoader

org.jboss.as.domain.management.security.UserPropertiesFileLoader

org.jboss.as.domain.management.security.PropertiesCallbackHandler

All Implemented Interfaces:

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

public class PropertiesCallbackHandler
extends UserPropertiesFileLoader
implements org.jboss.msc.service.Service<CallbackHandlerService>, CallbackHandlerService, CallbackHandler

A CallbackHandler obtaining the users and their passwords from a properties file.

Author:

Darran Lofthouse

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropertiesCallbackHandler.ServiceUtil

Field Summary

Fields inherited from class org.jboss.as.domain.management.security.PropertiesFileLoader

COMMENT_PREFIX, DISABLE_SUFFIX_KEY, propertiesFile, PROPERTY_PATTERN

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

NULL, NULL_VALUE

Constructor Summary

Constructors

Constructor and Description
PropertiesCallbackHandler(String realm, String path, String relativeTo, boolean plainText)

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()
Set<AuthMechanism>	getSupplementaryMechanisms()
CallbackHandlerService	getValue()
void	handle(Callback[] callbacks)
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)
protected void	verifyProperties(Properties properties) Provides the base class with an opportunity to verify the contents of the properties before they are used.

Methods inherited from class org.jboss.as.domain.management.security.UserPropertiesFileLoader

addLineContent, beginPersistence, endPersistence, getDisabledUserNames, getEnabledUserNames, getRealmName, getUserNames, load, setRealmName, write

Methods inherited from class org.jboss.as.domain.management.security.PropertiesFileLoader

cleanKey, escapeString, getPathManagerInjectorInjector, getProperties, loadAsRequired, persistProperties, readFile, safeClose, stop

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

stop

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

allowGroupLoading, getPrincipalMapper

Constructor Detail

PropertiesCallbackHandler

public PropertiesCallbackHandler(String realm,
                                 String path,
                                 String relativeTo,
                                 boolean plainText)

Method Detail

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.

verifyProperties

protected void verifyProperties(Properties properties)
                         throws IOException

Description copied from class: PropertiesFileLoader

Provides the base class with an opportunity to verify the contents of the properties before they are used.

Overrides:

verifyProperties in class PropertiesFileLoader

Parameters:

properties - - The Properties instance to verify.

Throws:

IOException

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.Service<CallbackHandlerService>

Overrides:

start in class PropertiesFileLoader

Throws:

org.jboss.msc.service.StartException

getValue

public CallbackHandlerService 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