lumis.portal.serviceinterface

Interface IServiceInterfaceRequest

All Superinterfaces:

PortletRequest

All Known Subinterfaces:

IMockServiceInterfaceActionRequest, IMockServiceInterfaceRenderRequest, IMockServiceInterfaceRequest, IServiceInterfaceActionRequest, IServiceInterfaceRenderRequest, IServiceInterfaceRequestSPI

All Known Implementing Classes:

MockServiceInterfaceRenderRequest, ServiceContainerActionRequest, ServiceContainerRenderRequest, ServiceContainerRequest

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

Interface that interfaces receive to get request information

Since:

4.0.0

Version:

$Revision: 16039 $ $Date: 2013-11-21 21:33:39 -0200 (Thu, 21 Nov 2013) $

Nested Class Summary

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

PortletRequest.P3PUserInfos

Field Summary

Fields

Modifier and Type	Field and 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

Methods

Modifier and Type	Method and 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()
Cookie	getCookie(String cookieName)
Cookie[]	getCookies()
FileParameter	getFileParameter(String parameterName)
String	getHeader(String header)
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.
IServiceInterfaceRequestDispatcher	getRequestDispatcher(String path)
ServiceConfig	getServiceConfig()
ServiceInstanceConfig	getServiceInstanceConfig()
int	getServiceInstanceDebugLevel()
ServiceInterfaceConfig	getServiceInterfaceConfig()
ServiceInterfaceInstanceConfig	getServiceInterfaceInstanceConfig()
String	getServiceInterfaceInstanceId()
SessionConfig	getSessionConfig()
boolean	isPreview()
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 javax.portlet.PortletRequest

getAttribute, getAuthType, getContextPath, getLocale, getLocales, getParameter, getParameterValues, getPortalContext, getPortletMode, getPortletSession, getPortletSession, getPreferences, 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 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 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 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()

Returns:

getCookies

Cookie[] getCookies()

Specified by:

getCookies in interface PortletRequest

getCookie

Cookie getCookie(String cookieName)

getHeader

String getHeader(String header)

getRequestDispatcher

IServiceInterfaceRequestDispatcher getRequestDispatcher(String path)

getServiceInstanceDebugLevel

int getServiceInstanceDebugLevel()

getFileParameter

FileParameter getFileParameter(String parameterName)

getCallerServiceInterfaceInstanceId

String getCallerServiceInterfaceInstanceId()

isPreview

boolean isPreview()

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.

Returns:

the business context.

Since:

7.0.0

getPageWebResource

PageWebResource getPageWebResource()

Returns the PageWebResource of this request.

Returns:

the PageWebResource of this request.

Since:

7.0.0