Package lumis.portal.serviceinterface

Interface IServiceInterfaceRequest

All Superinterfaces:

IPageWebResourceRequest, PortletRequest

All Known Subinterfaces:

IMockServiceInterfaceActionRequest, IMockServiceInterfaceRenderRequest, IMockServiceInterfaceRequest, IServiceInterfaceActionRequest, IServiceInterfaceRenderRequest, IServiceInterfaceRequestSPI

All Known Implementing Classes:

MockServiceInterfaceActionRequest, MockServiceInterfaceRenderRequest, ServiceContainerActionRequest, ServiceContainerRenderRequest, ServiceContainerRequest

@StableMinor(version="14.0",
             sinceVersion="4.0")
public interface IServiceInterfaceRequest
extends PortletRequest, IPageWebResourceRequest

Interface that interfaces receive to get request information

Since:

4.0.0

Version:

$Revision: 24477 $ $Date: 2021-04-28 11:30:36 -0300 (Wed, 28 Apr 2021) $

Nested Class Summary

Nested classes/interfaces inherited from interface javax.portlet.PortletRequest

PortletRequest.P3PUserInfos

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEBUG_LEVEL_HIGH
static int	DEBUG_LEVEL_LOW
static int	DEBUG_LEVEL_MEDIUM
static int	DEBUG_LEVEL_NONE

Fields inherited from interface javax.portlet.PortletRequest

ACTION_PHASE, ACTION_SCOPE_ID, BASIC_AUTH, CCPP_PROFILE, CLIENT_CERT_AUTH, DIGEST_AUTH, EVENT_PHASE, FORM_AUTH, LIFECYCLE_PHASE, RENDER_HEADERS, RENDER_MARKUP, RENDER_PART, RENDER_PHASE, RESOURCE_PHASE, USER_INFO

Method Summary

Modifier and Type	Method	Description
Enumeration<String>	getAttributeNames()	Returns an Enumeration containing the names of the attributes available to this request.
IBusinessContext	getBusinessContext()	Returns the business context for this request.
String	getCallerServiceInterfaceInstanceId()
IPreferences	getCallerServiceInterfaceInstancePreferences()	Returns the preferences of the caller service interface instance at level that corresponds to the menu level returned by getCallerServiceInterfaceMenuLevel().
ServiceInterfaceMenuLevel	getCallerServiceInterfaceMenuLevel()	Returns the service interface menu level that called the interface processed by this request.
Cookie	getCookie(String cookieName)	Returns the requested cookie or null if the cookie does not exist in request.
Cookie[]	getCookies()	Returns the request's cookies.
FileParameter	getFileParameter(String parameterName)	Returns the uploaded file by the given parameter name.
String	getHeader(String header)	Returns the requested header or null if the header does not exist in request.
int	getMode()
PageConfig	getPageConfig()
PageWebResource	getPageWebResource()	Returns the PageWebResource of this request.
Map<String,String[]>	getParameterMap()	Returns a Map of the parameters of this request.
Enumeration<String>	getParameterNames()	Returns an Enumeration of String objects containing the names of the parameters contained in this request.
IPreferences	getPreferences()
IServiceInterfaceRequestDispatcher	getRequestDispatcher(String path)
ServiceConfig	getServiceConfig()
ServiceInstanceConfig	getServiceInstanceConfig()
int	getServiceInstanceDebugLevel()
ServiceInterfaceConfig	getServiceInterfaceConfig()
ServiceInterfaceInstanceConfig	getServiceInterfaceInstanceConfig()
String	getServiceInterfaceInstanceId()
SessionConfig	getSessionConfig()	Returns the session of the user that has performed the request.
IWebsiteBaseURL	getWebsiteBaseURL()	Returns the website's base URL accessed to generate this request.
boolean	isPreview()	Returns whether the request is in preview mode.
void	setMode(int mode)	Deprecated. Since 7.1.0 as this method should not be used by service interfaces and may be removed in the future.
void	setSessionConfig(SessionConfig sessionConfig)

Methods inherited from interface lumis.portal.url.IPageWebResourceRequest

getApplicationRequestedPath, getAttribute, getContextPath, getParameter, getParameterValues, getPortalMode, getScheme, getServerName, getServerPort, isPageCachedInFile, isSecure, removeAttribute, setAttribute

Methods inherited from interface javax.portlet.PortletRequest

getAttribute, getAuthType, getContextPath, getLocale, getLocales, getParameter, getParameterValues, getPortalContext, getPortletMode, getPortletSession, getPortletSession, getPrivateParameterMap, getProperties, getProperty, getPropertyNames, getPublicParameterMap, getRemoteUser, getRequestedSessionId, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getUserPrincipal, getWindowID, getWindowState, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute, setAttribute

Field Detail

DEBUG_LEVEL_NONE

static final int DEBUG_LEVEL_NONE

See Also:

Constant Field Values

DEBUG_LEVEL_LOW

static final int DEBUG_LEVEL_LOW

See Also:

Constant Field Values

DEBUG_LEVEL_MEDIUM

static final int DEBUG_LEVEL_MEDIUM

See Also:

Constant Field Values

DEBUG_LEVEL_HIGH

static final int DEBUG_LEVEL_HIGH

See Also:

Constant Field Values

Method Detail

getAttributeNames

Enumeration<String> getAttributeNames()

Returns an Enumeration containing the names of the attributes available to this request. This method returns an empty Enumeration if the request has no attributes available to it.

Specified by:

getAttributeNames in interface IPageWebResourceRequest

