1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.jetspeed;
18
19 /***
20 * PortalReservedParameters. The constants here define HTTP request parameters
21 * reserved for use by the Jetspeed Portal.
22 *
23 * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
24 * @version $Id: PortalReservedParameters.java 553375 2007-07-05 05:37:00Z taylor $
25 */
26 public interface PortalReservedParameters
27 {
28 public final static String PORTLET = "portlet";
29 public final static String PORTLET_ENTITY = "entity";
30 public final static String PAGE = "page";
31 public final static String PIPELINE = "pipeline";
32 public final static String DEFAULT_PIPELINE = "jetspeed-pipeline";
33 public final static String PORTLET_PIPELINE = "portlet-pipeline";
34 public final static String ACTION_PIPELINE = "action-pipeline";
35 public final static String LOGIN_PIPELINE = "login-pipeline";
36 public final static String CONFIG_PIPELINE = "config-pipeline";
37 public final static String DESKTOP_CONFIG_PIPELINE = "dtconfig-pipeline";
38 public final static String CONFIG_PIPELINE_NAME = "ConfigurePipeline";
39 public final static String DESKTOP_CONFIG_PIPELINE_NAME = "DesktopConfigurePipeline";
40
41
42 public static final String PAGE_ATTRIBUTE = "org.apache.jetspeed.Page";
43 public static final String PAGE_EDIT_ACCESS_ATTRIBUTE = "org.apache.jetspeed.decoration.PageEditAccess";
44 public static final String SESSION_KEY_SUBJECT = "org.apache.jetspeed.security.subject";
45 public static final String REQUEST_CONTEXT_ATTRIBUTE = "org.apache.jetspeed.request.RequestContext";
46 public static final String REQUEST_CONTEXT_OBJECTS = "org.apache.jetspeed.request.RequestContextObjects";
47 public static final String FRAGMENT_ATTRIBUTE = "org.apache.jetspeed.Fragment";
48 public static final String MAXIMIZED_FRAGMENT_ATTRIBUTE = "org.apache.jetspeed.maximized.Fragment";
49 public static final String MAXIMIZED_LAYOUT_ATTRIBUTE = "org.apache.jetspeed.maximized.Layout";
50 public static final String JETSPEED_POWER_TOOL_REQ_ATTRIBUTE = "org.apache.jetspeed.velocity.JetspeedPowerTool";
51 public static final String PREFERED_LANGUAGE_ATTRIBUTE = "org.apache.jetspeed.prefered.language";
52 public static final String PREFERED_LOCALE_ATTRIBUTE = "org.apache.jetspeed.prefered.locale";
53 public static final String PREFERED_CHARACTERENCODING_ATTRIBUTE = "org.apache.jetspeed.prefered.characterencoding";
54 public static final String CONTENT_DISPATCHER_ATTRIBUTE = "org.apache.jetspeed.ContentDispatcher";
55 public static final String OVERRIDE_PORTLET_TITLE_ATTR = "org.apache.jetspeed.portlet.title";
56 public static final String HEADER_RESOURCE_ATTRIBUTE = "org.apache.jetspeed.headerresource";
57 public static final String HEADER_CONFIGURATION_ATTRIBUTE = "org.apache.jetspeed.headerconfiguration";
58 public static final String HEADER_NAMED_RESOURCE_ATTRIBUTE = "org.apache.jetspeed.headernamedresource";
59 public static final String HEADER_NAMED_RESOURCE_ADDED_FRAGMENTS_ATTRIBUTE = "org.apache.jetspeed.headernamedresourceaddedfragments";
60 public static final String HEADER_NAMED_RESOURCE_REGISTRY_ATTRIBUTE = "org.apache.jetspeed.headernamedresourceregistry";
61 public static final String PATH_ATTRIBUTE = "org.apache.jetspeed.Path";
62 public static final String PARAMETER_ALREADY_DECODED_ATTRIBUTE = "org.apache.jetspeed.parameterAlreadyDecoded";
63 public static final String RESOVLER_CACHE_ATTR = "org.apache.jetspeed.resovler.cache";
64 public static final String PORTLET_DEFINITION_ATTRIBUTE = "org.apache.jetspeed.portlet.definition";
65 public static final String PORTLET_WINDOW_ATTRIBUTE = "org.apache.jetspeed.portlet.window";
66 public static final String PAGE_THEME_ATTRIBUTE = "org.apache.jetspeed.theme";
67 public static final String PAGE_LAYOUT_VIEW = "org.apache.jetspeed.layout.view";
68 public static final String PAGE_LAYOUT_MAX = "org.apache.jetspeed.layout.max";
69 public static final String PAGE_LAYOUT_HELP = "org.apache.jetspeed.layout.help";
70 public static final String PAGE_LAYOUT_EDIT = "org.apache.jetspeed.layout.edit";
71 public static final String PAGE_LAYOUT_SOLO = "org.apache.jetspeed.layout.solo";
72
73 /***
74 * Setting this as a session attribute will override all themes declared in
75 * psml. Sample values are "Simple", "tigris", "jetspeed"
76 */
77 public static final String PAGE_THEME_OVERRIDE_ATTRIBUTE = "org.apache.jetspeed.theme.override";
78 public static final String PORTAL_FILTER_ATTRIBUTE = "org.apache.jetspeed.login.filter.PortalFilter";
79
80
81
82
83 /***
84 * Actions can be marked as non-standard if they don't participate in
85 * JSR-168 standard action behavior. By default, actions are supposed
86 * to clear the cache of all other portlets on the page.
87 * By setting this parameter, we can ignore the standard behavior
88 * and not clear the cache on actions. This is useful for portlets
89 * which never participate with other portlets.
90 */
91 public static final String PORTLET_EXTENDED_DESCRIPTOR_NON_STANDARD_ACTION = "nonStandardAction";
92 /***
93 * A portlet can have a specific setting for the timeout duration that the portal will wait
94 * before it gives up on rendering the portlet. This value overrides the system setting.
95 * The timeout value is in milliseconds
96 */
97 public static final String PORTLET_EXTENDED_DESCRIPTOR_RENDER_TIMEOUT = "timeout";
98
99 /***
100 * Until version 2.1, Jetspeed merged portal request parameters with portlet specific
101 * parameters, effectively allowing "shared" parameters.
102 * <p>
103 * This is not compliant with the JSR-168 PLT.11, so by default this is now disabled
104 * through global settings in jetspeed.properties:
105 * <pre>
106 * merge.portal.parameters.with.portlet.parameters=false
107 * merge.portal.parameters.before.portlet.parameters=false
108 * </pre>
109 * <p>
110 * To support legacy portlets still relying on the "old" behavior these default global
111 * settings can be overridden by defining these values in the portlet Metadata too.
112 * </p>
113 * <p>
114 * Setting merge.portal.parameters.with.portlet.parameters=true will "restore" the old behavior and
115 * merge the portal parameters with the portlet parameters.
116 * </p>
117 */
118 public static final String PORTLET_EXTENDED_DESCRIPTOR_MERGE_PORTAL_PARAMETERS_WITH_PORTLET_PARAMETERS = "merge.portal.parameters.with.portlet.parameters";
119
120 /***
121 * Until version 2.1, Jetspeed merged portal request parameters with portlet specific
122 * parameters, effectively allowing "shared" parameters.
123 * <p>
124 * This is not compliant with the JSR-168 PLT.11, so by default this is now disabled
125 * through global settings in jetspeed.properties:
126 * <pre>
127 * merge.portal.parameters.with.portlet.parameters=false
128 * merge.portal.parameters.before.portlet.parameters=false
129 * </pre>
130 * <p>
131 * To support legacy portlets still relying on the "old" behavior these default global
132 * settings can be overridden by defining these values in the portlet Metadata too.
133 * </p>
134 * <p>
135 * In the situation of portal and portlet parameters with the same name, by default
136 * the portlet parameters will be provided first in the values array, but this
137 * can be overridden by setting merge.portal.parameters.before.portlet.parameters=true.
138 * </p>
139 */
140 public static final String PORTLET_EXTENDED_DESCRIPTOR_MERGE_PORTAL_PARAMETERS_BEFORE_PORTLET_PARAMETERS = "merge.portal.parameters.before.portlet.parameters";
141
142 /***
143 * Preliminary Portlet API 2.0 ResourceURL support.
144 * By setting the RenderURL parameter PORTLET_RESOURCE_URL_REQUEST_PARAMETER (with whatever value) the Jetspeed encoded PortletURL
145 * will be marked as a ResourceURL (the parameter itself will not be stored).
146 * By invoking such a Render/ResourceURL, NavigationalState.getPortletWindowOfResource() will be set, and with an custom Valve
147 * (example implementation o.a.j.resource.ResourceValveImpl) this PortletWindow can be invoked directly,
148 * similar as an ActionURL but as a direct Portlet Render request.
149 */
150 public static final String PORTLET_RESOURCE_URL_REQUEST_PARAMETER = "org.apache.jetspeed.portlet.resource.url";
151 }