PortalReservedParameters (Jetspeed-2 Core API 2.3.1 API)

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

Version:

$Id: PortalReservedParameters.java 1687969 2015-06-27 22:00:01Z taylor $

Author:

David Sean Taylor

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTION_PIPELINE`
`static String`	`CONFIG_PIPELINE`
`static String`	`CONFIG_PIPELINE_NAME`
`static String`	`CONTENT_PATH_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`	`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`	`PAGE_THEME_RESPONSIVE`
`static String`	`PARAMETER_ALREADY_DECODED_ATTRIBUTE`
`static String`	`PATH_ATTRIBUTE`
`static String`	`PIPELINE`
`static String`	`PORTAL_FILTER_ATTRIBUTE`
`static String`	`PORTAL_SITE_REQUEST_CONTEXT_ATTR_KEY` PORTAL_SITE_REQUEST_CONTEXT_ATTR_KEY - request portal site context attribute key
`static String`	`PORTAL_SITE_SESSION_CONTEXT_ATTR_KEY` PORTAL_SITE_REQUEST_CONTEXT_ATTR_KEY - session portal site context attribute key
`static String`	`PORTLET`
`static String`	`PORTLET_CONTAINER_INVOKER_USE_FORWARD`
`static String`	`PORTLET_CONTENT_ATTRIBUTE`
`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_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 String`	`PORTLET_EXTENDED_DESCRIPTOR_PREVIEW_IMAGE` A portlet can have a specific setting for the preview image.
`static String`	`PORTLET_EXTENDED_DESCRIPTOR_REFRESH_FUNCTION` A portlet can have a specific setting for the automatic refresh function that will be called when refreshing the portlet.
`static String`	`PORTLET_EXTENDED_DESCRIPTOR_REFRESH_RATE` A portlet can have a specific setting for the refresh rate for automatically re-rendering the portlet.
`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_FILTER_MANAGER_ATTRIBUTE`
`static String`	`PORTLET_ICON_BASE_PATH` A portlet can have a specific setting for the context relative base path of portlet icon image resources.
`static String`	`PORTLET_ICON_HOLDER` A portlet application can have a specific setting for the portlet icon holder, either 'portlet' or 'portal'.
`static String`	`PORTLET_MODE`
`static String`	`PORTLET_PIPELINE`
`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`	`REQUEST_DIAGNOSTICS_ATTRIBUTE`
`static String`	`RESOLVER_CACHE_ATTR`
`static String`	`SESSION_KEY_SUBJECT`
`static String`	`SESSION_OPEN_ID_PROVIDER`
`static String`	`USER_HOMEPAGE_REFRESH_FLAG`
`static String`	`USER_HOMEPAGE_TEMPLATE_PATH`
`static String`	`WINDOW_STATE`

- Field Detail
  - PORTLET
```
static final String PORTLET
```
    See Also:
    Constant Field Values
  - PORTLET_ENTITY
```
static final String PORTLET_ENTITY
```
    See Also:
    Constant Field Values
  - PORTLET_MODE
```
static final String PORTLET_MODE
```
    See Also:
    Constant Field Values
  - WINDOW_STATE
```
static final String WINDOW_STATE
```
    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
  - SESSION_OPEN_ID_PROVIDER
```
static final String SESSION_OPEN_ID_PROVIDER
```
    See Also:
    Constant Field Values
  - REQUEST_CONTEXT_ATTRIBUTE
```
static final String REQUEST_CONTEXT_ATTRIBUTE
```
    See Also:
    Constant Field Values
  - REQUEST_DIAGNOSTICS_ATTRIBUTE
```
static final String REQUEST_DIAGNOSTICS_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
  - PORTLET_CONTENT_ATTRIBUTE
```
static final String PORTLET_CONTENT_ATTRIBUTE
```
    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
  - CONTENT_PATH_ATTRIBUTE
```
static final String CONTENT_PATH_ATTRIBUTE
```
    See Also:
    Constant Field Values
  - PARAMETER_ALREADY_DECODED_ATTRIBUTE
```
static final String PARAMETER_ALREADY_DECODED_ATTRIBUTE
```
    See Also:
    Constant Field Values
  - RESOLVER_CACHE_ATTR
```
static final String RESOLVER_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
  - PORTLET_FILTER_MANAGER_ATTRIBUTE
```
static final String PORTLET_FILTER_MANAGER_ATTRIBUTE
```
    See Also:
    Constant Field Values
  - PAGE_THEME_ATTRIBUTE
```
static final String PAGE_THEME_ATTRIBUTE
```
    See Also:
    Constant Field Values
  - PAGE_THEME_RESPONSIVE
```
static final String PAGE_THEME_RESPONSIVE
```
    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
  - PORTLET_CONTAINER_INVOKER_USE_FORWARD
```
static final String PORTLET_CONTAINER_INVOKER_USE_FORWARD
```
    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
  - USER_HOMEPAGE_REFRESH_FLAG
```
static final String USER_HOMEPAGE_REFRESH_FLAG
```
    See Also:
    Constant Field Values
  - USER_HOMEPAGE_TEMPLATE_PATH
```
static final String USER_HOMEPAGE_TEMPLATE_PATH
```
    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_OUT_OF_SERVICE
```
static final 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 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 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 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 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
  - PORTAL_SITE_SESSION_CONTEXT_ATTR_KEY