Specified by:

getAttributeNames in interface PortletRequest

Returns:

an Enumeration of strings containing the names of the request attributes, or an empty Enumeration if the request has no attributes available to it.

getParameterNames

Enumeration<String> getParameterNames()

Returns an Enumeration of String objects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an empty Enumeration.

Only parameters targeted to the current service interface are returned.

Specified by:

getParameterNames in interface IPageWebResourceRequest

Specified by:

getParameterNames in interface PortletRequest

Returns:

an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters.

getParameterMap

Map<String,String[]> getParameterMap()

Returns a Map of the parameters of this request. Request parameters are extra information sent with the request. The returned parameters are "x-www-form-urlencoded" decoded.

The values in the returned Map are from type String array ( String[]).

If no parameters exist this method returns an empty Map.

Specified by:

getParameterMap in interface IPageWebResourceRequest

Specified by:

getParameterMap in interface PortletRequest

Returns:

an immutable Map containing parameter names as keys and parameter values as map values, or an empty Map if no parameters exist. The keys in the parameter map are of type String. The values in the parameter map are of type String array (String[]).

getServiceInterfaceInstanceId

String getServiceInterfaceInstanceId()

Returns:

Returns the serviceInterfaceInstanceId.

getServiceInterfaceInstanceConfig

ServiceInterfaceInstanceConfig getServiceInterfaceInstanceConfig()

Returns:

the source page

getServiceInterfaceConfig

ServiceInterfaceConfig getServiceInterfaceConfig()

Returns:

getServiceInstanceConfig

ServiceInstanceConfig getServiceInstanceConfig()

Returns:

getServiceConfig

ServiceConfig getServiceConfig()

Returns:

getPageConfig

PageConfig getPageConfig()

Returns:

setSessionConfig

void setSessionConfig(SessionConfig sessionConfig)

Parameters:

userSessionId -

getSessionConfig

SessionConfig getSessionConfig()

Description copied from interface: IPageWebResourceRequest

Returns the session of the user that has performed the request.

Specified by:

getSessionConfig in interface IPageWebResourceRequest

Returns:

getCookies

Cookie[] getCookies()

Description copied from interface: IPageWebResourceRequest

Returns the request's cookies.

Specified by:

getCookies in interface IPageWebResourceRequest

Specified by:

getCookies in interface PortletRequest

Returns:

the request's cookies.

getCookie

Cookie getCookie(String cookieName)

Description copied from interface: IPageWebResourceRequest

Returns the requested cookie or null if the cookie does not exist in request.

Specified by:

getCookie in interface IPageWebResourceRequest

Parameters:

cookieName - the requested cookie name.

Returns:

the requested cookie or null if the cookie does not exist in request.

getHeader

String getHeader(String header)

Description copied from interface: IPageWebResourceRequest

Returns the requested header or null if the header does not exist in request.

Specified by:

getHeader in interface IPageWebResourceRequest

Parameters:

header - the requested header name.

Returns:

the requested header or null if the header does not exist in request.

getRequestDispatcher

IServiceInterfaceRequestDispatcher getRequestDispatcher(String path)

getServiceInstanceDebugLevel

int getServiceInstanceDebugLevel()

getFileParameter

FileParameter getFileParameter(String parameterName)

Description copied from interface: IPageWebResourceRequest

Returns the uploaded file by the given parameter name.

Specified by:

getFileParameter in interface IPageWebResourceRequest

Parameters:

parameterName - the parameter name.

Returns:

the uploaded file by the given parameter name

getCallerServiceInterfaceInstanceId

String getCallerServiceInterfaceInstanceId()

getCallerServiceInterfaceInstancePreferences

IPreferences getCallerServiceInterfaceInstancePreferences()

Returns the preferences of the caller service interface instance at level that corresponds to the menu level returned by getCallerServiceInterfaceMenuLevel().

Returns:

the preferences.

Throws:

IllegalStateException - if either caller service interface instance or caller service interface menu level was not provided.

Since:

10.2.0

getPreferences

IPreferences getPreferences()

Specified by:

getPreferences in interface PortletRequest

getCallerServiceInterfaceMenuLevel

ServiceInterfaceMenuLevel getCallerServiceInterfaceMenuLevel()

Returns the service interface menu level that called the interface processed by this request.

Returns:

the menu level.

Throws:

IllegalStateException - if there is no information about the caller menu service interface menu level available.

Since:

10.2.0

isPreview

boolean isPreview()

Description copied from interface: IPageWebResourceRequest

Returns whether the request is in preview mode.

Specified by:

isPreview in interface IPageWebResourceRequest

Returns:

whether the request is in preview mode.

getMode

int getMode()

setMode

@Deprecated
void setMode(int mode)

Deprecated.

Since 7.1.0 as this method should not be used by service interfaces and may be removed in the future.

getBusinessContext

IBusinessContext getBusinessContext()

Returns the business context for this request.

Specified by:

getBusinessContext in interface IPageWebResourceRequest

Returns:

the business context.

Since:

7.0.0

getPageWebResource

PageWebResource getPageWebResource()

Returns the PageWebResource of this request.

Specified by:

getPageWebResource in interface IPageWebResourceRequest

Returns:

the PageWebResource of this request.

Since:

7.0.0

getWebsiteBaseURL

IWebsiteBaseURL getWebsiteBaseURL()

Returns the website's base URL accessed to generate this request.

Specified by:

getWebsiteBaseURL in interface IPageWebResourceRequest

Returns:

the website base URL.

Since:

8.0.0