yawda.data.access
Class CBasicServletConfiguration

java.lang.Object
  org.objectstyle.cayenne.conf.Configuration
      org.objectstyle.cayenne.conf.DefaultConfiguration
          yawda.data.access.CBasicServletConfiguration

public final class CBasicServletConfiguration

extends org.objectstyle.cayenne.conf.DefaultConfiguration

BasicServletConfiguration is a Configuration that uses ServletContext to locate resources. This class can only be used in a context of a servlet/jsp container. It resolves configuration file paths relative to the web application "WEB-INF" directory.

BasicServletConfiguration is compatible with Servlet Specification 2.2 and higher. Also look at ServletConfiguration for the information how to utilize listeners introduced in Servlet Specification 2.3.

Author:

Andrei Adamchik, Scott Finnerty

Field Summary

static String	CONFIGURATION_PATH_KEY
static String	DATA_CONTEXT_KEY
protected javax.servlet.ServletContext	servletContext

Fields inherited from class org.objectstyle.cayenne.conf.Configuration

ACCEPT_ALL_DATAVIEWS, configurationShutdownHook, dataDomains, dataDomainsRef, dataViewLocations, DEFAULT_CONFIGURATION_CLASS, DEFAULT_DOMAIN_FILE, DEFAULT_LOGGING_PROPS_FILE, domainConfigurationName, ignoringLoadFailures, loaderDelegate, loadStatus, overrideFactory, projectVersion, resourceLoader, sharedConfiguration

Constructor Summary

CBasicServletConfiguration()

CBasicServletConfiguration(javax.servlet.ServletContext ctxt)

Method Summary

boolean	canInitialize()
static org.objectstyle.cayenne.access.DataContext	getDefaultContext(javax.servlet.http.HttpSession session) Returns default Cayenne DataContext associated with the HttpSession.
javax.servlet.ServletContext	getServletContext() Returns current application context object.
static CBasicServletConfiguration	initializeConfiguration(javax.servlet.ServletContext ctxt)
void	setServletContext(javax.servlet.ServletContext servletContext) Sets the servletContext.

Methods inherited from class org.objectstyle.cayenne.conf.DefaultConfiguration

addClassPath, didInitialize, getDomainConfiguration, getMapConfiguration, getResourceLocator, getViewConfiguration, initialize, setResourceLocator, toString

Methods inherited from class org.objectstyle.cayenne.conf.Configuration

addDomain, bootstrapSharedConfiguration, configureCommonLogging, configureCommonLogging, configureLogging, getDataSourceFactory, getDataViewLocations, getDomain, getDomain, getDomainConfigurationName, getDomains, getLoaderDelegate, getLoadStatus, getLoggingLevel, getProjectVersion, getResourceLoader, getSharedConfiguration, initializeSharedConfiguration, initializeSharedConfiguration, initializeSharedConfiguration, installConfigurationShutdownHook, isIgnoringLoadFailures, isLoggingConfigured, loadDataView, loadDataView, removeDomain, setDataSourceFactory, setDataViewLocations, setDomainConfigurationName, setIgnoringLoadFailures, setLoaderDelegate, setLoadStatus, setLoggingConfigured, setLoggingLevel, setProjectVersion, shutdown, uninstallConfigurationShutdownHook

Methods inherited from class java.lang.Object

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

Field Detail

CONFIGURATION_PATH_KEY

public static final String CONFIGURATION_PATH_KEY

See Also:

Constant Field Values

DATA_CONTEXT_KEY

public static final String DATA_CONTEXT_KEY

See Also:

Constant Field Values

servletContext

protected javax.servlet.ServletContext servletContext

Constructor Detail

CBasicServletConfiguration

public CBasicServletConfiguration()

CBasicServletConfiguration

public CBasicServletConfiguration(javax.servlet.ServletContext ctxt)

Method Detail

initializeConfiguration

public static final CBasicServletConfiguration initializeConfiguration(javax.servlet.ServletContext ctxt)

getDefaultContext

public static final org.objectstyle.cayenne.access.DataContext getDefaultContext(javax.servlet.http.HttpSession session)

Returns default Cayenne DataContext associated with the HttpSession. If no DataContext exists in the session, it is created on the spot.

setServletContext

public final void setServletContext(javax.servlet.ServletContext servletContext)

Sets the servletContext.

Parameters:

servletContext - The servletContext to set

getServletContext

public final javax.servlet.ServletContext getServletContext()

Returns current application context object.

canInitialize

public final boolean canInitialize()