Package com.opensymphony.sitemesh.webapp.decorator

Class DispatchedDecorator

java.lang.Object

com.opensymphony.sitemesh.webapp.decorator.BaseWebAppDecorator

com.opensymphony.sitemesh.webapp.decorator.DispatchedDecorator

All Implemented Interfaces:

Decorator

Direct Known Subclasses:

ExternalDispatchedDecorator

public class DispatchedDecorator
extends BaseWebAppDecorator

Decorator that dispatches to another path in the Servlet Container (such as a JSP or path mapped to a Servlet).

The Content and SiteMeshContext objects are passed to the decorator using the HttpServletRequest attributes CONTENT_KEY and CONTEXT_KEY.

To dispatch to a decorator in another web-app on the same server, use ExternalDispatchedDecorator.

Since:

SiteMesh 3.0

Author:

Joe Walnes

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_KEY	The Constant CONTENT_KEY.
static final String	CONTEXT_KEY	The Constant CONTEXT_KEY.

Constructor Summary

Constructors

Constructor	Description
DispatchedDecorator(String path)	Instantiates a new dispatched decorator.

Method Summary

Modifier and Type	Method	Description
protected javax.servlet.ServletContext	locateWebApp(javax.servlet.ServletContext context)	Locate web app.
protected void	render(Content content, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext servletContext, SiteMeshWebAppContext webAppContext)	Render.

Methods inherited from class com.opensymphony.sitemesh.webapp.decorator.BaseWebAppDecorator

render

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CONTENT_KEY

public static final String CONTENT_KEY

The Constant CONTENT_KEY.

See Also:

• Constant Field Values

CONTEXT_KEY

public static final String CONTEXT_KEY

The Constant CONTEXT_KEY.

See Also:

• Constant Field Values

Constructor Details

DispatchedDecorator

public DispatchedDecorator(String path)

Instantiates a new dispatched decorator.

Parameters:

path - the path

Method Details

render

protected void render(Content content,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response,
 javax.servlet.ServletContext servletContext,
 SiteMeshWebAppContext webAppContext)
               throws IOException,
javax.servlet.ServletException

Render.

Specified by:

render in class BaseWebAppDecorator

Parameters:

content - the content

request - the request

response - the response

servletContext - the servlet context

webAppContext - the web app context

Throws:

IOException - Signals that an I/O exception has occurred.

javax.servlet.ServletException - the servlet exception

locateWebApp

protected javax.servlet.ServletContext locateWebApp(javax.servlet.ServletContext context)

Locate web app.

Parameters:

context - the context

Returns:

the servlet context