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 929560 2010-03-31 14:51:00Z woonsan $

Author:

David Sean Taylor

Field Summary

static java.lang.String	ACTION_PIPELINE
static java.lang.String	CONFIG_PIPELINE
static java.lang.String	CONFIG_PIPELINE_NAME
static java.lang.String	CONTENT_PATH_ATTRIBUTE
static java.lang.String	DEFAULT_PIPELINE
static java.lang.String	DESKTOP_CONFIG_PIPELINE
static java.lang.String	DESKTOP_CONFIG_PIPELINE_NAME
static java.lang.String	FRAGMENT_ATTRIBUTE
static java.lang.String	HEADER_CONFIGURATION_ATTRIBUTE
static java.lang.String	HEADER_NAMED_RESOURCE_ADDED_FRAGMENTS_ATTRIBUTE
static java.lang.String	HEADER_NAMED_RESOURCE_ATTRIBUTE
static java.lang.String	HEADER_NAMED_RESOURCE_REGISTRY_ATTRIBUTE
static java.lang.String	HEADER_RESOURCE_ATTRIBUTE
static java.lang.String	JETSPEED_CONFIG_PIPELINE_NAME
static java.lang.String	JETSPEED_POWER_TOOL_REQ_ATTRIBUTE
static java.lang.String	LOGIN_PIPELINE
static java.lang.String	MAXIMIZED_FRAGMENT_ATTRIBUTE
static java.lang.String	MAXIMIZED_LAYOUT_ATTRIBUTE
static java.lang.String	PAGE
static java.lang.String	PAGE_ATTRIBUTE
static java.lang.String	PAGE_EDIT_ACCESS_ATTRIBUTE
static java.lang.String	PAGE_LAYOUT_EDIT
static java.lang.String	PAGE_LAYOUT_HELP
static java.lang.String	PAGE_LAYOUT_MAX
static java.lang.String	PAGE_LAYOUT_SOLO
static java.lang.String	PAGE_LAYOUT_VIEW
static java.lang.String	PAGE_THEME_ATTRIBUTE
static java.lang.String	PAGE_THEME_OVERRIDE_ATTRIBUTE Setting this as a session attribute will override all themes declared in psml.
static java.lang.String	PARAMETER_ALREADY_DECODED_ATTRIBUTE
static java.lang.String	PATH_ATTRIBUTE
static java.lang.String	PIPELINE
static java.lang.String	PORTAL_FILTER_ATTRIBUTE
static java.lang.String	PORTAL_SITE_REQUEST_CONTEXT_ATTR_KEY PORTAL_SITE_REQUEST_CONTEXT_ATTR_KEY - request portal site context attribute key
static java.lang.String	PORTAL_SITE_SESSION_CONTEXT_ATTR_KEY PORTAL_SITE_REQUEST_CONTEXT_ATTR_KEY - session portal site context attribute key
static java.lang.String	PORTLET
static java.lang.String	PORTLET_CONTAINER_INVOKER_USE_FORWARD
static java.lang.String	PORTLET_CONTENT_ATTRIBUTE
static java.lang.String	PORTLET_DEFINITION_ATTRIBUTE
static java.lang.String	PORTLET_ENTITY
static java.lang.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 java.lang.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 java.lang.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 java.lang.String	PORTLET_EXTENDED_DESCRIPTOR_OUT_OF_SERVICE A portlet can have a specific setting for the state of out-of-service that the portal will give up on rendering the portlet.
static java.lang.String	PORTLET_EXTENDED_DESCRIPTOR_PREVIEW_IMAGE A portlet can have a specific setting for the preview image.
static java.lang.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 java.lang.String	PORTLET_FILTER_MANAGER_ATTRIBUTE
static java.lang.String	PORTLET_ICON_BASE_PATH A portlet can have a specific setting for the context relative base path of portlet icon image resources.
static java.lang.String	PORTLET_ICON_HOLDER A portlet application can have a specific setting for the portlet icon holder, either 'portlet' or 'portal'.
static java.lang.String	PORTLET_MODE
static java.lang.String	PORTLET_PIPELINE
static java.lang.String	PORTLET_WINDOW_ATTRIBUTE
static java.lang.String	PREFERED_CHARACTERENCODING_ATTRIBUTE
static java.lang.String	PREFERED_LANGUAGE_ATTRIBUTE
static java.lang.String	PREFERED_LOCALE_ATTRIBUTE
static java.lang.String	REQUEST_CONTEXT_ATTRIBUTE
static java.lang.String	REQUEST_CONTEXT_OBJECTS
static java.lang.String	REQUEST_DIAGNOSTICS_ATTRIBUTE
static java.lang.String	RESOVLER_CACHE_ATTR
static java.lang.String	SESSION_KEY_SUBJECT
static java.lang.String	SESSION_OPEN_ID_PROVIDER
static java.lang.String	USER_HOMEPAGE_REFRESH_FLAG
static java.lang.String	USER_HOMEPAGE_TEMPLATE_PATH
static java.lang.String	WINDOW_STATE

Field Detail

PORTLET

static final java.lang.String PORTLET

