lumis.portal

Class PortalRequestParameters

java.lang.Object

lumis.portal.PortalRequestParameters

public class PortalRequestParameters
extends Object

Object representing portal parameters.

Since:

4.0.0

Version:

$Revision: 22607 $ $Date: 2019-03-29 16:36:23 +0000 (Fri, 29 Mar 2019) $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PortalRequestParameters.PreviousParameters The previous parameters of a page.

Field Summary

Fields

Modifier and Type	Field and Description
static String	II_PARAMETER_PORTLET_MODE Parameter at service interface instance scope that stores the portlet mode.
static String	II_PARAMETER_WINDOW_STATE Parameter at service interface instance scope that stores the window state.
static String	PAGE_PARAMETER_CALLER_INTERFACE_INST
static String	PAGE_PARAMETER_CALLER_SERVICE_INST The parameter name used to provide the identifier of the service instance that is the caller of the current operation.
static String	PAGE_PARAMETER_CALLER_SERVICE_INTERFACE_MENU_ITEM The parameter name used to identify the caller service interface menu item for which an interface is being executed.
static String	PAGE_PARAMETER_CALLER_SERVICE_INTERFACE_MENU_LEVEL The parameter name used to provide the level of the service interface menu on the caller for which an interface is being executed.
static String	PAGE_PARAMETER_CHANNELID
static String	PAGE_PARAMETER_CLIENT_MESSAGE
static String	PAGE_PARAMETER_CLIENT_SCRIPT_REQUEST
static String	PAGE_PARAMETER_CLIENTRENDERED
static String	PAGE_PARAMETER_DATA_PREVIEW_MODE
static String	PAGE_PARAMETER_FROM_ERROR
static String	PAGE_PARAMETER_FROM_FORM
static String	PAGE_PARAMETER_FROM_PCM
static String	PAGE_PARAMETER_HIGHLIGHT_INTERFACE_INST
static String	PAGE_PARAMETER_INTERFACE
static String	PAGE_PARAMETER_INTERFACE_INST
static String	PAGE_PARAMETER_ITEM_ID
static String	PAGE_PARAMETER_ITEMID
static String	PAGE_PARAMETER_LOCALE
static String	PAGE_PARAMETER_NEW
static String	PAGE_PARAMETER_ORIGINAL_PAGEID
static String	PAGE_PARAMETER_ORIGINAL_URL
static String	PAGE_PARAMETER_PAGE_CACHE_ID
static String	PAGE_PARAMETER_PAGEID
static String	PAGE_PARAMETER_PREVIEW_ITEMID
static String	PAGE_PARAMETER_PREVIOUS
static String	PAGE_PARAMETER_PREVIOUS_STORAGE_ID Stores the id that identifies the previous parameter in the session object.
static String	PAGE_PARAMETER_PRINTING
static String	PAGE_PARAMETER_PROCESS_ACTION
static String	PAGE_PARAMETER_REFERER The location when the interface is client side.
static String	PAGE_PARAMETER_RENDER_INTERFACE_INST
static String	PAGE_PARAMETER_REPLACE_INTERFACE_COMMANDS
static String	PAGE_PARAMETER_REPLACE_INTERFACE_PARAMS
static String	PAGE_PARAMETER_REPLACE_INTERFACES_STATE
static String	PAGE_PARAMETER_REQUEST_FROM_HTML_FILE
static String	PAGE_PARAMETER_RESIZE_CLIENT_WINDOW
static String	PAGE_PARAMETER_RUN_TIME_INTERFACE
static String	PAGE_PARAMETER_RUN_TIME_SERVICE_INST
static String	PAGE_PARAMETER_SAFE_RENDER_MODE
static String	PAGE_PARAMETER_SAVE_XML
static String	PAGE_PARAMETER_SERVICE
static String	PAGE_PARAMETER_SERVICE_INST
static String	PAGE_PARAMETER_TEMPORARY_MODE The parameter name used to represent the local mode.
static String	PAGE_PARAMETER_TOGGLE_MODE_ORIGINAL_URL The parameter name used to represent toggle the current mode.
static String	PAGE_PARAMETER_WRITER_KEYS Optional multi-valued parameter that contains the PortalPrintWriter keys already used in the page.
static String	URL_REPLACEABLE_PARAMETER_PAGEID

