Package org.wildfly.security.http.util.sso

Class SingleSignOnServerMechanismFactory

java.lang.Object

org.wildfly.security.http.util.sso.SingleSignOnServerMechanismFactory

All Implemented Interfaces:

HttpServerAuthenticationMechanismFactory

public class SingleSignOnServerMechanismFactory
extends Object
implements HttpServerAuthenticationMechanismFactory

A HttpServerAuthenticationMechanismFactory which enables single sign-on to the mechanisms provided by a another http mechanism factory.

The single sign-one capabilities provided by this factory is based on a HTTP Cookie to track SSO sessions and also an IdentityCache providing a storage (eg.: using a shared or distributable cache/map) for these sessions and related data.

Author:

Pedro Igor, Paul Ferraro

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SingleSignOnServerMechanismFactory.SingleSignOnConfiguration	Deprecated.

Field Summary

Fields

Modifier and Type	Field	Description
private SingleSignOnConfiguration	configuration
private HttpServerAuthenticationMechanismFactory	delegate
private SingleSignOnSessionFactory	singleSignOnSessionFactory

Constructor Summary

Constructors

Constructor	Description
SingleSignOnServerMechanismFactory(HttpServerAuthenticationMechanismFactory delegate, SingleSignOnSessionFactory singleSignOnSessionFactory, SingleSignOnConfiguration configuration)	Creates a new instance.
SingleSignOnServerMechanismFactory(HttpServerAuthenticationMechanismFactory delegate, SingleSignOnSessionFactory singleSignOnSessionFactory, SingleSignOnServerMechanismFactory.SingleSignOnConfiguration configuration)	Deprecated.

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.
private CallbackHandler	createCallbackHandler(CallbackHandler callbackHandler, String mechanismName, SingleSignOnSession singleSignOnSession)
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

configuration

private final SingleSignOnConfiguration configuration

singleSignOnSessionFactory

private final SingleSignOnSessionFactory singleSignOnSessionFactory

Constructor Detail

SingleSignOnServerMechanismFactory

public SingleSignOnServerMechanismFactory(HttpServerAuthenticationMechanismFactory delegate,
                                          SingleSignOnSessionFactory singleSignOnSessionFactory,
                                          SingleSignOnConfiguration configuration)

Creates a new instance.

Parameters:

delegate - the factory holding the target mechanisms

singleSignOnSessionFactory - a custom SingleSignOnManager

configuration - the configuration related with the cookie representing user's session

SingleSignOnServerMechanismFactory

@Deprecated
public SingleSignOnServerMechanismFactory(HttpServerAuthenticationMechanismFactory delegate,
                                          SingleSignOnSessionFactory singleSignOnSessionFactory,
                                          SingleSignOnServerMechanismFactory.SingleSignOnConfiguration configuration)

Deprecated.

Creates a new instance.

Parameters:

delegate - the factory holding the target mechanisms

singleSignOnSessionFactory - a custom SingleSignOnManager

configuration - the configuration related with the cookie representing user's session

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.

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.

createCallbackHandler

private CallbackHandler createCallbackHandler(CallbackHandler callbackHandler,
                                              String mechanismName,
                                              SingleSignOnSession singleSignOnSession)