See Also:

Constant Field Values

PORTLET_ENTITY

static final java.lang.String PORTLET_ENTITY

See Also:

Constant Field Values

PORTLET_MODE

static final java.lang.String PORTLET_MODE

See Also:

Constant Field Values

WINDOW_STATE

static final java.lang.String WINDOW_STATE

See Also:

Constant Field Values

PAGE

static final java.lang.String PAGE

See Also:

Constant Field Values

PIPELINE

static final java.lang.String PIPELINE

See Also:

Constant Field Values

DEFAULT_PIPELINE

static final java.lang.String DEFAULT_PIPELINE

See Also:

Constant Field Values

PORTLET_PIPELINE

static final java.lang.String PORTLET_PIPELINE

See Also:

Constant Field Values

ACTION_PIPELINE

static final java.lang.String ACTION_PIPELINE

See Also:

Constant Field Values

LOGIN_PIPELINE

static final java.lang.String LOGIN_PIPELINE

See Also:

Constant Field Values

CONFIG_PIPELINE

static final java.lang.String CONFIG_PIPELINE

See Also:

Constant Field Values

DESKTOP_CONFIG_PIPELINE

static final java.lang.String DESKTOP_CONFIG_PIPELINE

See Also:

Constant Field Values

CONFIG_PIPELINE_NAME

static final java.lang.String CONFIG_PIPELINE_NAME

See Also:

Constant Field Values

DESKTOP_CONFIG_PIPELINE_NAME

static final java.lang.String DESKTOP_CONFIG_PIPELINE_NAME

See Also:

Constant Field Values

JETSPEED_CONFIG_PIPELINE_NAME

static final java.lang.String JETSPEED_CONFIG_PIPELINE_NAME

See Also:

Constant Field Values

PAGE_ATTRIBUTE

static final java.lang.String PAGE_ATTRIBUTE

See Also:

Constant Field Values

PAGE_EDIT_ACCESS_ATTRIBUTE

static final java.lang.String PAGE_EDIT_ACCESS_ATTRIBUTE

See Also:

Constant Field Values

SESSION_KEY_SUBJECT

static final java.lang.String SESSION_KEY_SUBJECT

See Also:

Constant Field Values

SESSION_OPEN_ID_PROVIDER

static final java.lang.String SESSION_OPEN_ID_PROVIDER

See Also:

Constant Field Values

REQUEST_CONTEXT_ATTRIBUTE

static final java.lang.String REQUEST_CONTEXT_ATTRIBUTE

See Also:

Constant Field Values

REQUEST_DIAGNOSTICS_ATTRIBUTE

static final java.lang.String REQUEST_DIAGNOSTICS_ATTRIBUTE

See Also:

Constant Field Values

REQUEST_CONTEXT_OBJECTS

static final java.lang.String REQUEST_CONTEXT_OBJECTS

See Also:

Constant Field Values

FRAGMENT_ATTRIBUTE

static final java.lang.String FRAGMENT_ATTRIBUTE

See Also:

Constant Field Values

MAXIMIZED_FRAGMENT_ATTRIBUTE

static final java.lang.String MAXIMIZED_FRAGMENT_ATTRIBUTE

See Also:

Constant Field Values

MAXIMIZED_LAYOUT_ATTRIBUTE

static final java.lang.String MAXIMIZED_LAYOUT_ATTRIBUTE

See Also:

Constant Field Values

JETSPEED_POWER_TOOL_REQ_ATTRIBUTE

static final java.lang.String JETSPEED_POWER_TOOL_REQ_ATTRIBUTE

See Also:

Constant Field Values

PREFERED_LANGUAGE_ATTRIBUTE

static final java.lang.String PREFERED_LANGUAGE_ATTRIBUTE

See Also:

Constant Field Values

PREFERED_LOCALE_ATTRIBUTE

static final java.lang.String PREFERED_LOCALE_ATTRIBUTE

See Also:

Constant Field Values

PREFERED_CHARACTERENCODING_ATTRIBUTE

static final java.lang.String PREFERED_CHARACTERENCODING_ATTRIBUTE

See Also:

Constant Field Values

PORTLET_CONTENT_ATTRIBUTE

static final java.lang.String PORTLET_CONTENT_ATTRIBUTE

See Also:

Constant Field Values

HEADER_RESOURCE_ATTRIBUTE

static final java.lang.String HEADER_RESOURCE_ATTRIBUTE

See Also:

Constant Field Values

HEADER_CONFIGURATION_ATTRIBUTE

static final java.lang.String HEADER_CONFIGURATION_ATTRIBUTE

See Also:

Constant Field Values

HEADER_NAMED_RESOURCE_ATTRIBUTE

static final java.lang.String HEADER_NAMED_RESOURCE_ATTRIBUTE

See Also:

Constant Field Values

HEADER_NAMED_RESOURCE_ADDED_FRAGMENTS_ATTRIBUTE

static final java.lang.String HEADER_NAMED_RESOURCE_ADDED_FRAGMENTS_ATTRIBUTE

See Also:

Constant Field Values

HEADER_NAMED_RESOURCE_REGISTRY_ATTRIBUTE