Constructor Summary

Constructors

Constructor and Description
PortalRequestParameters(SessionConfig sessionConfig)
PortalRequestParameters(SessionConfig sessionConfig, HttpServletRequest httpServletRequest)
PortalRequestParameters(SessionConfig sessionConfig, String parametersXmlString)

Method Summary

Modifier and Type	Method and Description
void	applyServiceInterfaceInstanceParameters(String serviceInterfaceInstanceId, Map<String,String[]> parameters) Applies service interface instance parameters, keeping previous values for portlet mode or window state parameters, if each did not change.
PortalRequestParameters.PreviousParameters	generatePreviousParameters(HttpServletRequest request) Generate the previous parameters for this portal request parameters instance, storing it for automatic later retrieval.
String	getPageParameterValue(String name)
String	getPreviousParametersStorageId() Returns the previous parameters storage id.
FileParameter	getServiceInterfaceInstanceFileParameterValue(String name, String serviceInterfaceInstanceId)
Enumeration<String>	getServiceInterfaceInstanceParameterNames(String serviceInterfaceInstanceId)
Map<String,String[]>	getServiceInterfaceInstanceParameters(String serviceInterfaceInstanceId)
String	getServiceInterfaceInstanceParameterValue(String name, String serviceInterfaceInstanceId)
String[]	getServiceInterfaceInstanceParameterValues(String name, String serviceInterfaceInstanceId)
static boolean	isReservedParameter(String parameterName) Indicates if the parameter is reserved for special use by the portal and may not be freely used by an installed application.
void	setPageParameter(String parameterName, String[] parameterValues)
void	setPageParameters(Map<String,String[]> parameters)
HashMap<String,String[]>	setParameters(Document parametersDoc)
void	setParameters(String parametersXmlString)
void	setServiceInstanceParameters(String serviceInstanceId, Map<String,String[]> parameters)
void	setServiceInterfaceInstanceFileParameters(String serviceInterfaceInstanceId, Map<String,FileParameter> parameters)
void	setServiceInterfaceInstanceParameters(String serviceInterfaceInstanceId, Map<String,String[]> parameters)
void	setServiceInterfaceParameters(String serviceInterfaceId, Map<String,String[]> parameters)
void	setServiceParameters(String serviceId, Map<String,String[]> parameters)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PAGE_PARAMETER_CLIENT_SCRIPT_REQUEST

public static final String PAGE_PARAMETER_CLIENT_SCRIPT_REQUEST

See Also:

Constant Field Values

PAGE_PARAMETER_PRINTING

public static final String PAGE_PARAMETER_PRINTING

See Also:

Constant Field Values

PAGE_PARAMETER_FROM_PCM

public static final String PAGE_PARAMETER_FROM_PCM

See Also:

Constant Field Values

PAGE_PARAMETER_SAVE_XML

public static final String PAGE_PARAMETER_SAVE_XML

See Also:

Constant Field Values

PAGE_PARAMETER_RENDER_INTERFACE_INST

public static final String PAGE_PARAMETER_RENDER_INTERFACE_INST

See Also:

Constant Field Values

PAGE_PARAMETER_CALLER_INTERFACE_INST

public static final String PAGE_PARAMETER_CALLER_INTERFACE_INST

See Also:

Constant Field Values

PAGE_PARAMETER_PREVIEW_ITEMID

public static final String PAGE_PARAMETER_PREVIEW_ITEMID

See Also:

Constant Field Values

PAGE_PARAMETER_DATA_PREVIEW_MODE

public static final String PAGE_PARAMETER_DATA_PREVIEW_MODE

See Also:

Constant Field Values

PAGE_PARAMETER_ITEMID

public static final String PAGE_PARAMETER_ITEMID

See Also:

Constant Field Values

