Save This Page
1 /*
2 * Title: RequestConstants
3 * Description:
4 *
5 * This software is published under the terms of the OpenSymphony Software
6 * License version 1.1, of which a copy has been included with this
7 * distribution in the LICENSE.txt file.
8 */
9
10 package com.opensymphony.module.sitemesh;
11
12 /**
13 * A set of static constants of Strings to be used as ServletRequest attribute keys
14 * to represent various objects passed between pages.
15 *
16 * @author <a href="joe@truemesh.com">Joe Walnes</a>
17 * @version $Revision: 1.2 $
18 *
19 * @see com.opensymphony.module.sitemesh.filter.PageFilter
20 * @see com.opensymphony.module.sitemesh.taglib.page.ApplyDecoratorTag
21 * @see com.opensymphony.module.sitemesh.mapper.InlineDecoratorMapper
22 * @see com.opensymphony.module.sitemesh.mapper.RobotDecoratorMapper
23 */
24 public interface RequestConstants {
25 /**
26 * Marker that stores a Boolean to state whether the decorator filter
27 * has been applied yet to this request.
28 */
29 String FILTER_APPLIED = "__sitemesh__filterapplied";
30
31 /**
32 * Stores {@link com.opensymphony.module.sitemesh.Page} instance for parsed page to be
33 * passed across to {@link com.opensymphony.module.sitemesh.Decorator}.
34 */
35 String PAGE = "__sitemesh__page";
36
37 /**
38 * The name (String) of the Decorator to suggest using. This is set by
39 * the {@link com.opensymphony.module.sitemesh.taglib.page.ApplyDecoratorTag}
40 * and used by the corresponding {@link com.opensymphony.module.sitemesh.DecoratorMapper}.
41 */
42 String DECORATOR = "__sitemesh__decorator";
43
44 /**
45 * Marker that stores a Boolean (under the session) to state whether the current
46 * session is the session of a web search engine spider. This is set and used by the
47 * {@link com.opensymphony.module.sitemesh.mapper.RobotDecoratorMapper}.
48 */
49 String ROBOT = "__sitemesh__robot";
50
51 /**
52 * Whether the current request should use a binary stream (as opposed to writer).
53 * Used by {@link com.opensymphony.module.sitemesh.filter.PageFilter}.
54 */
55 String USING_STREAM = "__sitemesh__using_stream";
56 }