Package org.wildfly.security.http.util

Class PrivilegedServerMechanismFactory

java.lang.Object

org.wildfly.security.http.util.PrivilegedServerMechanismFactory

All Implemented Interfaces:

HttpServerAuthenticationMechanismFactory

public final class PrivilegedServerMechanismFactory
extends Object
implements HttpServerAuthenticationMechanismFactory

A HttpServerAuthenticationMechanismFactory that wraps a delegate so that any returned HttpServerAuthenticationMechanism is wrapped by a wrapper that ensures all calls are using the provided AccessControlContext, if no AccessControlContext is provided then the one in place at the time this factory is instantiated is used instead.

Author:

Darran Lofthouse

Field Summary

Fields

Modifier and Type	Field	Description
private AccessControlContext	accessControlContext
private HttpServerAuthenticationMechanismFactory	delegate

Constructor Summary

Constructors

Constructor	Description
PrivilegedServerMechanismFactory(HttpServerAuthenticationMechanismFactory delegate)	Construct a new instance of PrivilegedServerMechanismFactory using the current AccessControlContext for calls to the wrapped factory
PrivilegedServerMechanismFactory(HttpServerAuthenticationMechanismFactory delegate, AccessControlContext accessControlContext)	Construct a new instance of PrivilegedServerMechanismFactory.

Method Summary

Modifier and Type	Method	Description
HttpServerAuthenticationMechanism	createAuthenticationMechanism(String mechanismName, Map<String,?> properties, CallbackHandler callbackHandler)	Obtain an instance of the authentication mechanism requested provided this is allowed by any policy specified within the supplied properties.
String[]	getMechanismNames(Map<String,?> properties)	Get the names of the HTTP authentication mechanisms that can be supplied by this factory filtered by the supplied properties.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wildfly.security.http.HttpServerAuthenticationMechanismFactory

shutdown

Field Detail

delegate

private final HttpServerAuthenticationMechanismFactory delegate

accessControlContext

private final AccessControlContext accessControlContext

Constructor Detail

PrivilegedServerMechanismFactory

public PrivilegedServerMechanismFactory(HttpServerAuthenticationMechanismFactory delegate,
                                        AccessControlContext accessControlContext)

Construct a new instance of PrivilegedServerMechanismFactory.

Parameters:

delegate - the HttpServerAuthenticationMechanismFactory to delegate to.

accessControlContext - the AccessControlContext to use for calls to the wrapped factory and subsequently any mechanism created by that factory.

PrivilegedServerMechanismFactory

public PrivilegedServerMechanismFactory(HttpServerAuthenticationMechanismFactory delegate)

Construct a new instance of PrivilegedServerMechanismFactory using the current AccessControlContext for calls to the wrapped factory

Parameters:

delegate - the HttpServerAuthenticationMechanismFactory to delegate to.

Method Detail

getMechanismNames

public String[] getMechanismNames(Map<String,?> properties)

Description copied from interface: HttpServerAuthenticationMechanismFactory

Get the names of the HTTP authentication mechanisms that can be supplied by this factory filtered by the supplied properties.

Specified by:

getMechanismNames in interface HttpServerAuthenticationMechanismFactory

Parameters:

properties - the non-null set of properties to pass configuration to the mechanisms that may be evaluated for mechanism availability.

Returns:

A non-null array of the names of the supported HTTP authentication mechanisms.

See Also:

HttpServerAuthenticationMechanismFactory.getMechanismNames(java.util.Map)

createAuthenticationMechanism

public HttpServerAuthenticationMechanism createAuthenticationMechanism(String mechanismName,
                                                                       Map<String,?> properties,
                                                                       CallbackHandler callbackHandler)
                                                                throws HttpAuthenticationException

Description copied from interface: HttpServerAuthenticationMechanismFactory

Obtain an instance of the authentication mechanism requested provided this is allowed by any policy specified within the supplied properties.

Specified by:

createAuthenticationMechanism in interface HttpServerAuthenticationMechanismFactory

Parameters:

mechanismName - The non-null name of the mechanism to create.

properties - The non-null set of properties to select and configure the mechanism that may be evaluated for mechanism availability.

callbackHandler - The non-null CallbackHandler for use by the mechanism during authentication.

Returns:

the configured HttpServerAuthenticationMechanism or null if no mechanism could be resolved for the given mechanism name.

Throws:

HttpAuthenticationException - if there is an error creating the mechanism.

See Also:

HttpServerAuthenticationMechanismFactory.createAuthenticationMechanism(java.lang.String, java.util.Map, javax.security.auth.callback.CallbackHandler)