PAGE_PARAMETER_ITEM_ID

public static final String PAGE_PARAMETER_ITEM_ID

See Also:

Constant Field Values

PAGE_PARAMETER_RUN_TIME_INTERFACE

public static final String PAGE_PARAMETER_RUN_TIME_INTERFACE

See Also:

Constant Field Values

PAGE_PARAMETER_RUN_TIME_SERVICE_INST

public static final String PAGE_PARAMETER_RUN_TIME_SERVICE_INST

See Also:

Constant Field Values

PAGE_PARAMETER_SERVICE_INST

public static final String PAGE_PARAMETER_SERVICE_INST

See Also:

Constant Field Values

PAGE_PARAMETER_SERVICE

public static final String PAGE_PARAMETER_SERVICE

See Also:

Constant Field Values

PAGE_PARAMETER_INTERFACE

public static final String PAGE_PARAMETER_INTERFACE

See Also:

Constant Field Values

PAGE_PARAMETER_INTERFACE_INST

public static final String PAGE_PARAMETER_INTERFACE_INST

See Also:

Constant Field Values

PAGE_PARAMETER_NEW

public static final String PAGE_PARAMETER_NEW

See Also:

Constant Field Values

PAGE_PARAMETER_PREVIOUS

public static final String PAGE_PARAMETER_PREVIOUS

See Also:

Constant Field Values

PAGE_PARAMETER_PROCESS_ACTION

public static final String PAGE_PARAMETER_PROCESS_ACTION

See Also:

Constant Field Values

PAGE_PARAMETER_PAGEID

public static final String PAGE_PARAMETER_PAGEID

See Also:

Constant Field Values

PAGE_PARAMETER_CHANNELID

public static final String PAGE_PARAMETER_CHANNELID

See Also:

Constant Field Values

PAGE_PARAMETER_CLIENTRENDERED

public static final String PAGE_PARAMETER_CLIENTRENDERED

See Also:

Constant Field Values

PAGE_PARAMETER_REQUEST_FROM_HTML_FILE

public static final String PAGE_PARAMETER_REQUEST_FROM_HTML_FILE

See Also:

Constant Field Values

PAGE_PARAMETER_PAGE_CACHE_ID

public static final String PAGE_PARAMETER_PAGE_CACHE_ID

See Also:

Constant Field Values

PAGE_PARAMETER_LOCALE

public static final String PAGE_PARAMETER_LOCALE

See Also:

Constant Field Values

PAGE_PARAMETER_FROM_FORM

public static final String PAGE_PARAMETER_FROM_FORM

See Also:

Constant Field Values

PAGE_PARAMETER_HIGHLIGHT_INTERFACE_INST

public static final String PAGE_PARAMETER_HIGHLIGHT_INTERFACE_INST

See Also:

Constant Field Values

PAGE_PARAMETER_REPLACE_INTERFACE_COMMANDS

public static final String PAGE_PARAMETER_REPLACE_INTERFACE_COMMANDS

See Also:

Constant Field Values

PAGE_PARAMETER_REPLACE_INTERFACE_PARAMS

public static final String PAGE_PARAMETER_REPLACE_INTERFACE_PARAMS

See Also:

Constant Field Values

PAGE_PARAMETER_REPLACE_INTERFACES_STATE

public static final String PAGE_PARAMETER_REPLACE_INTERFACES_STATE

See Also:

Constant Field Values

PAGE_PARAMETER_RESIZE_CLIENT_WINDOW

public static final String PAGE_PARAMETER_RESIZE_CLIENT_WINDOW

See Also:

Constant Field Values

PAGE_PARAMETER_ORIGINAL_URL

public static final String PAGE_PARAMETER_ORIGINAL_URL

See Also:

Constant Field Values

PAGE_PARAMETER_SAFE_RENDER_MODE

public static final String PAGE_PARAMETER_SAFE_RENDER_MODE

See Also:

Constant Field Values

PAGE_PARAMETER_CLIENT_MESSAGE

public static final String PAGE_PARAMETER_CLIENT_MESSAGE

