org.jboss.as.domain.management

Interface SecurityRealm

All Known Implementing Classes:

SecurityRealmService

public interface SecurityRealm

Interface to the security realm.

Author:

Darran Lofthouse

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SecurityRealm.ServiceUtil

Method Summary

Modifier and Type	Method and Description
AuthorizingCallbackHandler	getAuthorizingCallbackHandler(AuthMechanism mechanism)
org.wildfly.security.auth.server.HttpAuthenticationFactory	getHttpAuthenticationFactory() Get a HttpAuthenticationFactory backed by this SecurityRealm.
Map<String,String>	getMechanismConfig(AuthMechanism mechanism)
String	getName()
org.wildfly.security.auth.server.SaslAuthenticationFactory	getSaslAuthenticationFactory() Get a SaslAuthenticationFactory backed by this SecurityRealm.
org.wildfly.security.auth.server.SaslAuthenticationFactory	getSaslAuthenticationFactory(String[] mechanismNames, Boolean policyNoanonymous) Get a SaslAuthenticationFactory backed by this SecurityRealm.
CallbackHandlerFactory	getSecretCallbackHandlerFactory()
SSLContext	getSSLContext() Used to obtain the SSLContext as configured for this security realm.
SubjectIdentity	getSubjectIdentity(String protocol, String forHost) Used to obtain a SubjectIdentity containing a Subject for the Kerberos server identity represented by this SecurityRealm.
Set<AuthMechanism>	getSupportedAuthenticationMechanisms()
boolean	isReadyForHttpChallenge() Indicate of this security realm is ready for challenge/response style HTTP authentication.

Method Detail

getName

String getName()

Returns:

The name of this SecurityRealm

getSupportedAuthenticationMechanisms

Set<AuthMechanism> getSupportedAuthenticationMechanisms()

Returns:

The set of authentication mechanisms supported by this realm.

getMechanismConfig

Map<String,String> getMechanismConfig(AuthMechanism mechanism)

Returns:

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

getAuthorizingCallbackHandler

AuthorizingCallbackHandler getAuthorizingCallbackHandler(AuthMechanism mechanism)

Parameters:

mechanism - - The mechanism being used for authentication.

Returns:

The AuthorizingCallbackHandler for the specified mechanism.

Throws:

IllegalArgumentException - If the mechanism is not supported by this realm.

isReadyForHttpChallenge

boolean isReadyForHttpChallenge()

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

Returns:

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

getSSLContext

SSLContext getSSLContext()

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

Returns:

the SSLContext server identity for this realm.

getSecretCallbackHandlerFactory

CallbackHandlerFactory getSecretCallbackHandlerFactory()

Returns:

A CallbackHandlerFactory for a pre-configured secret.

getSubjectIdentity

SubjectIdentity getSubjectIdentity(String protocol,
                                   String forHost)

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.

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.

getSaslAuthenticationFactory

org.wildfly.security.auth.server.SaslAuthenticationFactory getSaslAuthenticationFactory()

Get a SaslAuthenticationFactory backed by this SecurityRealm.

Returns:

a SaslAuthenticationFactory backed by this SecurityRealm.

getSaslAuthenticationFactory

org.wildfly.security.auth.server.SaslAuthenticationFactory getSaslAuthenticationFactory(String[] mechanismNames,
                                                                                        Boolean policyNoanonymous)
                                                                                 throws org.jboss.msc.service.StartException

Get a SaslAuthenticationFactory backed by this SecurityRealm.

Parameters:

mechanismNames - Allowed mechanisms defined in remoting subsystem by property SASL_MECHANISMS

policyNoanonymous - Value of parameter SASL_POLICY_NOANONYMOUS

Returns:

a SaslAuthenticationFactory backed by this SecurityRealm.

Throws:

org.jboss.msc.service.StartException - When any of mechanismNames is not suuported.

getHttpAuthenticationFactory

org.wildfly.security.auth.server.HttpAuthenticationFactory getHttpAuthenticationFactory()

Get a HttpAuthenticationFactory backed by this SecurityRealm.

Returns:

a HttpAuthenticationFactory backed by this SecurityRealm.