KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > openedit > page > PageRequestKeys


1 package com.openedit.page;
2
3 /**
4  * @author Matthew Avery
5  *
6  * Created on Feb 15, 2004
7  *
8  */
9 public interface PageRequestKeys
10 {
11     /**
12      * The HttpServletRequest
13      *
14      * Use "$request" in the Velocity page.
15      */
16     public static final String JavaDoc REQUEST = "request";
17     /**
18      * The HttpServletResponse
19      *
20      * Use "$response" in the Velocity page.
21      */
22     public static final String JavaDoc RESPONSE = "response";
23     /**
24      * The HttpSession
25      *
26      * Use "$session" in the Velocity page.
27      */
28     public static final String JavaDoc SESSION = "session";
29     /**
30      * The ServletContext
31      *
32      * Use "$application" in the Velocity page.
33      */
34     public static final String JavaDoc SERVLET_CONTEXT = "application";
35     /**
36      * The Servlet output stream
37      *
38      * Use "$out" in the Velocity page.
39      */
40     public static final String JavaDoc OUTPUT_STREAM = "out";
41     /**
42      * A writer that wraps the servlet output stream
43      *
44      * Use "$wout" in the Velocity page.
45      */
46     public static final String JavaDoc OUTPUT_WRITER = "wout";
47     /**
48      * The JPublish URLUtilities object which provides several static methods
49      * for manipulating paths.
50      *
51      * Use "$url_util" in the Velocity page.
52      */
53     public static final String JavaDoc URL_UTILITIES = "url_util";
54     /**
55      * The servlet context path, e.g. if the root of an Open Edit site is at
56      * http://mydomain.org/oesite, the "home" variable will contain the String
57      * "oesite".
58      *
59      * Use "$home" in the Velocity page.
60      */
61     public static final String JavaDoc HOME = "home";
62     
63     /**
64      * This is the full address of the web server. i.e. http://www.abc.com:80
65      */
66     public static final String JavaDoc WEB_SERVER_PATH = "webserverpath";
67 /**
68      * This is a relative chunk of the URL path used to help locate relative resources.
69      * If a resource is located at http://mydomain.org/oesite/foo/index.html, the
70      * urlpath variable will contain the String "oesite/foo" so that we can easily
71      * find, for instance, oesite/foo/navbar.html
72      *
73      * Use "$urlpath" in the Velocity page.
74      */
75     public static final String JavaDoc URL_PATH = "urlpath";
76     /**
77      * This is a relative chunk of the filepath used to help locate relative resources
78      * within a Velocity page. for a url of /content/about/about.html -> /content/about
79      *
80      * Use "$filepath" in the Velocity page.
81      */
82     public static final String JavaDoc FILE_PATH = "filepath";
83
84     /**
85      * This is a Browser object, created from the request header that provides
86      * some convenience method for dealing with different browser types and OSes
87      * when different behavior is required.
88      *
89      * Use "$browser" in the Velocity page.
90      */
91     public static final String JavaDoc BROWSER = "browser";
92     /**
93      * If a user is logged in to Open Edit, the User object will be available
94      * in Velocity.
95      *
96      * Use "$user" in the Velocity page.
97      */
98     public static final String JavaDoc USER = "user";
99     /**
100      * A DynamicPage object representing the current page. Page properties
101      * can be accessed by the "get" method of this object.
102      *
103      * Use "$page" in the Velocity page.
104      */
105     public static final String JavaDoc PAGE = "page";
106     
107     /**
108      * An alias for the "page" variable
109      *
110      * Use "$content" in the Velocity page.
111      */
112     public static final String JavaDoc CONTENT = "content";
113     /**
114      * This nifty class instantiation tool is something we found on the Velocity
115      * mailing list. It is used for instantiating new classes within a Velocity
116      * page.
117      *
118      * Use "$classtool" in the Velocity page.
119      */
120     public static final String JavaDoc CLASSTOOL = "classtool";
121
122     /**
123      * A PageStreamer object which allows dynamic pages to make a callback to the
124      * OpenEditEngine in order tor stream in content from other pages.
125      *
126      * Use "$page" in the Velocity page.
127      */
128     public static final String JavaDoc PAGES = "pages";
129     
130     /**
131      * Since not all path actions can be reliably secured we allow all actions to be turned off by
132      * default.
133      */
134     public static final String JavaDoc ALLOWPATHREQUESTACTIONS = "allopathrequestactions";
135     
136     
137     /**
138      * Allows an action to specify an alternative layout.
139      * NOLAYOUT is a valid value
140      */
141     public static final String JavaDoc LAYOUTOVERRIDE = "layoutoverride";
142
143     /**
144      * Allows an action to specify an alternative inner layout. This applies to all inner pages
145      * NOLAYOUT is a valid value
146      */
147     public static final String JavaDoc INNERLAYOUTOVERRIDE = "innerlayoutoverride";
148
149 }
150
Popular Tags