See Also:

Constant Field Values

PAGE_PARAMETER_FROM_ERROR

public static final String PAGE_PARAMETER_FROM_ERROR

See Also:

Constant Field Values

URL_REPLACEABLE_PARAMETER_PAGEID

public static final String URL_REPLACEABLE_PARAMETER_PAGEID

See Also:

Constant Field Values

PAGE_PARAMETER_REFERER

public static final String PAGE_PARAMETER_REFERER

The location when the interface is client side.

Since:

7.0.0

See Also:

Constant Field Values

PAGE_PARAMETER_ORIGINAL_PAGEID

public static final String PAGE_PARAMETER_ORIGINAL_PAGEID

See Also:

Constant Field Values

PAGE_PARAMETER_TEMPORARY_MODE

public static final String PAGE_PARAMETER_TEMPORARY_MODE

The parameter name used to represent the local mode.

Since:

6.0.0

See Also:

Constant Field Values

PAGE_PARAMETER_PREVIOUS_STORAGE_ID

public static final String PAGE_PARAMETER_PREVIOUS_STORAGE_ID

Stores the id that identifies the previous parameter in the session object.

Since:

4.0.7

See Also:

PreviousParametersStorage, Constant Field Values

II_PARAMETER_PORTLET_MODE

public static final String II_PARAMETER_PORTLET_MODE

Parameter at service interface instance scope that stores the portlet mode.

Since:

4.0.7

See Also:

Constant Field Values

II_PARAMETER_WINDOW_STATE

public static final String II_PARAMETER_WINDOW_STATE

Parameter at service interface instance scope that stores the window state.

Since:

4.0.7

See Also:

Constant Field Values

PAGE_PARAMETER_WRITER_KEYS

public static final String PAGE_PARAMETER_WRITER_KEYS

Optional multi-valued parameter that contains the PortalPrintWriter keys already used in the page. Currently used only when the page is in administration perspective.

Since:

7.0.0

See Also:

Constant Field Values

PAGE_PARAMETER_TOGGLE_MODE_ORIGINAL_URL

public static final String PAGE_PARAMETER_TOGGLE_MODE_ORIGINAL_URL

The parameter name used to represent toggle the current mode.

Since:

7.1.0

See Also:

Constant Field Values

PAGE_PARAMETER_CALLER_SERVICE_INST

public static final String PAGE_PARAMETER_CALLER_SERVICE_INST

The parameter name used to provide the identifier of the service instance that is the caller of the current operation.

Since:

8.2.0

See Also:

Constant Field Values

PAGE_PARAMETER_CALLER_SERVICE_INTERFACE_MENU_LEVEL

public static final String PAGE_PARAMETER_CALLER_SERVICE_INTERFACE_MENU_LEVEL

The parameter name used to provide the level of the service interface menu on the caller for which an interface is being executed. Value of this parameter corresponds to the ordinal of the enumeration value in ServiceInterfaceMenuLevel.

Since:

10.2.0

See Also:

Constant Field Values

PAGE_PARAMETER_CALLER_SERVICE_INTERFACE_MENU_ITEM

public static final String PAGE_PARAMETER_CALLER_SERVICE_INTERFACE_MENU_ITEM

The parameter name used to identify the caller service interface menu item for which an interface is being executed.

Since:

10.2.0

See Also:

Constant Field Values

Constructor Detail

PortalRequestParameters

public PortalRequestParameters(SessionConfig sessionConfig)

PortalRequestParameters

public PortalRequestParameters(SessionConfig sessionConfig,
                               String parametersXmlString)
                        throws PortalException

Throws:

PortalException

PortalRequestParameters

public PortalRequestParameters(SessionConfig sessionConfig,
                               HttpServletRequest httpServletRequest)
                        throws PortalException

Throws:

PortalException

Method Detail

isReservedParameter

public static boolean isReservedParameter(String parameterName)

Indicates if the parameter is reserved for special use by the portal and may not be freely used by an installed application.

Parameters:

parameterName - the parameter name.

