public interface

ConfigurablePortletApplicationContext

implements ConfigurableApplicationContext WebApplicationContext

org.springframework.web.portlet.context.ConfigurablePortletApplicationContext

Known Indirect Subclasses

AbstractRefreshablePortletApplicationContext, StaticPortletApplicationContext, XmlPortletApplicationContext

Class Overview

Interface to be implemented by configurable portlet application contexts. Supported by FrameworkPortlet.

Note: The setters of this interface need to be called before an invocation of the refresh() method inherited from ConfigurableApplicationContext. They do not cause an initialization of the context on their own.

Summary

Constants
String	PORTLET_CONFIG_BEAN_NAME	Name of the PortletConfig environment bean in the factory.
String	PORTLET_CONTEXT_BEAN_NAME	Name of the PortletContext environment bean in the factory.

[Expand]

Inherited Constants

From interface org.springframework.beans.factory.BeanFactory

From interface org.springframework.context.ConfigurableApplicationContext

From interface org.springframework.core.io.ResourceLoader

From interface org.springframework.core.io.support.ResourcePatternResolver

From interface org.springframework.web.context.WebApplicationContext

Fields
public static final String	APPLICATION_CONTEXT_ID_PREFIX	Prefix for ApplicationContext ids that refer to portlet name.

[Expand]

Inherited Fields

From interface org.springframework.web.context.WebApplicationContext

Public Methods
abstract String[]	getConfigLocations() Return the config locations for this web application context, or `null` if none specified.
abstract String	getNamespace() Return the namespace for this web application context, if any.
abstract PortletConfig	getPortletConfig() Return the PortletConfig for this portlet application context, if any.
abstract PortletContext	getPortletContext() Return the standard Portlet API PortletContext for this application.
abstract void	setConfigLocation(String configLocation) Set the config locations for this portlet application context in init-param style, i.e.
abstract void	setConfigLocations(String[] configLocations) Set the config locations for this portlet application context.
abstract void	setNamespace(String namespace) Set the namespace for this portlet application context, to be used for building a default context config location.
abstract void	setPortletConfig(PortletConfig portletConfig) Set the PortletConfig for this portlet application context.
abstract void	setPortletContext(PortletContext portletContext) Set the PortletContext for this portlet application context.

[Expand]

Inherited Methods

From interface org.springframework.beans.factory.BeanFactory

abstract boolean	containsBean(String name) Does this bean factory contain a bean with the given name? More specifically, is `getBean(Class)` able to obtain a bean instance for the given name? Translates aliases back to the corresponding canonical bean name.
abstract String[]	getAliases(String name) Return the aliases for the given bean name, if any.
abstract Object	getBean(String name) Return an instance, which may be shared or independent, of the specified bean.
abstract Object	getBean(String name, Object... args) Return an instance, which may be shared or independent, of the specified bean.
abstract <T> T	getBean(Class<T> requiredType) Return the bean instance that uniquely matches the given object type, if any.
abstract <T> T	getBean(String name, Class<T> requiredType) Return an instance, which may be shared or independent, of the specified bean.
abstract Class<?>	getType(String name) Determine the type of the bean with the given name.
abstract boolean	isPrototype(String name) Is this bean a prototype? That is, will `getBean(Class)` always return independent instances? Note: This method returning `false` does not clearly indicate a singleton object.
abstract boolean	isSingleton(String name) Is this bean a shared singleton? That is, will `getBean(Class)` always return the same instance? Note: This method returning `false` does not clearly indicate independent instances.
abstract boolean	isTypeMatch(String name, Class<?> targetType) Check whether the bean with the given name matches the specified type.

From interface org.springframework.beans.factory.HierarchicalBeanFactory

From interface org.springframework.beans.factory.ListableBeanFactory

abstract boolean	containsBeanDefinition(String beanName) Check if this bean factory contains a bean definition with the given name.
abstract <A extends Annotation> A	findAnnotationOnBean(String beanName, Class<A> annotationType) Find a `Annotation` of `annotationType` on the specified bean, traversing its interfaces and super classes if no annotation can be found on the given class itself.
abstract int	getBeanDefinitionCount() Return the number of beans defined in the factory.
abstract String[]	getBeanDefinitionNames() Return the names of all beans defined in this factory.
abstract String[]	getBeanNamesForType(Class<?> type, boolean includeNonSingletons, boolean allowEagerInit) Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
abstract String[]	getBeanNamesForType(Class<?> type) Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
abstract <T> Map<String, T>	getBeansOfType(Class<T> type) Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
abstract <T> Map<String, T>	getBeansOfType(Class<T> type, boolean includeNonSingletons, boolean allowEagerInit) Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
abstract Map<String, Object>	getBeansWithAnnotation(Class<? extends Annotation> annotationType) Find all beans whose `Class` has the supplied `Annotation` type.

