org.apache.jetspeed
Interface PortalReservedParameters

public interface PortalReservedParameters

PortalReservedParameters. The constants here define HTTP request parameters reserved for use by the Jetspeed Portal.

Version:

$Id: PortalReservedParameters.java 569464 2007-08-24 17:43:28Z taylor $

Author:

David Sean Taylor

Field Summary

static String	ACTION_PIPELINE
static String	CONFIG_PIPELINE
static String	CONFIG_PIPELINE_NAME
static String	CONTENT_DISPATCHER_ATTRIBUTE
static String	DEFAULT_PIPELINE
static String	DESKTOP_CONFIG_PIPELINE
static String	DESKTOP_CONFIG_PIPELINE_NAME
static String	FRAGMENT_ATTRIBUTE
static String	HEADER_CONFIGURATION_ATTRIBUTE
static String	HEADER_NAMED_RESOURCE_ADDED_FRAGMENTS_ATTRIBUTE
static String	HEADER_NAMED_RESOURCE_ATTRIBUTE
static String	HEADER_NAMED_RESOURCE_REGISTRY_ATTRIBUTE
static String	HEADER_RESOURCE_ATTRIBUTE
static String	JETSPEED_CONFIG_PIPELINE_NAME
static String	JETSPEED_POWER_TOOL_REQ_ATTRIBUTE
static String	LOGIN_PIPELINE
static String	MAXIMIZED_FRAGMENT_ATTRIBUTE
static String	MAXIMIZED_LAYOUT_ATTRIBUTE
static String	OVERRIDE_PORTLET_TITLE_ATTR
static String	PAGE
static String	PAGE_ATTRIBUTE
static String	PAGE_EDIT_ACCESS_ATTRIBUTE
static String	PAGE_LAYOUT_EDIT
static String	PAGE_LAYOUT_HELP
static String	PAGE_LAYOUT_MAX
static String	PAGE_LAYOUT_SOLO
static String	PAGE_LAYOUT_VIEW
static String	PAGE_THEME_ATTRIBUTE
static String	PAGE_THEME_OVERRIDE_ATTRIBUTE Setting this as a session attribute will override all themes declared in psml.
static String	PARAMETER_ALREADY_DECODED_ATTRIBUTE
static String	PATH_ATTRIBUTE
static String	PIPELINE
static String	PORTAL_FILTER_ATTRIBUTE
static String	PORTLET
static String	PORTLET_DEFINITION_ATTRIBUTE
static String	PORTLET_ENTITY
static String	PORTLET_EXTENDED_DESCRIPTOR_MERGE_PORTAL_PARAMETERS_BEFORE_PORTLET_PARAMETERS Until version 2.1, Jetspeed merged portal request parameters with portlet specific parameters, effectively allowing "shared" parameters.
static String	PORTLET_EXTENDED_DESCRIPTOR_MERGE_PORTAL_PARAMETERS_WITH_PORTLET_PARAMETERS Until version 2.1, Jetspeed merged portal request parameters with portlet specific parameters, effectively allowing "shared" parameters.
static String	PORTLET_EXTENDED_DESCRIPTOR_NON_STANDARD_ACTION Actions can be marked as non-standard if they don't participate in JSR-168 standard action behavior.
static String	PORTLET_EXTENDED_DESCRIPTOR_RENDER_TIMEOUT A portlet can have a specific setting for the timeout duration that the portal will wait before it gives up on rendering the portlet.
static String	PORTLET_PIPELINE
static String	PORTLET_RESOURCE_URL_REQUEST_PARAMETER Preliminary Portlet API 2.0 ResourceURL support.
static String	PORTLET_WINDOW_ATTRIBUTE
static String	PREFERED_CHARACTERENCODING_ATTRIBUTE
static String	PREFERED_LANGUAGE_ATTRIBUTE
static String	PREFERED_LOCALE_ATTRIBUTE
static String	REQUEST_CONTEXT_ATTRIBUTE
static String	REQUEST_CONTEXT_OBJECTS
static String	RESOVLER_CACHE_ATTR
static String	SESSION_KEY_SUBJECT

Field Detail

PORTLET

static final String PORTLET

See Also:

Constant Field Values

PORTLET_ENTITY

static final String PORTLET_ENTITY

See Also:

Constant Field Values

PAGE

static final String PAGE

See Also:

Constant Field Values

PIPELINE

static final String PIPELINE

See Also:

Constant Field Values

DEFAULT_PIPELINE

static final String DEFAULT_PIPELINE

See Also:

Constant Field Values

PORTLET_PIPELINE

static final String PORTLET_PIPELINE

See Also:

Constant Field Values

ACTION_PIPELINE

static final String ACTION_PIPELINE

See Also:

