org.jboss.as.domain.management.security

Class SecurityRealmService

java.lang.Object

org.jboss.as.domain.management.security.SecurityRealmService

All Implemented Interfaces:

SecurityRealm, org.jboss.msc.service.Service<SecurityRealm>, org.jboss.msc.value.Value<SecurityRealm>

public class SecurityRealmService
extends Object
implements org.jboss.msc.service.Service<SecurityRealm>, SecurityRealm

The service representing the security realm, this service will be injected into any management interfaces requiring any of the capabilities provided by the realm.

Author:

Darran Lofthouse

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.as.domain.management.SecurityRealm

SecurityRealm.ServiceUtil

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOADED_USERNAME_KEY
static String	SKIP_GROUP_LOADING_KEY

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

NULL, NULL_VALUE

Constructor Summary

Constructors

Constructor and Description
SecurityRealmService(String name, boolean mapGroupsToRoles)

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizingCallbackHandler	getAuthorizingCallbackHandler(AuthMechanism mechanism)
org.jboss.msc.value.InjectedSetValue<CallbackHandlerService>	getCallbackHandlerService()
org.jboss.msc.value.InjectedValue<org.jboss.as.domain.management.security.KeytabIdentityFactoryService>	getKeytabIdentityFactoryInjector()
Map<String,String>	getMechanismConfig(AuthMechanism mechanism)
String	getName()
org.jboss.msc.value.InjectedValue<CallbackHandlerFactory>	getSecretCallbackFactory()
CallbackHandlerFactory	getSecretCallbackHandlerFactory()
SSLContext	getSSLContext() Used to obtain the SSLContext as configured for this security realm.
org.jboss.msc.value.InjectedValue<SSLContext>	getSSLContextInjector()
SubjectIdentity	getSubjectIdentity(String protocol, String forHost) Used to obtain a SubjectIdentity containing a Subject for the Kerberos server identity represented by this SecurityRealm.
org.jboss.msc.value.InjectedValue<SubjectSupplementalService>	getSubjectSupplementalInjector()
Set<AuthMechanism>	getSupportedAuthenticationMechanisms()
SecurityRealmService	getValue()
boolean	isReadyForHttpChallenge() Indicate of this security realm is ready for challenge/response style HTTP authentication.
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

Field Detail

LOADED_USERNAME_KEY

public static final String LOADED_USERNAME_KEY

SKIP_GROUP_LOADING_KEY

public static final String SKIP_GROUP_LOADING_KEY

Constructor Detail

SecurityRealmService

public SecurityRealmService(String name,
                    boolean mapGroupsToRoles)

Method Detail

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<SecurityRealm>

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

getValue

public SecurityRealmService getValue()
                              throws IllegalStateException,
                                     IllegalArgumentException

Specified by:

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

Throws:

IllegalStateException

IllegalArgumentException

getName

public String getName()

Specified by:

getName in interface SecurityRealm

Returns:

The name of this SecurityRealm

getSupportedAuthenticationMechanisms

public Set<AuthMechanism> getSupportedAuthenticationMechanisms()

Specified by:

getSupportedAuthenticationMechanisms in interface SecurityRealm

Returns:

The set of authentication mechanisms supported by this realm.

getMechanismConfig

public Map<String,String> getMechanismConfig(AuthMechanism mechanism)

Specified by:

getMechanismConfig in interface SecurityRealm

Returns:

A Map containing the combined configuration options for the specified mechanisms.

isReadyForHttpChallenge

public boolean isReadyForHttpChallenge()

Description copied from interface: SecurityRealm

Indicate of this security realm is ready for challenge/response style HTTP authentication.

Specified by:

isReadyForHttpChallenge in interface SecurityRealm

Returns:

true if the security realm is ready for challenge/response style HTTP authentication.

getAuthorizingCallbackHandler

public AuthorizingCallbackHandler getAuthorizingCallbackHandler(AuthMechanism mechanism)

Specified by:

getAuthorizingCallbackHandler in interface SecurityRealm

Parameters:

mechanism - - The mechanism being used for authentication.

Returns:

The AuthorizingCallbackHandler for the specified mechanism.

getSubjectIdentity

public SubjectIdentity getSubjectIdentity(String protocol,
                                 String forHost)

Description copied from interface: SecurityRealm

Used to obtain a SubjectIdentity containing a Subject for the Kerberos server identity represented by this SecurityRealm. This method can return null if there is no appropriate identity.

Specified by:

getSubjectIdentity in interface SecurityRealm

Parameters:

protocol - The protocol in use.

forHost - The name of the host this identity should represent.

Returns:

A SubjectIdentity for the server identity or null if none are available.

getSubjectSupplementalInjector

public org.jboss.msc.value.InjectedValue<SubjectSupplementalService> getSubjectSupplementalInjector()

getSSLContextInjector

public org.jboss.msc.value.InjectedValue<SSLContext> getSSLContextInjector()

getSecretCallbackFactory

public org.jboss.msc.value.InjectedValue<CallbackHandlerFactory> getSecretCallbackFactory()

getKeytabIdentityFactoryInjector

public org.jboss.msc.value.InjectedValue<org.jboss.as.domain.management.security.KeytabIdentityFactoryService> getKeytabIdentityFactoryInjector()

getCallbackHandlerService

public org.jboss.msc.value.InjectedSetValue<CallbackHandlerService> getCallbackHandlerService()

getSSLContext

public SSLContext getSSLContext()

Description copied from interface: SecurityRealm

Used to obtain the SSLContext as configured for this security realm.

Specified by:

getSSLContext in interface SecurityRealm

Returns:

the SSLContext server identity for this realm.

getSecretCallbackHandlerFactory

public CallbackHandlerFactory getSecretCallbackHandlerFactory()

Specified by:

getSecretCallbackHandlerFactory in interface SecurityRealm

Returns:

A CallbackHandlerFactory for a pre-configured secret.