From interface org.springframework.context.ApplicationContext

From interface org.springframework.context.ApplicationEventPublisher

From interface org.springframework.context.ConfigurableApplicationContext

abstract void	addApplicationListener(ApplicationListener<?> listener) Add a new ApplicationListener that will be notified on context events such as context refresh and context shutdown.
abstract void	addBeanFactoryPostProcessor(BeanFactoryPostProcessor beanFactoryPostProcessor) Add a new BeanFactoryPostProcessor that will get applied to the internal bean factory of this application context on refresh, before any of the bean definitions get evaluated.
abstract void	close() Close this application context, releasing all resources and locks that the implementation might hold.
abstract ConfigurableListableBeanFactory	getBeanFactory() Return the internal bean factory of this application context.
abstract ConfigurableEnvironment	getEnvironment() Return the Environment for this application context in configurable form.
abstract boolean	isActive() Determine whether this application context is active, that is, whether it has been refreshed at least once and has not been closed yet.
abstract void	refresh() Load or refresh the persistent representation of the configuration, which might an XML file, properties file, or relational database schema.
abstract void	registerShutdownHook() Register a shutdown hook with the JVM runtime, closing this context on JVM shutdown unless it has already been closed at that time.
abstract void	setEnvironment(ConfigurableEnvironment environment) Set the `Environment` for this application context.
abstract void	setId(String id) Set the unique id of this application context.
abstract void	setParent(ApplicationContext parent) Set the parent of this application context.

From interface org.springframework.context.Lifecycle

From interface org.springframework.context.MessageSource

From interface org.springframework.core.env.EnvironmentCapable

From interface org.springframework.core.io.ResourceLoader

From interface org.springframework.core.io.support.ResourcePatternResolver

From interface org.springframework.web.context.WebApplicationContext

Constants

public static final String PORTLET_CONFIG_BEAN_NAME

Name of the PortletConfig environment bean in the factory.

public static final String PORTLET_CONTEXT_BEAN_NAME

Name of the PortletContext environment bean in the factory.

Fields

public static final String APPLICATION_CONTEXT_ID_PREFIX

Prefix for ApplicationContext ids that refer to portlet name.

Public Methods

public abstract String[] getConfigLocations ()

Return the config locations for this web application context, or null if none specified.

public abstract String getNamespace ()

Return the namespace for this web application context, if any.

public abstract PortletConfig getPortletConfig ()

Return the PortletConfig for this portlet application context, if any.

public abstract PortletContext getPortletContext ()

Return the standard Portlet API PortletContext for this application.

public abstract void setConfigLocation (String configLocation)

Set the config locations for this portlet application context in init-param style, i.e. with distinct locations separated by commas, semicolons or whitespace.

If not set, the implementation is supposed to use a default for the given namespace.

public abstract void setConfigLocations (String[] configLocations)

Set the config locations for this portlet application context.

If not set, the implementation is supposed to use a default for the given namespace.

public abstract void setNamespace (String namespace)

Set the namespace for this portlet application context, to be used for building a default context config location.

public abstract void setPortletConfig (PortletConfig portletConfig)

Set the PortletConfig for this portlet application context.

public abstract void setPortletContext (PortletContext portletContext)

Set the PortletContext for this portlet application context.

Does not cause an initialization of the context: refresh needs to be called after the setting of all configuration properties.

Interfaces

Classes

ConfigurablePortletApplicationContext

Class Overview

See Also

Summary

Constants

public static final String PORTLET_CONFIG_BEAN_NAME

See Also

public static final String PORTLET_CONTEXT_BEAN_NAME

See Also

Fields

public static final String APPLICATION_CONTEXT_ID_PREFIX

Public Methods

public abstract String[] getConfigLocations ()

public abstract String getNamespace ()

public abstract PortletConfig getPortletConfig ()

public abstract PortletContext getPortletContext ()

public abstract void setConfigLocation (String configLocation)

public abstract void setConfigLocations (String[] configLocations)

public abstract void setNamespace (String namespace)

public abstract void setPortletConfig (PortletConfig portletConfig)

See Also

public abstract void setPortletContext (PortletContext portletContext)

See Also