Returns:

true if the parameter is reserved, false otherwise.

Since:

4.0.7

setParameters

public void setParameters(String parametersXmlString)
                   throws PortalException

Throws:

PortalException

setParameters

public HashMap<String,String[]> setParameters(Document parametersDoc)
                                       throws PortalException

Throws:

PortalException

getServiceInterfaceInstanceParameterNames

public Enumeration<String> getServiceInterfaceInstanceParameterNames(String serviceInterfaceInstanceId)
                                                              throws PortalException

Throws:

PortalException

getServiceInterfaceInstanceFileParameterValue

public FileParameter getServiceInterfaceInstanceFileParameterValue(String name,
                                                                   String serviceInterfaceInstanceId)

getServiceInterfaceInstanceParameterValue

public String getServiceInterfaceInstanceParameterValue(String name,
                                                        String serviceInterfaceInstanceId)
                                                 throws PortalException

Throws:

PortalException

getServiceInterfaceInstanceParameterValues

public String[] getServiceInterfaceInstanceParameterValues(String name,
                                                           String serviceInterfaceInstanceId)
                                                    throws PortalException

Throws:

PortalException

getServiceInterfaceInstanceParameters

public Map<String,String[]> getServiceInterfaceInstanceParameters(String serviceInterfaceInstanceId)
                                                           throws PortalException

Throws:

PortalException

applyServiceInterfaceInstanceParameters

public void applyServiceInterfaceInstanceParameters(String serviceInterfaceInstanceId,
                                                    Map<String,String[]> parameters)

Applies service interface instance parameters, keeping previous values for portlet mode or window state parameters, if each did not change.

Parameters:

serviceInterfaceInstanceId - the service interface instance that is the target of the parameters.

parameters - the parameters to be applied.

Since:

5.6.0

setServiceInterfaceInstanceParameters

public void setServiceInterfaceInstanceParameters(String serviceInterfaceInstanceId,
                                                  Map<String,String[]> parameters)
                                           throws PortalException

Throws:

PortalException

setServiceInterfaceInstanceFileParameters

public void setServiceInterfaceInstanceFileParameters(String serviceInterfaceInstanceId,
                                                      Map<String,FileParameter> parameters)
                                               throws PortalException

Throws:

PortalException

setServiceInterfaceParameters

public void setServiceInterfaceParameters(String serviceInterfaceId,
                                          Map<String,String[]> parameters)
                                   throws PortalException

Throws:

PortalException

setServiceInstanceParameters

public void setServiceInstanceParameters(String serviceInstanceId,
                                         Map<String,String[]> parameters)
                                  throws PortalException

Throws:

PortalException

setServiceParameters

public void setServiceParameters(String serviceId,
                                 Map<String,String[]> parameters)
                          throws PortalException

Throws:

PortalException

setPageParameters

public void setPageParameters(Map<String,String[]> parameters)
                       throws PortalException

Throws:

PortalException

setPageParameter

public void setPageParameter(String parameterName,
                             String[] parameterValues)
                      throws PortalException

Throws:

PortalException

getPreviousParametersStorageId

public final String getPreviousParametersStorageId()

Returns the previous parameters storage id. This value is to be used as the value for the PAGE_PARAMETER_PREVIOUS_STORAGE_ID parameter when the session storage is to be used if the previous parameters in the request are not found.

Returns:

the previous parameters storage id.

Since:

4.0.7

generatePreviousParameters

public PortalRequestParameters.PreviousParameters generatePreviousParameters(HttpServletRequest request)
                                                                      throws PortalException

Generate the previous parameters for this portal request parameters instance, storing it for automatic later retrieval. For the automatic later retrieval, the parameter PAGE_PARAMETER_PREVIOUS_STORAGE_ID must be set with the value of the key of the previous parameters returned.

Parameters:

request - the user's request.

Returns:

the previous parameters information.

Throws:

PortalException

Since:

4.0.7

getPageParameterValue

public String getPageParameterValue(String name)
                             throws PortalException

Throws:

PortalException