Constant Field Values

LOGIN_PIPELINE

static final String LOGIN_PIPELINE

See Also:

Constant Field Values

CONFIG_PIPELINE

static final String CONFIG_PIPELINE

See Also:

Constant Field Values

DESKTOP_CONFIG_PIPELINE

static final String DESKTOP_CONFIG_PIPELINE

See Also:

Constant Field Values

CONFIG_PIPELINE_NAME

static final String CONFIG_PIPELINE_NAME

See Also:

Constant Field Values

DESKTOP_CONFIG_PIPELINE_NAME

static final String DESKTOP_CONFIG_PIPELINE_NAME

See Also:

Constant Field Values

JETSPEED_CONFIG_PIPELINE_NAME

static final String JETSPEED_CONFIG_PIPELINE_NAME

See Also:

Constant Field Values

PAGE_ATTRIBUTE

static final String PAGE_ATTRIBUTE

See Also:

Constant Field Values

PAGE_EDIT_ACCESS_ATTRIBUTE

static final String PAGE_EDIT_ACCESS_ATTRIBUTE

See Also:

Constant Field Values

SESSION_KEY_SUBJECT

static final String SESSION_KEY_SUBJECT

See Also:

Constant Field Values

REQUEST_CONTEXT_ATTRIBUTE

static final String REQUEST_CONTEXT_ATTRIBUTE

See Also:

Constant Field Values

REQUEST_CONTEXT_OBJECTS

static final String REQUEST_CONTEXT_OBJECTS

See Also:

Constant Field Values

FRAGMENT_ATTRIBUTE

static final String FRAGMENT_ATTRIBUTE

See Also:

Constant Field Values

MAXIMIZED_FRAGMENT_ATTRIBUTE

static final String MAXIMIZED_FRAGMENT_ATTRIBUTE

See Also:

Constant Field Values

MAXIMIZED_LAYOUT_ATTRIBUTE

static final String MAXIMIZED_LAYOUT_ATTRIBUTE

See Also:

Constant Field Values

JETSPEED_POWER_TOOL_REQ_ATTRIBUTE

static final String JETSPEED_POWER_TOOL_REQ_ATTRIBUTE

See Also:

Constant Field Values

PREFERED_LANGUAGE_ATTRIBUTE

static final String PREFERED_LANGUAGE_ATTRIBUTE

See Also:

Constant Field Values

PREFERED_LOCALE_ATTRIBUTE

static final String PREFERED_LOCALE_ATTRIBUTE

See Also:

Constant Field Values

PREFERED_CHARACTERENCODING_ATTRIBUTE

static final String PREFERED_CHARACTERENCODING_ATTRIBUTE

See Also:

Constant Field Values

CONTENT_DISPATCHER_ATTRIBUTE

static final String CONTENT_DISPATCHER_ATTRIBUTE

See Also:

Constant Field Values

OVERRIDE_PORTLET_TITLE_ATTR

static final String OVERRIDE_PORTLET_TITLE_ATTR

See Also:

Constant Field Values

HEADER_RESOURCE_ATTRIBUTE

static final String HEADER_RESOURCE_ATTRIBUTE

See Also:

Constant Field Values

HEADER_CONFIGURATION_ATTRIBUTE

static final String HEADER_CONFIGURATION_ATTRIBUTE

See Also:

Constant Field Values

HEADER_NAMED_RESOURCE_ATTRIBUTE

static final String HEADER_NAMED_RESOURCE_ATTRIBUTE

See Also:

Constant Field Values

HEADER_NAMED_RESOURCE_ADDED_FRAGMENTS_ATTRIBUTE

static final String HEADER_NAMED_RESOURCE_ADDED_FRAGMENTS_ATTRIBUTE

See Also:

Constant Field Values

HEADER_NAMED_RESOURCE_REGISTRY_ATTRIBUTE

static final String HEADER_NAMED_RESOURCE_REGISTRY_ATTRIBUTE

See Also:

Constant Field Values

PATH_ATTRIBUTE

static final String PATH_ATTRIBUTE

See Also:

Constant Field Values

PARAMETER_ALREADY_DECODED_ATTRIBUTE

static final String PARAMETER_ALREADY_DECODED_ATTRIBUTE

See Also:

Constant Field Values

RESOVLER_CACHE_ATTR

static final String RESOVLER_CACHE_ATTR

See Also:

Constant Field Values

PORTLET_DEFINITION_ATTRIBUTE

static final String PORTLET_DEFINITION_ATTRIBUTE

See Also:

Constant Field Values

PORTLET_WINDOW_ATTRIBUTE

static final String PORTLET_WINDOW_ATTRIBUTE

See Also:

Constant Field Values

PAGE_THEME_ATTRIBUTE