```
static final 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 String PORTAL_SITE_REQUEST_CONTEXT_ATTR_KEY
```
    PORTAL_SITE_REQUEST_CONTEXT_ATTR_KEY - request portal site context attribute key
    
    See Also:
    Constant Field Values
  - PORTLET_EXTENDED_DESCRIPTOR_REFRESH_RATE
```
static final String PORTLET_EXTENDED_DESCRIPTOR_REFRESH_RATE
```
    A portlet can have a specific setting for the refresh rate for automatically re-rendering the portlet. If set to -1 or undefined, no refresh will be executed refresh rate is in seconds
    
    See Also:
    Constant Field Values
  - PORTLET_EXTENDED_DESCRIPTOR_REFRESH_FUNCTION
```
static final String PORTLET_EXTENDED_DESCRIPTOR_REFRESH_FUNCTION
```
    A portlet can have a specific setting for the automatic refresh function that will be called when refreshing the portlet. This setting is dependent on refreshRate.
    
    See Also:
    Constant Field Values

Interface PortalReservedParameters

Field Summary

Field Detail

PORTLET

PORTLET_ENTITY

PORTLET_MODE

WINDOW_STATE

PAGE

PIPELINE

DEFAULT_PIPELINE

PORTLET_PIPELINE

ACTION_PIPELINE

LOGIN_PIPELINE

CONFIG_PIPELINE

DESKTOP_CONFIG_PIPELINE

CONFIG_PIPELINE_NAME

DESKTOP_CONFIG_PIPELINE_NAME

JETSPEED_CONFIG_PIPELINE_NAME

PAGE_ATTRIBUTE

PAGE_EDIT_ACCESS_ATTRIBUTE

SESSION_KEY_SUBJECT

SESSION_OPEN_ID_PROVIDER

REQUEST_CONTEXT_ATTRIBUTE

REQUEST_DIAGNOSTICS_ATTRIBUTE

REQUEST_CONTEXT_OBJECTS

FRAGMENT_ATTRIBUTE

MAXIMIZED_FRAGMENT_ATTRIBUTE

MAXIMIZED_LAYOUT_ATTRIBUTE

JETSPEED_POWER_TOOL_REQ_ATTRIBUTE

PREFERED_LANGUAGE_ATTRIBUTE

PREFERED_LOCALE_ATTRIBUTE

PREFERED_CHARACTERENCODING_ATTRIBUTE

PORTLET_CONTENT_ATTRIBUTE

HEADER_RESOURCE_ATTRIBUTE

HEADER_CONFIGURATION_ATTRIBUTE

HEADER_NAMED_RESOURCE_ATTRIBUTE

HEADER_NAMED_RESOURCE_ADDED_FRAGMENTS_ATTRIBUTE

HEADER_NAMED_RESOURCE_REGISTRY_ATTRIBUTE

PATH_ATTRIBUTE

CONTENT_PATH_ATTRIBUTE

PARAMETER_ALREADY_DECODED_ATTRIBUTE

RESOLVER_CACHE_ATTR

PORTLET_DEFINITION_ATTRIBUTE

PORTLET_WINDOW_ATTRIBUTE

PORTLET_FILTER_MANAGER_ATTRIBUTE

PAGE_THEME_ATTRIBUTE

PAGE_THEME_RESPONSIVE

PAGE_LAYOUT_VIEW

PAGE_LAYOUT_MAX

PAGE_LAYOUT_HELP

PAGE_LAYOUT_EDIT

PAGE_LAYOUT_SOLO

PORTLET_CONTAINER_INVOKER_USE_FORWARD

PAGE_THEME_OVERRIDE_ATTRIBUTE

PORTAL_FILTER_ATTRIBUTE

USER_HOMEPAGE_REFRESH_FLAG

USER_HOMEPAGE_TEMPLATE_PATH

PORTLET_EXTENDED_DESCRIPTOR_NON_STANDARD_ACTION

PORTLET_EXTENDED_DESCRIPTOR_RENDER_TIMEOUT

PORTLET_EXTENDED_DESCRIPTOR_OUT_OF_SERVICE

PORTLET_ICON_HOLDER

PORTLET_ICON_BASE_PATH

PORTLET_EXTENDED_DESCRIPTOR_PREVIEW_IMAGE

PORTLET_EXTENDED_DESCRIPTOR_MERGE_PORTAL_PARAMETERS_WITH_PORTLET_PARAMETERS

PORTLET_EXTENDED_DESCRIPTOR_MERGE_PORTAL_PARAMETERS_BEFORE_PORTLET_PARAMETERS

PORTAL_SITE_SESSION_CONTEXT_ATTR_KEY

PORTAL_SITE_REQUEST_CONTEXT_ATTR_KEY

PORTLET_EXTENDED_DESCRIPTOR_REFRESH_RATE

PORTLET_EXTENDED_DESCRIPTOR_REFRESH_FUNCTION