Package lumis.lptf.portal.serviceinterface

Interface IMockServiceInterfaceRequest

All Superinterfaces:

IPageWebResourceRequest, IServiceInterfaceRequest, javax.portlet.PortletRequest

All Known Subinterfaces:

IMockServiceInterfaceActionRequest, IMockServiceInterfaceRenderRequest

All Known Implementing Classes:

MockServiceInterfaceActionRequest, MockServiceInterfaceRenderRequest

@StableMinor(version="14.2",
             sinceVersion="5.6")
public interface IMockServiceInterfaceRequest
extends IServiceInterfaceRequest

Interface for a IServiceInterfaceRequest mock object.

Since:

5.6.0

Version:

$Revision: 24985 $ $Date: 2022-05-02 23:04:30 -0300 (Mon, 02 May 2022) $

Nested Class Summary

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

javax.portlet.PortletRequest.P3PUserInfos

Field Summary

Fields inherited from interface lumis.portal.serviceinterface.IServiceInterfaceRequest

DEBUG_LEVEL_HIGH, DEBUG_LEVEL_LOW, DEBUG_LEVEL_MEDIUM, 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
void	addFileParameter(String name, FileParameter fileParameter)	Adds a file parameter to be available in IServiceInterfaceRequest.getFileParameter(String).
void	addHeader(String key, String value)	Adds a new header value to be available in IServiceInterfaceRequest.getHeader(String).
void	addProperty(String key, String value)	Adds a single value for the specified property.
void	setAuthType(String authType)	Sets the value returned by PortletRequest.getAuthType().
void	setCallerServiceInterfaceInstanceId(String callerServiceInterfaceInstanceId)	Sets a new value for caller service interface instance id to be available in IServiceInterfaceRequest.getCallerServiceInterfaceInstanceId().
void	setCallerServiceInterfaceMenuLevel(ServiceInterfaceMenuLevel callerServiceInterfaceMenuLevel)	Sets the caller service interface menu level, returned by IServiceInterfaceRequest.getCallerServiceInterfaceMenuLevel().
void	setContextPath(String contextPath)	Sets the context path, returned by PortletRequest.getContextPath().
void	setCookies(Cookie... cookies)	Sets a new value for cookies IServiceInterfaceRequest.getCookies().
void	setFileParameterMap(Map<String,FileParameter> fileParameterMap)	Sets a map as the file parameters available in IServiceInterfaceRequest.getFileParameter(String).
void	setHeaderMap(Map<String,String> headerMap)	Sets a new header map.
void	setLocales(List<Locale> locales)	Sets the locales specified in this request, in order of preference.
void	setPageConfig(PageConfig pageConfig)	Sets the new PageConfig instance to be available in IServiceInterfaceRequest.getPageConfig().
void	setParameter(String name, String value)	Sets a parameter with a single value in this request.
void	setParameter(String name, String[] values)	Sets a parameter with multiple values in this request.
void	setParameterMap(Map<String,String[]> parameters)	Replaces all parameters in this request with the specified parameters.
void	setPortletMode(javax.portlet.PortletMode portletMode)	Sets the portlet mode for this request.
void	setPreview(boolean preview)	Sets the value that will be used on IServiceInterfaceRequest.isPreview().
void	setProperty(String key, String value)	Sets a single value for the specified property.
void	setRemoteUser(String remoteUser)	Sets the remote user returned by PortletRequest.getRemoteUser().
void	setRequestedSessionIdValid(boolean requestedSessionIdValid)	Sets the return value for PortletRequest.isRequestedSessionIdValid().
void	setScheme(String scheme)	Sets the return value for PortletRequest.getScheme().
void	setSecure(boolean secure)	Sets the return value for PortletRequest.isSecure().
void	setServerName(String serverName)	Sets the server name returned by PortletRequest.getServerName().
void	setServerPort(int serverPort)	Sets the server port returned by PortletRequest.getServerPort().
void	setServiceConfig(ServiceConfig serviceConfig)	Sets the new ServiceConfig instance to be available in IServiceInterfaceRequest.getServiceConfig().
void	setServiceInstanceConfig(ServiceInstanceConfig serviceInstanceConfig)	Sets the value that will be used on IServiceInterfaceRequest.getServiceInstanceConfig().
void	setServiceInstanceDebugLevel(int serviceInstanceDebugLevel)	Sets a new value for service instance debug level to be available in IServiceInterfaceRequest.getServiceInstanceDebugLevel().
void	setServiceInterfaceConfig(ServiceInterfaceConfig serviceInterfaceConfig)	Sets the new ServiceInterfaceConfig instance to be available in IServiceInterfaceRequest.getServiceInterfaceConfig().
void	setServiceInterfaceInstanceConfig(ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig)	Sets the new ServiceInterfaceInstanceConfig instance to be available in IServiceInterfaceRequest.getServiceInterfaceInstanceConfig().
void	setSessionConfig(SessionConfig sessionConfig)	Sets the new instance of SessionConfig to be available in IServiceInterfaceRequest.getSessionConfig().
void	setWindowState(javax.portlet.WindowState windowState)	Sets the window state, returned by PortletRequest.getWindowState().

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 lumis.portal.serviceinterface.IServiceInterfaceRequest