static final java.lang.String HEADER_NAMED_RESOURCE_REGISTRY_ATTRIBUTE

See Also:

Constant Field Values

PATH_ATTRIBUTE

static final java.lang.String PATH_ATTRIBUTE

See Also:

Constant Field Values

CONTENT_PATH_ATTRIBUTE

static final java.lang.String CONTENT_PATH_ATTRIBUTE

See Also:

Constant Field Values

PARAMETER_ALREADY_DECODED_ATTRIBUTE

static final java.lang.String PARAMETER_ALREADY_DECODED_ATTRIBUTE

See Also:

Constant Field Values

RESOVLER_CACHE_ATTR

static final java.lang.String RESOVLER_CACHE_ATTR

See Also:

Constant Field Values

PORTLET_DEFINITION_ATTRIBUTE

static final java.lang.String PORTLET_DEFINITION_ATTRIBUTE

See Also:

Constant Field Values

PORTLET_WINDOW_ATTRIBUTE

static final java.lang.String PORTLET_WINDOW_ATTRIBUTE

See Also:

Constant Field Values

PORTLET_FILTER_MANAGER_ATTRIBUTE

static final java.lang.String PORTLET_FILTER_MANAGER_ATTRIBUTE

See Also:

Constant Field Values

PAGE_THEME_ATTRIBUTE

static final java.lang.String PAGE_THEME_ATTRIBUTE

See Also:

Constant Field Values

PAGE_LAYOUT_VIEW

static final java.lang.String PAGE_LAYOUT_VIEW

See Also:

Constant Field Values

PAGE_LAYOUT_MAX

static final java.lang.String PAGE_LAYOUT_MAX

See Also:

Constant Field Values

PAGE_LAYOUT_HELP

static final java.lang.String PAGE_LAYOUT_HELP

See Also:

Constant Field Values

PAGE_LAYOUT_EDIT

static final java.lang.String PAGE_LAYOUT_EDIT

See Also:

Constant Field Values

PAGE_LAYOUT_SOLO

static final java.lang.String PAGE_LAYOUT_SOLO

See Also:

Constant Field Values

PORTLET_CONTAINER_INVOKER_USE_FORWARD

static final java.lang.String PORTLET_CONTAINER_INVOKER_USE_FORWARD

See Also:

Constant Field Values

PAGE_THEME_OVERRIDE_ATTRIBUTE

static final java.lang.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 java.lang.String PORTAL_FILTER_ATTRIBUTE

See Also:

Constant Field Values

USER_HOMEPAGE_REFRESH_FLAG

static final java.lang.String USER_HOMEPAGE_REFRESH_FLAG

See Also:

Constant Field Values

USER_HOMEPAGE_TEMPLATE_PATH

static final java.lang.String USER_HOMEPAGE_TEMPLATE_PATH

See Also:

Constant Field Values

PORTLET_EXTENDED_DESCRIPTOR_NON_STANDARD_ACTION

static final java.lang.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 java.lang.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_OUT_OF_SERVICE

static final java.lang.String PORTLET_EXTENDED_DESCRIPTOR_OUT_OF_SERVICE

A portlet can have a specific setting for the state of out-of-service that the portal will give up on rendering the portlet. The value is 'true' or 'false'.

See Also:

Constant Field Values

PORTLET_ICON_HOLDER

static final java.lang.String PORTLET_ICON_HOLDER

A portlet application can have a specific setting for the portlet icon holder, either 'portlet' or 'portal'. If it is set to 'portlet', then the portlet icon images are located in the portlet application resources. If it is set to 'portal', then the portlet icon images are located in the portal application resources. The portlet icon holder application type, either 'portlet' or 'portal'.

See Also:

Constant Field Values

PORTLET_ICON_BASE_PATH

static final java.lang.String PORTLET_ICON_BASE_PATH

A portlet can have a specific setting for the context relative base path of portlet icon image resources. The portlet icon resource context relative base path.

See Also:

Constant Field Values

PORTLET_EXTENDED_DESCRIPTOR_PREVIEW_IMAGE

static final java.lang.String PORTLET_EXTENDED_DESCRIPTOR_PREVIEW_IMAGE

A portlet can have a specific setting for the preview image. The portlet preview image url

See Also:

Constant Field Values

PORTLET_EXTENDED_DESCRIPTOR_MERGE_PORTAL_PARAMETERS_WITH_PORTLET_PARAMETERS

static final java.lang.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 java.lang.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

PORTAL_SITE_SESSION_CONTEXT_ATTR_KEY

static final java.lang.String PORTAL_SITE_SESSION_CONTEXT_ATTR_KEY

PORTAL_SITE_REQUEST_CONTEXT_ATTR_KEY - session portal site context attribute key

See Also:

Constant Field Values

PORTAL_SITE_REQUEST_CONTEXT_ATTR_KEY

static final java.lang.String PORTAL_SITE_REQUEST_CONTEXT_ATTR_KEY

PORTAL_SITE_REQUEST_CONTEXT_ATTR_KEY - request portal site context attribute key

See Also:

Constant Field Values