org.jasig.springframework.web.portlet.context
Interface PortletApplicationContext

All Superinterfaces:

org.springframework.context.ApplicationContext, org.springframework.context.ApplicationEventPublisher, org.springframework.beans.factory.BeanFactory, org.springframework.context.ConfigurableApplicationContext, org.springframework.web.portlet.context.ConfigurablePortletApplicationContext, org.springframework.core.env.EnvironmentCapable, org.springframework.beans.factory.HierarchicalBeanFactory, org.springframework.context.Lifecycle, org.springframework.beans.factory.ListableBeanFactory, org.springframework.context.MessageSource, org.springframework.core.io.ResourceLoader, org.springframework.core.io.support.ResourcePatternResolver, org.springframework.web.context.WebApplicationContext

All Known Implementing Classes:

ContribStaticPortletApplicationContext, ContribXmlPortletApplicationContext

public interface PortletApplicationContext
extends org.springframework.web.portlet.context.ConfigurablePortletApplicationContext

Interface to provide configuration for a web application. This is read-only while the application is running, but may be reloaded if the implementation supports this.

This interface adds a getServletContext() method to the generic ApplicationContext interface, and defines a well-known application attribute name that the root context must be bound to in the bootstrap process.

Like generic application contexts, web application contexts are hierarchical. There is a single root context per application, while each servlet in the application (including a dispatcher servlet in the MVC framework) has its own child context.

In addition to standard application context lifecycle capabilities, WebApplicationContext implementations need to detect ServletContextAware beans and invoke the setServletContext method accordingly.

Author:

Eric Dalquist

See Also:

TODO make {@link ConfigurablePortletApplicationContext} implement this interface

Field Summary

static String	APPLICATION_CONTEXT_ID_PREFIX Prefix for ApplicationContext ids that refer to portlet name.
static String	PORTLET_CONTEXT_BEAN_NAME Name of the PortletContext environment bean in the factory.
static String	ROOT_PORTLET_APPLICATION_CONTEXT_ATTRIBUTE Context attribute to bind root PortletApplicationContext to on successful startup.

Fields inherited from interface org.springframework.web.portlet.context.ConfigurablePortletApplicationContext

PORTLET_CONFIG_BEAN_NAME

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

CONTEXT_ATTRIBUTES_BEAN_NAME, CONTEXT_PARAMETERS_BEAN_NAME, ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, SCOPE_APPLICATION, SCOPE_GLOBAL_SESSION, SCOPE_REQUEST, SCOPE_SESSION, SERVLET_CONTEXT_BEAN_NAME

Fields inherited from interface org.springframework.context.ConfigurableApplicationContext

CONFIG_LOCATION_DELIMITERS, CONVERSION_SERVICE_BEAN_NAME, ENVIRONMENT_BEAN_NAME, LOAD_TIME_WEAVER_BEAN_NAME, SYSTEM_ENVIRONMENT_BEAN_NAME, SYSTEM_PROPERTIES_BEAN_NAME

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

javax.portlet.PortletContext

getPortletContext() Return the standard Portlet API PortletContext for this application.

Methods inherited from interface org.springframework.web.portlet.context.ConfigurablePortletApplicationContext

getConfigLocations, getNamespace, getPortletConfig, setConfigLocation, setConfigLocations, setNamespace, setPortletConfig, setPortletContext

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

getServletContext

Methods inherited from interface org.springframework.context.ConfigurableApplicationContext

addApplicationListener, addBeanFactoryPostProcessor, close, getBeanFactory, getEnvironment, isActive, refresh, registerShutdownHook, setEnvironment, setId, setParent

Methods inherited from interface org.springframework.context.ApplicationContext

getAutowireCapableBeanFactory, getDisplayName, getId, getParent, getStartupDate

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

containsBeanDefinition, findAnnotationOnBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType, getBeansWithAnnotation

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

containsLocalBean, getParentBeanFactory

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

containsBean, getAliases, getBean, getBean, getBean, getBean, getType, isPrototype, isSingleton, isTypeMatch

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_PORTLET_APPLICATION_CONTEXT_ATTRIBUTE

static final String ROOT_PORTLET_APPLICATION_CONTEXT_ATTRIBUTE

Context attribute to bind root PortletApplicationContext to on successful startup.

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

See Also:

PortletApplicationContextUtils2.getPortletApplicationContext(PortletContext), PortletApplicationContextUtils2.getRequiredPortletApplicationContext(PortletContext)

APPLICATION_CONTEXT_ID_PREFIX

static final String APPLICATION_CONTEXT_ID_PREFIX

Prefix for ApplicationContext ids that refer to portlet name. TODO move from ConfigurablePortletApplicationContext when this becomes part of spring

PORTLET_CONTEXT_BEAN_NAME

static final String PORTLET_CONTEXT_BEAN_NAME

Name of the PortletContext environment bean in the factory.

See Also:

TODO move from ConfigurablePortletApplicationContext when this becomes part of spring, Constant Field Values

Method Detail

getPortletContext

javax.portlet.PortletContext getPortletContext()

Return the standard Portlet API PortletContext for this application.

Specified by:

getPortletContext in interface org.springframework.web.portlet.context.ConfigurablePortletApplicationContext