getAttributeNames, getBusinessContext, getCallerServiceInterfaceInstanceId, getCallerServiceInterfaceInstancePreferences, getCallerServiceInterfaceMenuLevel, getCookie, getCookies, getFileParameter, getHeader, getMode, getPageConfig, getPageWebResource, getParameterMap, getParameterNames, getPreferences, getRequestDispatcher, getServiceConfig, getServiceInstanceConfig, getServiceInstanceDebugLevel, getServiceInterfaceConfig, getServiceInterfaceInstanceConfig, getServiceInterfaceInstanceId, getSessionConfig, getWebsiteBaseURL, isPreview, setMode

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

Method Detail

setSessionConfig

void setSessionConfig(SessionConfig sessionConfig)

Sets the new instance of SessionConfig to be available in IServiceInterfaceRequest.getSessionConfig().

Specified by:

setSessionConfig in interface IServiceInterfaceRequest

Since:

5.6.0

setPageConfig

void setPageConfig(PageConfig pageConfig)

Sets the new PageConfig instance to be available in IServiceInterfaceRequest.getPageConfig().

Parameters:

pageConfig - the instance of PageConfig that will be used on the tests.

Since:

5.6.0

setServiceConfig

void setServiceConfig(ServiceConfig serviceConfig)

Sets the new ServiceConfig instance to be available in IServiceInterfaceRequest.getServiceConfig().

Parameters:

serviceConfig - the instance of ServiceConfig that will be used on the tests.

Since:

5.6.0

setServiceInstanceConfig

void setServiceInstanceConfig(ServiceInstanceConfig serviceInstanceConfig)

Sets the value that will be used on IServiceInterfaceRequest.getServiceInstanceConfig().

Parameters:

serviceInstanceConfig - the instance of ServiceInstanceConfig that will be used on the tests.

Since:

5.6.0

setServiceInterfaceConfig

void setServiceInterfaceConfig(ServiceInterfaceConfig serviceInterfaceConfig)

Sets the new ServiceInterfaceConfig instance to be available in IServiceInterfaceRequest.getServiceInterfaceConfig().

Parameters:

serviceInterfaceConfig -

Since:

5.6.0

setServiceInterfaceInstanceConfig

void setServiceInterfaceInstanceConfig(ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig)

Sets the new ServiceInterfaceInstanceConfig instance to be available in IServiceInterfaceRequest.getServiceInterfaceInstanceConfig().

Parameters:

serviceInterfaceInstanceConfig -

Since:

5.6.0

setPreview

void setPreview(boolean preview)

Sets the value that will be used on IServiceInterfaceRequest.isPreview().

Parameters:

preview - the boolean value

Since:

5.6.0

addHeader

void addHeader(String key,
               String value)

Adds a new header value to be available in IServiceInterfaceRequest.getHeader(String).

Parameters:

key - string representing the key.

value - the value.

Since:

5.6.0

setHeaderMap

void setHeaderMap(Map<String,String> headerMap)

Sets a new header map. In this way, all the values returned by IServiceInterfaceRequest.getHeader(String) will be replaced.

Parameters:

headerMap - the instance of Map.

Since:

5.6.0

See Also:

IServiceInterfaceRequest.getHeader(String)

addFileParameter

void addFileParameter(String name,
                      FileParameter fileParameter)

Adds a file parameter to be available in IServiceInterfaceRequest.getFileParameter(String).

Parameters:

name - the name of the FileParameter.

fileParameter - the FileParameter instance.

Since:

5.6.0

setFileParameterMap

void setFileParameterMap(Map<String,FileParameter> fileParameterMap)

Sets a map as the file parameters available in IServiceInterfaceRequest.getFileParameter(String).

Parameters:

fileParameterMap - an instance of Map.

Since:

5.6.0

setCookies

void setCookies(Cookie... cookies)

Sets a new value for cookies IServiceInterfaceRequest.getCookies().

Parameters:

cookies - the cookies to set.

Since:

5.6.0

setServiceInstanceDebugLevel

void setServiceInstanceDebugLevel(int serviceInstanceDebugLevel)

Sets a new value for service instance debug level to be available in IServiceInterfaceRequest.getServiceInstanceDebugLevel().

Parameters:

serviceInstanceDebugLevel - the new level.

Since:

5.6.0

