de.mindmatters.faces.spring.context
Interface FacesWebApplicationContext

All Superinterfaces:

ApplicationContext, ApplicationEventPublisher, BeanFactory, ConfigurableApplicationContext, ConfigurableWebApplicationContext, HierarchicalBeanFactory, Lifecycle, ListableBeanFactory, MessageSource, ResourceLoader, ResourcePatternResolver, WebApplicationContext

All Known Implementing Classes:

DefaultFacesWebApplicationContext

public interface FacesWebApplicationContext
extends ConfigurableWebApplicationContext

Provides configuration for managed beans. Typically managed beans implement the business logic related to the frontend integration.

Implementations should take configuration from faces and spring configuration XML documents.
More precisely config files must be compatible with the following DTD's or schemas:

• web-facesconfig_1_0.dtd
• web-facesconfig_1_1.dtd
• spring-beans.dtd
• spring-beans-2.0.dtd
• spring-beans-2.0.xsd

By default, the configuration will be taken from "/WEB-INF/faces-config.xml" (JSF-configuration) and from "/WEB-INF/faces-spring-context.xml" (bean definitions in a common spring configuration XML document) for the faces root context, if the files exist. Furthermore configuration will be taken from "/META-INF/faces-config.xml" and from "/META-INF/faces-spring-context.xml" of any deployed jar in the classpath.

The config location defaults can be overridden via the "javax.faces.CONFIG_FILES" context param and also the "faces.spring.CONTEXT_FILES" context param of ContextLoader for configuration files based on the spring beans DTD or schema respectively. Config locations for configuration files based on the spring beans DTD/schema can either denote concrete files like "/WEB-INF/context.xml" or Ant-style patterns like "/WEB-INF/*-context.xml" (see PathMatcher javadoc for pattern details).

Author:

Andreas Kuhrwahl

Field Summary

static java.lang.String	ROOT_FACES_WEB_APPLICATION_CONTEXT_ATTRIBUTE Context attribute to bind faces root WebApplicationContext to on successful startup.
static java.lang.String	SCOPE_APPLICATION Scope identifier for application scope: "application".
static java.lang.String	SCOPE_NONE Scope identifier for none scope: "none".

Fields inherited from interface org.springframework.web.context.ConfigurableWebApplicationContext

CONFIG_LOCATION_DELIMITERS

Fields inherited from interface org.springframework.web.context.WebApplicationContext

ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, SCOPE_GLOBAL_SESSION, SCOPE_REQUEST, SCOPE_SESSION

Fields inherited from interface org.springframework.beans.factory.BeanFactory

FACTORY_BEAN_PREFIX

Fields inherited from interface org.springframework.beans.factory.BeanFactory

FACTORY_BEAN_PREFIX

Fields inherited from interface org.springframework.core.io.support.ResourcePatternResolver

CLASSPATH_ALL_URL_PREFIX

Fields inherited from interface org.springframework.core.io.ResourceLoader

CLASSPATH_URL_PREFIX

Fields inherited from interface org.springframework.beans.factory.BeanFactory

FACTORY_BEAN_PREFIX

Fields inherited from interface org.springframework.beans.factory.BeanFactory

FACTORY_BEAN_PREFIX

Fields inherited from interface org.springframework.core.io.support.ResourcePatternResolver

CLASSPATH_ALL_URL_PREFIX

Fields inherited from interface org.springframework.core.io.ResourceLoader

CLASSPATH_URL_PREFIX

Method Summary

void	setFacesSpringConfigLocations(java.lang.String[] locations) Sets the config locations.

Methods inherited from interface org.springframework.web.context.ConfigurableWebApplicationContext

setConfigLocations, setNamespace, setServletConfig, setServletContext

Methods inherited from interface org.springframework.web.context.WebApplicationContext

getServletContext

Methods inherited from interface org.springframework.context.ApplicationContext

getAutowireCapableBeanFactory, getDisplayName, getParent, getStartupDate

Methods inherited from interface org.springframework.beans.factory.ListableBeanFactory

containsBeanDefinition, getBeanDefinitionCount, getBeanDefinitionNames, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType

Methods inherited from interface org.springframework.beans.factory.BeanFactory

containsBean, getAliases, getBean, getBean, getType, isSingleton

Methods inherited from interface org.springframework.beans.factory.HierarchicalBeanFactory

containsLocalBean, getParentBeanFactory

Methods inherited from interface org.springframework.beans.factory.BeanFactory

containsBean, getAliases, getBean, getBean, getType, isSingleton

Methods inherited from interface org.springframework.context.MessageSource

getMessage, getMessage, getMessage

Methods inherited from interface org.springframework.context.ApplicationEventPublisher

publishEvent

Methods inherited from interface org.springframework.core.io.support.ResourcePatternResolver

getResources

Methods inherited from interface org.springframework.core.io.ResourceLoader

getClassLoader, getResource

Methods inherited from interface org.springframework.context.ConfigurableApplicationContext

addBeanFactoryPostProcessor, close, getBeanFactory, isActive, refresh, registerShutdownHook, setParent

Methods inherited from interface org.springframework.context.ApplicationContext

getAutowireCapableBeanFactory, getDisplayName, getParent, getStartupDate

Methods inherited from interface org.springframework.beans.factory.ListableBeanFactory

containsBeanDefinition, getBeanDefinitionCount, getBeanDefinitionNames, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType

Methods inherited from interface org.springframework.beans.factory.BeanFactory

containsBean, getAliases, getBean, getBean, getType, isSingleton

Methods inherited from interface org.springframework.beans.factory.HierarchicalBeanFactory

containsLocalBean, getParentBeanFactory

Methods inherited from interface org.springframework.beans.factory.BeanFactory

containsBean, getAliases, getBean, getBean, getType, isSingleton

Methods inherited from interface org.springframework.context.MessageSource

getMessage, getMessage, getMessage

Methods inherited from interface org.springframework.context.ApplicationEventPublisher

publishEvent

Methods inherited from interface org.springframework.core.io.support.ResourcePatternResolver

getResources

Methods inherited from interface org.springframework.core.io.ResourceLoader

getClassLoader, getResource

Methods inherited from interface org.springframework.context.Lifecycle

isRunning, start, stop

Field Detail

ROOT_FACES_WEB_APPLICATION_CONTEXT_ATTRIBUTE

static final java.lang.String ROOT_FACES_WEB_APPLICATION_CONTEXT_ATTRIBUTE

Context attribute to bind faces root WebApplicationContext to on successful startup.

Note: If the startup of the root context fails, this attribute can contain an exception or error as value. Use FacesWebApplicationContextUtils for convenient lookup of the root WebApplicationContext.

SCOPE_APPLICATION

static final java.lang.String SCOPE_APPLICATION

Scope identifier for application scope: "application". Similar to standard scope "singleton".

See Also:

Constant Field Values

SCOPE_NONE

static final java.lang.String SCOPE_NONE

Scope identifier for none scope: "none". Similar to standard scope "prototype".

See Also:

Constant Field Values

Method Detail

setFacesSpringConfigLocations

void setFacesSpringConfigLocations(java.lang.String[] locations)

Sets the config locations. Should be config files compatible with the "spring-beans.dtd", "spring-beans-2.0.dtd" respectively the schema "spring-beans-2.0.xsd".

Parameters:

locations - the config locations