001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: */
017: package org.apache.jetspeed;
018:
019: /**
020: * PortalReservedParameters. The constants here define HTTP request parameters
021: * reserved for use by the Jetspeed Portal.
022: *
023: * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
024: * @version $Id: PortalReservedParameters.java 569464 2007-08-24 17:43:28Z taylor $
025: */
026: public interface PortalReservedParameters {
027: public final static String PORTLET = "portlet";
028: public final static String PORTLET_ENTITY = "entity";
029: public final static String PAGE = "page";
030: public final static String PIPELINE = "pipeline";
031: public final static String DEFAULT_PIPELINE = "jetspeed-pipeline";
032: public final static String PORTLET_PIPELINE = "portlet-pipeline";
033: public final static String ACTION_PIPELINE = "action-pipeline";
034: public final static String LOGIN_PIPELINE = "login-pipeline";
035: public final static String CONFIG_PIPELINE = "config-pipeline";
036: public final static String DESKTOP_CONFIG_PIPELINE = "dtconfig-pipeline";
037: public final static String CONFIG_PIPELINE_NAME = "ConfigurePipeline";
038: public final static String DESKTOP_CONFIG_PIPELINE_NAME = "DesktopConfigurePipeline";
039: public final static String JETSPEED_CONFIG_PIPELINE_NAME = "JetspeedPipeline";
040:
041: // Session and Request attribute keys
042: public static final String PAGE_ATTRIBUTE = "org.apache.jetspeed.Page";
043: public static final String PAGE_EDIT_ACCESS_ATTRIBUTE = "org.apache.jetspeed.decoration.PageEditAccess";
044: public static final String SESSION_KEY_SUBJECT = "org.apache.jetspeed.security.subject";
045: public static final String REQUEST_CONTEXT_ATTRIBUTE = "org.apache.jetspeed.request.RequestContext";
046: public static final String REQUEST_CONTEXT_OBJECTS = "org.apache.jetspeed.request.RequestContextObjects";
047: public static final String FRAGMENT_ATTRIBUTE = "org.apache.jetspeed.Fragment";
048: public static final String MAXIMIZED_FRAGMENT_ATTRIBUTE = "org.apache.jetspeed.maximized.Fragment";
049: public static final String MAXIMIZED_LAYOUT_ATTRIBUTE = "org.apache.jetspeed.maximized.Layout";
050: public static final String JETSPEED_POWER_TOOL_REQ_ATTRIBUTE = "org.apache.jetspeed.velocity.JetspeedPowerTool";
051: public static final String PREFERED_LANGUAGE_ATTRIBUTE = "org.apache.jetspeed.prefered.language";
052: public static final String PREFERED_LOCALE_ATTRIBUTE = "org.apache.jetspeed.prefered.locale";
053: public static final String PREFERED_CHARACTERENCODING_ATTRIBUTE = "org.apache.jetspeed.prefered.characterencoding";
054: public static final String CONTENT_DISPATCHER_ATTRIBUTE = "org.apache.jetspeed.ContentDispatcher";
055: public static final String OVERRIDE_PORTLET_TITLE_ATTR = "org.apache.jetspeed.portlet.title";
056: public static final String HEADER_RESOURCE_ATTRIBUTE = "org.apache.jetspeed.headerresource";
057: public static final String HEADER_CONFIGURATION_ATTRIBUTE = "org.apache.jetspeed.headerconfiguration";
058: public static final String HEADER_NAMED_RESOURCE_ATTRIBUTE = "org.apache.jetspeed.headernamedresource";
059: public static final String HEADER_NAMED_RESOURCE_ADDED_FRAGMENTS_ATTRIBUTE = "org.apache.jetspeed.headernamedresourceaddedfragments";
060: public static final String HEADER_NAMED_RESOURCE_REGISTRY_ATTRIBUTE = "org.apache.jetspeed.headernamedresourceregistry";
061: public static final String PATH_ATTRIBUTE = "org.apache.jetspeed.Path";
062: public static final String PARAMETER_ALREADY_DECODED_ATTRIBUTE = "org.apache.jetspeed.parameterAlreadyDecoded";
063: public static final String RESOVLER_CACHE_ATTR = "org.apache.jetspeed.resovler.cache";
064: public static final String PORTLET_DEFINITION_ATTRIBUTE = "org.apache.jetspeed.portlet.definition";
065: public static final String PORTLET_WINDOW_ATTRIBUTE = "org.apache.jetspeed.portlet.window";
066: public static final String PAGE_THEME_ATTRIBUTE = "org.apache.jetspeed.theme";
067: public static final String PAGE_LAYOUT_VIEW = "org.apache.jetspeed.layout.view";
068: public static final String PAGE_LAYOUT_MAX = "org.apache.jetspeed.layout.max";
069: public static final String PAGE_LAYOUT_HELP = "org.apache.jetspeed.layout.help";
070: public static final String PAGE_LAYOUT_EDIT = "org.apache.jetspeed.layout.edit";
071: public static final String PAGE_LAYOUT_SOLO = "org.apache.jetspeed.layout.solo";
072:
073: /**
074: * Setting this as a session attribute will override all themes declared in
075: * psml. Sample values are "Simple", "tigris", "jetspeed"
076: */
077: public static final String PAGE_THEME_OVERRIDE_ATTRIBUTE = "org.apache.jetspeed.theme.override";
078: public static final String PORTAL_FILTER_ATTRIBUTE = "org.apache.jetspeed.login.filter.PortalFilter";
079:
080: //
081: // Settings for Metadata on jetspeed-portlet.xml
082: //
083: /**
084: * Actions can be marked as non-standard if they don't participate in
085: * JSR-168 standard action behavior. By default, actions are supposed
086: * to clear the cache of all other portlets on the page.
087: * By setting this parameter, we can ignore the standard behavior
088: * and not clear the cache on actions. This is useful for portlets
089: * which never participate with other portlets.
090: */
091: public static final String PORTLET_EXTENDED_DESCRIPTOR_NON_STANDARD_ACTION = "nonStandardAction";
092: /**
093: * A portlet can have a specific setting for the timeout duration that the portal will wait
094: * before it gives up on rendering the portlet. This value overrides the system setting.
095: * The timeout value is in milliseconds
096: */
097: public static final String PORTLET_EXTENDED_DESCRIPTOR_RENDER_TIMEOUT = "timeout";
098:
099: /**
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: }
|