lumis.portal.servicecontainer

Class ServiceContainerRenderRequest

java.lang.Object

javax.servlet.ServletRequestWrapper

javax.servlet.http.HttpServletRequestWrapper

lumis.portal.url.PageWebResourceRequest

lumis.portal.servicecontainer.ServiceContainerRequest

lumis.portal.servicecontainer.ServiceContainerRenderRequest

All Implemented Interfaces:

PortletRequest, RenderRequest, HttpServletRequest, ServletRequest, IServiceInterfaceRenderRequest, IServiceInterfaceRequest, IServiceInterfaceRequestSPI, IPageWebResourceRenderRequest, IPageWebResourceRequest

public class ServiceContainerRenderRequest
extends ServiceContainerRequest
implements IServiceInterfaceRenderRequest, IPageWebResourceRenderRequest

Since:

4.0.0

Version:

$Revision: 20172 $ $Date: 2017-05-17 16:28:09 +0000 (Wed, 17 May 2017) $

Nested Class Summary

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

PortletRequest.P3PUserInfos

Field Summary

Fields inherited from class lumis.portal.servicecontainer.ServiceContainerRequest

baseServiceInterfaceInstanceConfig, businessContext, callerServiceInterfaceInstanceId, isPreview, pageConfig, preferences, serviceConfig, serviceContainerHttpServletRequest, serviceInstanceConfig, serviceInstanceDebugLevel, serviceInterfaceConfig, serviceInterfaceInstanceConfig, serviceInterfaceInstanceId, sessionConfig

Fields inherited from class lumis.portal.url.PageWebResourceRequest

mode

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.RenderRequest

ETAG

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

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor and Description
ServiceContainerRenderRequest(SessionConfig sessionConfig, PortalRequestParameters parameters, HttpServletRequest httpServletRequest, ReplaceInterfacesStorage replaceInterfacesStorage)

Method Summary

Modifier and Type	Method and Description
protected FunctionMapper	createFunctionMapper(ServiceContainerResponse response) Creates a FunctionMapper based on the given response.
void	disablePathProcessing() Turns off the path processing of the generated HTML.
String	getETag()
String	getPageCacheId() Returns the identifier of the page cache this request renders to.
boolean	getSaveXml()
String	getServiceInterfaceInstanceId()
boolean	isCheckForCacheEnabled()
boolean	isClientScriptRequest()
boolean	isPageCachedInFile() Returns whether the requested page is cached in file.
boolean	isParameterFromProcessAction()
boolean	isPrinting() Returns whether the request is in print mode.
boolean	isProcessBeforeWrites() Returns whether the before writes should be processed by the ServiceContainer.
boolean	isProcessPaths() Returns whether the processing of paths should be performed.
void	setCheckForCacheEnabled(boolean checkForCacheEnabled)
void	setClientScriptRequest(boolean clientScriptRequest)
void	setPageCacheId(String pageCacheId) Sets the identifier of the page cache this request renders to.
void	setParameterFromProcessAction(boolean parametersAreFromProcessAction)
void	setPrinting(boolean isPrinting)
void	setProcessBeforeWrites(boolean processBeforeWrites) Sets whether the before writes should be processed by the ServiceContainer.
void	setSaveXml(boolean saveXml)

Methods inherited from class lumis.portal.servicecontainer.ServiceContainerRequest

getAttribute, getAttributeNames, getBaseServiceInterfaceInstanceConfig, getCallerServiceInterfaceInstanceId, getCallerServiceInterfaceInstancePreferences, getCallerServiceInterfaceMenuLevel, getFileParameter, getFunctionMapper, getLocale, getLocales, getMode, getPageConfig, getParameter, getParameterMap, getParameterNames, getParameterValues, getPortalContext, getPortletMode, getPortletSession, getPortletSession, getPreferences, getPrivateParameterMap, getProperties, getProperty, getPropertyNames, getPublicParameterMap, getReplaceInterfacesStorage, getRequestDispatcher, getResponseContentType, getResponseContentTypes, getServiceConfig, getServiceContainerHttpServletRequest, getServiceInstanceConfig, getServiceInstanceDebugLevel, getServiceInterfaceConfig, getServiceInterfaceInstanceConfig, getUserPrincipal, getVariableResolver, getWindowID, getWindowState, isPortletModeAllowed, isPreview, isUserInRole, isWindowStateAllowed, removeAttribute, setAttribute, setBaseServiceInterfaceInstanceConfig, setCallerServiceInterfaceInstanceId, setCharacterEncoding, setMode, setPageWebResource, setPreview, setResponse, setServiceConfig, setServiceInstanceConfig, setServiceInstanceDebugLevel, setServiceInterfaceConfig, setServiceInterfaceInstanceConfig, setServiceInterfaceInstanceFileParameters, setServiceInterfaceInstanceParameters, setSessionConfig

