org.openmdx.security.auth.servlet.spi
Class AbstractRemoteAuthenticationHandler

java.lang.Object
  org.openmdx.security.auth.servlet.spi.AbstractHandler
      org.openmdx.security.auth.servlet.spi.AbstractAuthenticationHandler
          org.openmdx.security.auth.servlet.spi.AbstractRemoteAuthenticationHandler

All Implemented Interfaces:

ServletConfig, Invalidator, HttpAuthenticationHandler, HttpHandler

Direct Known Subclasses:

RemoteAuthenticationHandler, RemoteAuthenticationHandler, RemoteAuthenticationHandler

public abstract class AbstractRemoteAuthenticationHandler
extends AbstractAuthenticationHandler

AbstractRemoteAuthenticationHandler

Constructor Summary

protected

AbstractRemoteAuthenticationHandler() Constructor

Method Summary

protected abstract Dataprovider_1ConnectionFactory	getConnectionFactory() Connection factory callback method
protected Map	getSharedOptions() Retrieve the shared options
void	init() A convenience method which can be overridden so that there's no need to call super.init(config).
protected String	modelsDefault() Provide the "models" default value.
protected String	namePromptDefault() Provide the "name-prompt" default value.
protected String	passwordEchoDefault() Provide the "password-echo" default configuration.
protected String	passwordPromptDefault() Provide the "password-prompt" default value.
protected String	realmInformationDefault() Provide the "realm-information" default value.
protected String	realmInitialContextFactoryDefault() Provide the "realm-initial-context-factory" default value.
protected String	realmJNDINameDefault() Provide the "realm-jndi-name" default value.
protected String	realmProviderURLDefault() Provide the "realm-provider-url" default value.
protected long	realmUnavailabilityExpectationDefault() Provide the "unavailability-expectation" default value.
protected String	realmXRIDefault() Provide the "realm-xri" default value of the form "xri:@openmdx:org.openmdx.security.realm1/provider/'Provider'/segment/'Segment'/realm/'Realm'";

Methods inherited from class org.openmdx.security.auth.servlet.spi.AbstractAuthenticationHandler

applicationNameDefault, callbackTimeoutDefault, destroy, getAuthentication, getCorrelationId, idleTimeoutDefault, initialCapacityDefault, invalidateObject, isLenient, lenientDefault, loginConfigurationDefault, maximumCapacityDefault, maximumWaitDefault, returnAuthentication

Methods inherited from class org.openmdx.security.auth.servlet.spi.AbstractHandler

debugDefault, endBody, endDocument, endHead, getInitParameter, getInitParameter, getInitParameter, getInitParameter, getInitParameter, getInitParameterNames, getServletContext, getServletName, init, isDebug, log, log, startBody, startDocument, startHead, writeEncoded

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openmdx.security.auth.servlet.cci.HttpHandler

init

Constructor Detail

AbstractRemoteAuthenticationHandler

protected AbstractRemoteAuthenticationHandler()

Constructor

Method Detail

init

public void init()
          throws ServletException

Description copied from class: AbstractHandler

A convenience method which can be overridden so that there's no need to call super.init(config).

Instead of overriding init(ServletConfig), simply override this method and it will be called by AbstractHandler.init(ServletConfig).

Overrides:

init in class AbstractAuthenticationHandler

Throws:

ServletException

getSharedOptions

protected final Map getSharedOptions()
                              throws ServletException

Description copied from class: AbstractAuthenticationHandler

Retrieve the shared options

Specified by:

getSharedOptions in class AbstractAuthenticationHandler

Returns:

a Map containing the default options shared by all LoginModules

Throws:

ServletException

getConnectionFactory

protected abstract Dataprovider_1ConnectionFactory getConnectionFactory()
                                                                 throws ServiceException

Connection factory callback method

Returns:

the Dataprovider_1ConnectionFactory to be sused by the LoginModule.

Throws:

ServiceException - if the connection factory can't be retrieved.

realmUnavailabilityExpectationDefault

protected long realmUnavailabilityExpectationDefault()

Provide the "unavailability-expectation" default value.

Returns:

the "unavailability-expectation" default value

realmXRIDefault

protected String realmXRIDefault()

Provide the "realm-xri" default value of the form "xri:@openmdx:org.openmdx.security.realm1/provider/'Provider'/segment/'Segment'/realm/'Realm'";

Returns:

the "realm-xri" default value.

passwordEchoDefault

protected String passwordEchoDefault()

Provide the "password-echo" default configuration.

Returns:

the "password-echo" default configuration, e.g.

• "false" (Echo off for all calllbacks)
• "true" (Echo on for all calllbacks)
• "[2]" (Echo on in case of request code 2)
• "[2, 3]" (Echo on in case of request codes 2 or 3)

namePromptDefault

protected String namePromptDefault()

Provide the "name-prompt" default value.

Returns:

the "name-prompt" default value

realmInformationDefault

protected String realmInformationDefault()

Provide the "realm-information" default value.

The following placeholders are supported

• ${realm.id} The realm path's base name
• ${realm.xri} The realm path's XRI

Returns:

the "realm-information" default value

passwordPromptDefault

protected String passwordPromptDefault()

Provide the "password-prompt" default value.

The following placeholders are supported

• ${name} The NameCallback's name
• ${challenge} The credential's challenge

Returns:

the "password-prompt" default value

realmProviderURLDefault

protected String realmProviderURLDefault()

Provide the "realm-provider-url" default value.

Returns:

the "realm-provider-url" default value

realmInitialContextFactoryDefault

protected String realmInitialContextFactoryDefault()

Provide the "realm-initial-context-factory" default value.

Returns:

the "realm-initial-context-factory" default value

realmJNDINameDefault

protected String realmJNDINameDefault()

Provide the "realm-jndi-name" default value.

Returns:

the "realm-jndi-name" default value

modelsDefault

protected String modelsDefault()

Provide the "models" default value.

Returns:

the "models" default value