Package edu.uiuc.ncsa.myproxy.oa4mp.client.loader

Class AbstractClientBootstrapper

java.lang.Object

edu.uiuc.ncsa.security.servlet.Bootstrapper

org.oa4mp.client.api.loader.AbstractClientBootstrapper

All Implemented Interfaces:

EventListener, javax.servlet.ServletContextListener

Direct Known Subclasses:

OA2ClientBootstrapper

public abstract class AbstractClientBootstrapper
extends edu.uiuc.ncsa.security.servlet.Bootstrapper

A class required by Tomcat. This is the entry point for loading the configuration file. One feature of this is that it will search for configurations in various default locations using a default file name of client.xml

• $USER_HOME/client.xml
• $USER_HOME/oa4mp/client.xml
• $USER_DIR/client.xml
• $USER_DIR/client.xml
• /var/www/config/client.xml
• /var/www/config/oa4mp/client.xml

where $USER_HOME is the home directory for the current user and $USER_DIR is he current invocation directory. If all of these locations as well as the servlet context have been checked for usable configurations and none is found, an error is issued stating there is no usable configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_CONFIG_FILE_NAME
static String[]	DEFAULT_CONFIG_LOCATIONS
protected static String	OA4MP_CONFIG_FILE_KEY
protected static String	OA4MP_CONFIG_NAME_KEY

Constructor Summary

Constructors

Constructor	Description
AbstractClientBootstrapper()

Method Summary

Modifier and Type	Method	Description
edu.uiuc.ncsa.security.core.util.ConfigurationLoader	getConfigurationLoader(javax.servlet.ServletContext servletContext)
String	getOa4mpConfigFileKey()
String	getOa4mpConfigNameKey()
edu.uiuc.ncsa.security.core.util.ConfigurationLoader	loadFromDefaultLocations(edu.uiuc.ncsa.security.core.util.MyLoggingFacade logger, String configName)

Methods inherited from class edu.uiuc.ncsa.security.servlet.Bootstrapper

contextDestroyed, contextInitialized, getConfigurationLoader, getInitialization

Methods inherited from class java.lang.Object

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

Field Detail

OA4MP_CONFIG_FILE_KEY

protected static final String OA4MP_CONFIG_FILE_KEY

See Also:

Constant Field Values

OA4MP_CONFIG_NAME_KEY

protected static final String OA4MP_CONFIG_NAME_KEY

See Also:

Constant Field Values

DEFAULT_CONFIG_FILE_NAME

public static final String DEFAULT_CONFIG_FILE_NAME

See Also:

Constant Field Values

DEFAULT_CONFIG_LOCATIONS

public static final String[] DEFAULT_CONFIG_LOCATIONS

Constructor Detail

AbstractClientBootstrapper

public AbstractClientBootstrapper()

Method Detail

getOa4mpConfigFileKey

public String getOa4mpConfigFileKey()

getOa4mpConfigNameKey

public String getOa4mpConfigNameKey()

loadFromDefaultLocations

public edu.uiuc.ncsa.security.core.util.ConfigurationLoader loadFromDefaultLocations(edu.uiuc.ncsa.security.core.util.MyLoggingFacade logger,
                                                                                     String configName)
                                                                              throws Exception

Throws:

Exception

getConfigurationLoader

public edu.uiuc.ncsa.security.core.util.ConfigurationLoader getConfigurationLoader(javax.servlet.ServletContext servletContext)
                                                                            throws Exception

Specified by:

getConfigurationLoader in class edu.uiuc.ncsa.security.servlet.Bootstrapper

Throws:

Exception