com.ausregistry.jtoolkit2.session

Class SessionManagerFactory

java.lang.Object

com.ausregistry.jtoolkit2.session.SessionManagerFactory

public final class SessionManagerFactory
extends java.lang.Object

This factory provides instances of SessionManager implementations. The default SessionManager implementation is com.ausregistry.jtoolkit2.session.SessionManagerImpl. Alternative implementations may be loaded as described in the newInstance descriptions.

Method Summary

Modifier and Type	Method and Description
static SessionManager	newInstance(SessionManagerProperties props) Create a new SessionManager instance.
static SessionManager	newInstance(SessionManagerProperties props, java.lang.String className) Create a new SessionManager instance.
static SessionManager	newInstance(java.lang.String propertiesFile) Create a new SessionManager instance.

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static SessionManager newInstance(java.lang.String propertiesFile)
                                  throws ConfigurationException,
                                         java.io.IOException

Create a new SessionManager instance. The implementation defaults to SessionManagerImpl but may be overridden by setting the system property com.ausregistry.jtoolkit2.sessionManager.class to the full name of the alternative class.

Parameters:

propertiesFile - The location of a properties file to be used to configure the new SessionManager. This method attempts to load a new SessionManagerProperties object from this file before creating the SessionManager.

Throws:

java.io.IOException - The properties object was unable to load properties from the named file. The exception may indicate the cause via getCause().

ConfigurationException - The SessionManager was not successfully configured based on the properties loaded from the given file. The cause of the failure should be available via getCause().

newInstance

public static SessionManager newInstance(SessionManagerProperties props)
                                  throws ConfigurationException

Create a new SessionManager instance. The implementation defaults to SessionManagerImpl but may be overridden by setting the system property com.ausregistry.jtoolkit2.sessionManager.class to the full name of the alternative class.

Parameters:

props - SessionManager properties that have already been loaded. This method assumes that the properties are already loaded and therefore does not attempt to do so.

Throws:

ConfigurationException - The SessionManager was not successfully configured based on the given properties. The cause of the failure should be available via getCause().

newInstance

public static SessionManager newInstance(SessionManagerProperties props,
                                         java.lang.String className)
                                  throws FactoryConfigurationError,
                                         ConfigurationException

Create a new SessionManager instance. The implementation actually loaded is determined by the class name provided.

Parameters:

props - SessionManager properties that have already been loaded. This method assumes that the properties are already loaded and therefore does not attempt to do so.

Throws:

ConfigurationException - The SessionManager was not successfully configured based on the given properties. The cause of the failure should be available via getCause().

FactoryConfigurationError