Methods inherited from class lumis.portal.url.PageWebResourceRequest

getApplicationRequestedPath, getBusinessContext, getCookie, getPageWebResource, getPortalMode, getSessionConfig, getWebsiteBaseURL, removeAttribute

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

authenticate, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, login, logout

Methods inherited from class javax.servlet.ServletRequestWrapper

getAsyncContext, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocalName, getLocalPort, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, setRequest, startAsync, startAsync

Methods inherited from class java.lang.Object

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

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, getSessionConfig, getWebsiteBaseURL, isPreview, setMode, setSessionConfig

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

Methods inherited from interface lumis.portal.url.IPageWebResourceRequest

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

Methods inherited from interface lumis.portal.serviceinterface.IServiceInterfaceRequestSPI

getHttpServletRequest

Methods inherited from interface javax.servlet.ServletRequest

getAsyncContext, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocalName, getLocalPort, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, startAsync, startAsync

Constructor Detail

ServiceContainerRenderRequest

public ServiceContainerRenderRequest(SessionConfig sessionConfig,
                                     PortalRequestParameters parameters,
                                     HttpServletRequest httpServletRequest,
                                     ReplaceInterfacesStorage replaceInterfacesStorage)
                              throws Exception

Parameters:

httpServletRequest -

Throws:

Exception

Method Detail

getServiceInterfaceInstanceId

public String getServiceInterfaceInstanceId()

Specified by:

getServiceInterfaceInstanceId in interface IServiceInterfaceRequest

Overrides:

getServiceInterfaceInstanceId in class ServiceContainerRequest

Returns:

Returns the serviceInterfaceInstanceId.

getSaveXml

public boolean getSaveXml()

Specified by:

getSaveXml in interface IServiceInterfaceRenderRequest

setSaveXml

public void setSaveXml(boolean saveXml)

isPrinting

public boolean isPrinting()

Description copied from interface: IPageWebResourceRenderRequest

Returns whether the request is in print mode.

Specified by:

isPrinting in interface IServiceInterfaceRenderRequest

Specified by:

isPrinting in interface IPageWebResourceRenderRequest

Returns:

whether the request is in print mode.

setPrinting

public void setPrinting(boolean isPrinting)

isClientScriptRequest

public boolean isClientScriptRequest()

Returns:

Returns the isClientScriptRequest.

setClientScriptRequest

public void setClientScriptRequest(boolean clientScriptRequest)

isCheckForCacheEnabled

public boolean isCheckForCacheEnabled()

setCheckForCacheEnabled

public void setCheckForCacheEnabled(boolean checkForCacheEnabled)

isPageCachedInFile

public boolean isPageCachedInFile()

Description copied from interface: IPageWebResourceRequest

Returns whether the requested page is cached in file.

Specified by:

isPageCachedInFile in interface IServiceInterfaceRenderRequest

Specified by:

isPageCachedInFile in interface IPageWebResourceRequest

Overrides:

isPageCachedInFile in class PageWebResourceRequest

Returns:

whether the requested page is cached in file.

getPageCacheId

public String getPageCacheId()

Returns the identifier of the page cache this request renders to.

Returns:

the page cache identifier, or null if this request is not a page cache.

Since:

5.0.0

setPageCacheId

public void setPageCacheId(String pageCacheId)

Sets the identifier of the page cache this request renders to.

Parameters:

pageCacheId - the page cache identifier.

Since:

5.0.0

isParameterFromProcessAction

public boolean isParameterFromProcessAction()

setParameterFromProcessAction

public void setParameterFromProcessAction(boolean parametersAreFromProcessAction)

getETag

public String getETag()

Specified by:

getETag in interface RenderRequest

disablePathProcessing

public void disablePathProcessing()

Turns off the path processing of the generated HTML. The one who calls this is the responsible for

Since:

8.2.0

isProcessPaths

public boolean isProcessPaths()

Returns whether the processing of paths should be performed.

Returns:

whether the processing of paths should be performed.

Since:

8.2.0

createFunctionMapper

protected FunctionMapper createFunctionMapper(ServiceContainerResponse response)

Description copied from class: ServiceContainerRequest

Creates a FunctionMapper based on the given response.

Overrides:

createFunctionMapper in class ServiceContainerRequest

Parameters:

response - the response.

Returns:

the created FunctionMapper.

setProcessBeforeWrites

public void setProcessBeforeWrites(boolean processBeforeWrites)

Sets whether the before writes should be processed by the ServiceContainer.

Parameters:

processBeforeWrites - whether the before writes should be processed by the ServiceContainer.

Since:

7.0.0

isProcessBeforeWrites

public boolean isProcessBeforeWrites()

Returns whether the before writes should be processed by the ServiceContainer.

Returns:

whether the before writes should be processed by the ServiceContainer.

Since:

7.0.0