setCallerServiceInterfaceInstanceId

void setCallerServiceInterfaceInstanceId(String callerServiceInterfaceInstanceId)

Sets a new value for caller service interface instance id to be available in IServiceInterfaceRequest.getCallerServiceInterfaceInstanceId().

Parameters:

callerServiceInterfaceInstanceId - the new callerServiceInterfaceInstanceId.

Since:

5.6.0

addProperty

void addProperty(String key,
                 String value)

Adds a single value for the specified property.

If there are already one or more values registered for the given property key, the given value will be added to the end of the list.

Parameters:

key - the property key.

value - the property value.

Since:

5.6.0

See Also:

PortletRequest.getProperties(String), PortletRequest.getProperty(String), PortletRequest.getPropertyNames()

setAuthType

void setAuthType(String authType)

Sets the value returned by PortletRequest.getAuthType().

Parameters:

authType - the authType.

Since:

5.6.0

setContextPath

void setContextPath(String contextPath)

Sets the context path, returned by PortletRequest.getContextPath().

Parameters:

contextPath - the context path.

Since:

5.6.0

setLocales

void setLocales(List<Locale> locales)

Sets the locales specified in this request, in order of preference.

Parameters:

locales - the locales.

Since:

5.6.0

See Also:

PortletRequest.getLocale(), PortletRequest.getLocales()

setParameter

void setParameter(String name,
                  String value)

Sets a parameter with a single value in this request.

Parameters:

name - the parameter name.

value - the parameter value.

Since:

5.6.0

See Also:

PortletRequest.getParameter(String), IServiceInterfaceRequest.getParameterMap(), IServiceInterfaceRequest.getParameterNames(), PortletRequest.getParameterValues(String)

setParameter

void setParameter(String name,
                  String[] values)

Sets a parameter with multiple values in this request.

Parameters:

name - the parameter name.

values - the parameter values.

Since:

5.6.0

See Also:

PortletRequest.getParameter(String), IServiceInterfaceRequest.getParameterMap(), IServiceInterfaceRequest.getParameterNames(), PortletRequest.getParameterValues(String)

setParameterMap

void setParameterMap(Map<String,String[]> parameters)

Replaces all parameters in this request with the specified parameters.

Parameters:

parameters - the parameters.

Since:

5.6.0

See Also:

PortletRequest.getParameter(String), IServiceInterfaceRequest.getParameterMap(), IServiceInterfaceRequest.getParameterNames(), PortletRequest.getParameterValues(String)

setPortletMode

void setPortletMode(javax.portlet.PortletMode portletMode)

Sets the portlet mode for this request.

Parameters:

portletMode - the portlet mode.

Since:

5.6.0

See Also:

PortletRequest.getPortletMode()

setProperty

void setProperty(String key,
                 String value)

Sets a single value for the specified property.

If there are already one or more values registered for the given property key, they will be replaced.

Parameters:

key - the property key.

value - the property value.

Since:

5.6.0

See Also:

PortletRequest.getProperties(String), PortletRequest.getProperty(String), PortletRequest.getPropertyNames()

setRemoteUser

void setRemoteUser(String remoteUser)

Sets the remote user returned by PortletRequest.getRemoteUser().

Parameters:

remoteUser - the remote user.

Since:

5.6.0

setRequestedSessionIdValid

void setRequestedSessionIdValid(boolean requestedSessionIdValid)

Sets the return value for PortletRequest.isRequestedSessionIdValid().

Parameters:

requestedSessionIdValid - the value.

Since:

5.6.0

setScheme

void setScheme(String scheme)

Sets the return value for PortletRequest.getScheme().

Parameters:

scheme - the value.

Since:

5.6.0

setSecure

void setSecure(boolean secure)

Sets the return value for PortletRequest.isSecure().

Parameters:

secure - the value.

Since:

5.6.0

setServerName

void setServerName(String serverName)

Sets the server name returned by PortletRequest.getServerName().

Parameters:

serverName - the server name.

Since:

5.6.0

setServerPort

void setServerPort(int serverPort)

Sets the server port returned by PortletRequest.getServerPort().

Parameters:

serverPort - the server port.

Since:

5.6.0

setWindowState

void setWindowState(javax.portlet.WindowState windowState)

Sets the window state, returned by PortletRequest.getWindowState().

Parameters:

windowState - the window state.

Since:

5.6.0

setCallerServiceInterfaceMenuLevel

void setCallerServiceInterfaceMenuLevel(ServiceInterfaceMenuLevel callerServiceInterfaceMenuLevel)

Sets the caller service interface menu level, returned by IServiceInterfaceRequest.getCallerServiceInterfaceMenuLevel().

Parameters:

callerServiceInterfaceMenuLevel - the menu level.

Since:

10.2.0