Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.objectstyle.cayenne.conf
Class BasicServletConfiguration  view BasicServletConfiguration download BasicServletConfiguration.java

java.lang.Object
  extended byorg.objectstyle.cayenne.conf.Configuration
      extended byorg.objectstyle.cayenne.conf.DefaultConfiguration
          extended byorg.objectstyle.cayenne.conf.BasicServletConfiguration
Direct Known Subclasses:
ServletConfiguration

public class BasicServletConfiguration
extends 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.


Nested Class Summary
 
Nested classes inherited from class org.objectstyle.cayenne.conf.Configuration
 
Field Summary
static java.lang.String CONFIGURATION_PATH_KEY
           
static java.lang.String DATA_CONTEXT_KEY
           
private static org.apache.log4j.Logger logObj
           
protected  javax.servlet.ServletContext servletContext
           
 
Fields inherited from class org.objectstyle.cayenne.conf.DefaultConfiguration
 
Fields inherited from class org.objectstyle.cayenne.conf.Configuration
configurationShutdownHook, dataDomains, dataDomainsRef, DEFAULT_CONFIGURATION_CLASS, DEFAULT_DOMAIN_FILE, DEFAULT_LOGGING_PROPS_FILE, domainConfigurationName, ignoringLoadFailures, loadStatus, overrideFactory, resourceLoader, sharedConfiguration
 
Constructor Summary
BasicServletConfiguration()
           
BasicServletConfiguration(javax.servlet.ServletContext ctxt)
           
 
Method Summary
 boolean canInitialize()
          Default implementation of Configuration.canInitialize() 55 .
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 BasicServletConfiguration 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, initialize, setResourceLocator, toString
 
Methods inherited from class org.objectstyle.cayenne.conf.Configuration
addDomain, bootstrapSharedConfiguration, configureCommonLogging, configureCommonLogging, configureLogging, getDataSourceFactory, getDomain, getDomain, getDomainConfigurationName, getDomains, getLoaderDelegate, getLoadStatus, getLoggingLevel, getResourceLoader, getSharedConfiguration, initializeSharedConfiguration, initializeSharedConfiguration, initializeSharedConfiguration, installConfigurationShutdownHook, isIgnoringLoadFailures, isLoggingConfigured, removeDomain, setDataSourceFactory, setDomainConfigurationName, setIgnoringLoadFailures, setLoadStatus, setLoggingConfigured, setLoggingLevel, shutdown, uninstallConfigurationShutdownHook
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

logObj

private static org.apache.log4j.Logger logObj

CONFIGURATION_PATH_KEY

public static final java.lang.String CONFIGURATION_PATH_KEY
See Also:
Constant Field Values

DATA_CONTEXT_KEY

public static final java.lang.String DATA_CONTEXT_KEY
See Also:
Constant Field Values

servletContext

protected javax.servlet.ServletContext servletContext
Constructor Detail

BasicServletConfiguration

public BasicServletConfiguration()

BasicServletConfiguration

public BasicServletConfiguration(javax.servlet.ServletContext ctxt)
Method Detail

initializeConfiguration

public static BasicServletConfiguration initializeConfiguration(javax.servlet.ServletContext ctxt)

getDefaultContext

public static 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 void setServletContext(javax.servlet.ServletContext servletContext)
Sets the servletContext.


getServletContext

public javax.servlet.ServletContext getServletContext()
Returns current application context object.


canInitialize

public boolean canInitialize()
Description copied from class: DefaultConfiguration
Default implementation of Configuration.canInitialize() 55 . Creates a ResourceLocator suitable for loading from the CLASSPATH, unless it has already been set in a subclass. Always returns true.

Overrides:
canInitialize in class DefaultConfiguration