com.opensymphony.module.sitemesh
Interface RequestConstants

All Known Implementing Classes:

AbstractTag, ApplyDecoratorTag, InlineDecoratorMapper, PageFilter

public interface RequestConstants

A set of static constants of Strings to be used as ServletRequest attribute keys to represent various objects passed between pages.

Version:

$Revision: 1.2 $

Author:

Joe Walnes

See Also:

PageFilter, ApplyDecoratorTag, InlineDecoratorMapper, RobotDecoratorMapper

Field Summary

static String	DECORATOR The name (String) of the Decorator to suggest using.
static String	FILTER_APPLIED Marker that stores a Boolean to state whether the decorator filter has been applied yet to this request.
static String	PAGE Stores Page instance for parsed page to be passed across to Decorator.
static String	ROBOT Marker that stores a Boolean (under the session) to state whether the current session is the session of a web search engine spider.
static String	USING_STREAM Whether the current request should use a binary stream (as opposed to writer).

Field Detail

FILTER_APPLIED

public static final String FILTER_APPLIED

Marker that stores a Boolean to state whether the decorator filter has been applied yet to this request.

See Also:

Constant Field Values

PAGE

public static final String PAGE

Stores Page instance for parsed page to be passed across to Decorator.

See Also:

Constant Field Values

DECORATOR

public static final String DECORATOR

The name (String) of the Decorator to suggest using. This is set by the ApplyDecoratorTag and used by the corresponding DecoratorMapper.

See Also:

Constant Field Values

ROBOT

public static final String ROBOT

Marker that stores a Boolean (under the session) to state whether the current session is the session of a web search engine spider. This is set and used by the RobotDecoratorMapper.

See Also:

Constant Field Values

USING_STREAM

public static final String USING_STREAM

Whether the current request should use a binary stream (as opposed to writer). Used by PageFilter.

See Also:

Constant Field Values