public abstract class

PortletApplicationContextUtils

extends Object
java.lang.Object
   ↳ org.springframework.web.portlet.context.PortletApplicationContextUtils

Class Overview

Convenience methods for retrieving the root WebApplicationContext for a given PortletContext. This is e.g. useful for accessing a Spring context from within custom Portlet implementations.

Summary

Public Constructors
PortletApplicationContextUtils()
Public Methods
static ApplicationContext getRequiredWebApplicationContext(PortletContext pc)
Find the root WebApplicationContext for this portlet application, which is typically loaded via ContextLoaderListener or ContextLoaderServlet.
static ApplicationContext getWebApplicationContext(PortletContext pc)
Find the root WebApplicationContext for this portlet application, which is typically loaded via ContextLoaderListener or ContextLoaderServlet.
static void initPortletPropertySources(MutablePropertySources propertySources, ServletContext servletContext, PortletContext portletContext, PortletConfig portletConfig)
Replace Servlet- and Portlet-based stub property sources with actual instances populated with the given context and config objects.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PortletApplicationContextUtils ()

Public Methods

public static ApplicationContext getRequiredWebApplicationContext (PortletContext pc)

Find the root WebApplicationContext for this portlet application, which is typically loaded via ContextLoaderListener or ContextLoaderServlet.

Will rethrow an exception that happened on root context startup, to differentiate between a failed context startup and no context at all.

Parameters
pc PortletContext to find the web application context for
Returns
  • the root WebApplicationContext for this web app (typed to ApplicationContext to avoid a Servlet API dependency; can usually be casted to WebApplicationContext, but there shouldn't be a need to)
Throws
IllegalStateException if the root WebApplicationContext could not be found

public static ApplicationContext getWebApplicationContext (PortletContext pc)

Find the root WebApplicationContext for this portlet application, which is typically loaded via ContextLoaderListener or ContextLoaderServlet.

Will rethrow an exception that happened on root context startup, to differentiate between a failed context startup and no context at all.

Parameters
pc PortletContext to find the web application context for
Returns
  • the root WebApplicationContext for this web app, or null if none (typed to ApplicationContext to avoid a Servlet API dependency; can usually be casted to WebApplicationContext, but there shouldn't be a need to)

public static void initPortletPropertySources (MutablePropertySources propertySources, ServletContext servletContext, PortletContext portletContext, PortletConfig portletConfig)

Replace Servlet- and Portlet-based stub property sources with actual instances populated with the given context and config objects.