static final String PAGE_THEME_ATTRIBUTE

See Also:

Constant Field Values

PAGE_LAYOUT_VIEW

static final String PAGE_LAYOUT_VIEW

See Also:

Constant Field Values

PAGE_LAYOUT_MAX

static final String PAGE_LAYOUT_MAX

See Also:

Constant Field Values

PAGE_LAYOUT_HELP

static final String PAGE_LAYOUT_HELP

See Also:

Constant Field Values

PAGE_LAYOUT_EDIT

static final String PAGE_LAYOUT_EDIT

See Also:

Constant Field Values

PAGE_LAYOUT_SOLO

static final String PAGE_LAYOUT_SOLO

See Also:

Constant Field Values

PAGE_THEME_OVERRIDE_ATTRIBUTE

static final String PAGE_THEME_OVERRIDE_ATTRIBUTE

Setting this as a session attribute will override all themes declared in psml. Sample values are "Simple", "tigris", "jetspeed"

See Also:

Constant Field Values

PORTAL_FILTER_ATTRIBUTE

static final String PORTAL_FILTER_ATTRIBUTE

See Also:

Constant Field Values

PORTLET_EXTENDED_DESCRIPTOR_NON_STANDARD_ACTION

static final String PORTLET_EXTENDED_DESCRIPTOR_NON_STANDARD_ACTION

Actions can be marked as non-standard if they don't participate in JSR-168 standard action behavior. By default, actions are supposed to clear the cache of all other portlets on the page. By setting this parameter, we can ignore the standard behavior and not clear the cache on actions. This is useful for portlets which never participate with other portlets.

See Also:

Constant Field Values

PORTLET_EXTENDED_DESCRIPTOR_RENDER_TIMEOUT

static final String PORTLET_EXTENDED_DESCRIPTOR_RENDER_TIMEOUT

A portlet can have a specific setting for the timeout duration that the portal will wait before it gives up on rendering the portlet. This value overrides the system setting. The timeout value is in milliseconds

See Also:

Constant Field Values

PORTLET_EXTENDED_DESCRIPTOR_MERGE_PORTAL_PARAMETERS_WITH_PORTLET_PARAMETERS

static final String PORTLET_EXTENDED_DESCRIPTOR_MERGE_PORTAL_PARAMETERS_WITH_PORTLET_PARAMETERS

Until version 2.1, Jetspeed merged portal request parameters with portlet specific parameters, effectively allowing "shared" parameters.

This is not compliant with the JSR-168 PLT.11, so by default this is now disabled through global settings in jetspeed.properties:

    merge.portal.parameters.with.portlet.parameters=false
    merge.portal.parameters.before.portlet.parameters=false
  

To support legacy portlets still relying on the "old" behavior these default global settings can be overridden by defining these values in the portlet Metadata too.

Setting merge.portal.parameters.with.portlet.parameters=true will "restore" the old behavior and merge the portal parameters with the portlet parameters.

See Also:

Constant Field Values

PORTLET_EXTENDED_DESCRIPTOR_MERGE_PORTAL_PARAMETERS_BEFORE_PORTLET_PARAMETERS

static final String PORTLET_EXTENDED_DESCRIPTOR_MERGE_PORTAL_PARAMETERS_BEFORE_PORTLET_PARAMETERS

Until version 2.1, Jetspeed merged portal request parameters with portlet specific parameters, effectively allowing "shared" parameters.

This is not compliant with the JSR-168 PLT.11, so by default this is now disabled through global settings in jetspeed.properties:

    merge.portal.parameters.with.portlet.parameters=false
    merge.portal.parameters.before.portlet.parameters=false
  

To support legacy portlets still relying on the "old" behavior these default global settings can be overridden by defining these values in the portlet Metadata too.

In the situation of portal and portlet parameters with the same name, by default the portlet parameters will be provided first in the values array, but this can be overridden by setting merge.portal.parameters.before.portlet.parameters=true.

See Also:

Constant Field Values

PORTLET_RESOURCE_URL_REQUEST_PARAMETER

static final String PORTLET_RESOURCE_URL_REQUEST_PARAMETER

Preliminary Portlet API 2.0 ResourceURL support. By setting the RenderURL parameter PORTLET_RESOURCE_URL_REQUEST_PARAMETER (with whatever value) the Jetspeed encoded PortletURL will be marked as a ResourceURL (the parameter itself will not be stored). By invoking such a Render/ResourceURL, NavigationalState.getPortletWindowOfResource() will be set, and with an custom Valve (example implementation o.a.j.resource.ResourceValveImpl) this PortletWindow can be invoked directly, similar as an ActionURL but as a direct Portlet Render request.

See Also:

Constant Field Values