lumis.portal.servicecontainer
Class ServiceContainerRequest

java.lang.Object
  javax.servlet.ServletRequestWrapper
      javax.servlet.http.HttpServletRequestWrapper
          lumis.portal.servicecontainer.ServiceContainerRequest

All Implemented Interfaces:

PortletRequest, HttpServletRequest, ServletRequest, IServiceInterfaceRequest

Direct Known Subclasses:

ServiceContainerActionRequest, ServiceContainerRenderRequest

public class ServiceContainerRequest
extends HttpServletRequestWrapper
implements IServiceInterfaceRequest

A IServiceInterfaceRequest implementation that is used by the service container.

Since:

4.0.0

Field Summary

protected String	callerServiceInterfaceInstanceId
protected boolean	isPreview
protected int	mode
protected PageConfig	pageConfig
protected PortletPreferences	preferences Preferences of the current user for the current service interface instance.
protected ServiceConfig	serviceConfig
protected ServiceContainerHttpServletRequest	serviceContainerHttpServletRequest
protected ServiceInstanceConfig	serviceInstanceConfig
protected int	serviceInstanceDebugLevel
protected ServiceInterfaceConfig	serviceInterfaceConfig
protected ServiceInterfaceInstanceConfig	serviceInterfaceInstanceConfig
protected String	serviceInterfaceInstanceId
protected SessionConfig	sessionConfig

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

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH, USER_INFO

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

ServiceContainerRequest(SessionConfig sessionConfig, PortalRequestParameters portalParameters, HttpServletRequest httpServletRequest)

ServiceContainerRequest(SessionConfig sessionConfig, ServiceContainerHttpServletRequest request)

Method Summary

Object	getAttribute(String key)
Enumeration<String>	getAttributeNames() Returns an Enumeration containing the names of the attributes available to this request.
String	getCallerServiceInterfaceInstanceId()
Cookie	getCookie(String cookieName)
Cookie[]	getCookies()
FileParameter	getFileParameter(String parameterName)
Locale	getLocale()
Enumeration	getLocales()
int	getMode()
PageConfig	getPageConfig()
String	getParameter(String name)
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.
String[]	getParameterValues(String name)
PortalContext	getPortalContext()
PortletMode	getPortletMode()
PortletSession	getPortletSession()
PortletSession	getPortletSession(boolean create)
PortletPreferences	getPreferences()
Enumeration<String>	getProperties(String name)
String	getProperty(String name)
Enumeration<String>	getPropertyNames()
IServiceInterfaceRequestDispatcher	getRequestDispatcher(String path)
String	getResponseContentType()
Enumeration	getResponseContentTypes()
ServiceConfig	getServiceConfig()
ServiceContainerHttpServletRequest	getServiceContainerHttpServletRequest()
ServiceInstanceConfig	getServiceInstanceConfig()
int	getServiceInstanceDebugLevel()
ServiceInterfaceConfig	getServiceInterfaceConfig()
ServiceInterfaceInstanceConfig	getServiceInterfaceInstanceConfig()
String	getServiceInterfaceInstanceId()
SessionConfig	getSessionConfig()
Principal	getUserPrincipal()
VariableResolver	getVariableResolver() Returns the variable resolver for this request's implicit objects.
WindowState	getWindowState()
boolean	isPortletModeAllowed(PortletMode mode)
boolean	isPreview()
boolean	isUserInRole(String arg0)
boolean	isWindowStateAllowed(WindowState state)
void	removeAttribute(String key)
void	setAttribute(String key, Object value)
void	setCallerServiceInterfaceInstanceId(String callerServiceInterfaceInstanceId)
void	setCharacterEncoding(String encoding) This method does nothing.
void	setMode(int mode)
void	setPageConfig(PageConfig pageConfig)
void	setPreview(boolean isPreview)
void	setServiceConfig(ServiceConfig serviceConfig)
void	setServiceInstanceConfig(ServiceInstanceConfig serviceInstanceConfig)
void	setServiceInstanceDebugLevel(int serviceInstanceDebugLevel)
void	setServiceInterfaceConfig(ServiceInterfaceConfig serviceInterfaceConfig)
void	setServiceInterfaceInstanceConfig(ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig)
void	setServiceInterfaceInstanceFileParameters(Map<String,FileParameter> parameters)
void	setServiceInterfaceInstanceParameters(Map<String,String[]> parameters)
void	setSessionConfig(SessionConfig sessionConfig)

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

getAuthType, getContextPath, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid

Methods inherited from class javax.servlet.ServletRequestWrapper

getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocalName, getLocalPort, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getScheme, getServerName, getServerPort, isSecure, setRequest

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

getHeader

Methods inherited from interface javax.portlet.PortletRequest

getAuthType, getContextPath, getRemoteUser, getRequestedSessionId, getScheme, getServerName, getServerPort, isRequestedSessionIdValid, isSecure

Methods inherited from interface javax.servlet.ServletRequest

getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocalName, getLocalPort, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getScheme, getServerName, getServerPort, isSecure

Field Detail

serviceContainerHttpServletRequest

protected ServiceContainerHttpServletRequest serviceContainerHttpServletRequest

serviceInterfaceInstanceId

protected String serviceInterfaceInstanceId

serviceInterfaceInstanceConfig

protected ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig

serviceInterfaceConfig

protected ServiceInterfaceConfig serviceInterfaceConfig

serviceInstanceConfig

protected ServiceInstanceConfig serviceInstanceConfig

callerServiceInterfaceInstanceId

protected String callerServiceInterfaceInstanceId

serviceConfig

protected ServiceConfig serviceConfig

pageConfig

protected PageConfig pageConfig

sessionConfig

protected SessionConfig sessionConfig

serviceInstanceDebugLevel

protected int serviceInstanceDebugLevel

isPreview

protected boolean isPreview

mode

protected int mode

preferences

protected PortletPreferences preferences

Preferences of the current user for the current service interface instance. It is loaded on demand by the getPreferences() method.

Since:

4.0.7

Constructor Detail

ServiceContainerRequest

public ServiceContainerRequest(SessionConfig sessionConfig,
                               ServiceContainerHttpServletRequest request)
                        throws Exception

Throws:

Exception

ServiceContainerRequest

public ServiceContainerRequest(SessionConfig sessionConfig,
                               PortalRequestParameters portalParameters,
                               HttpServletRequest httpServletRequest)
                        throws Exception

Throws:

Exception

Method Detail

setCharacterEncoding

public void setCharacterEncoding(String encoding)
                          throws UnsupportedEncodingException

This method does nothing. The ServiceContainerRequest character encoding may not be changed.

Specified by:

setCharacterEncoding in interface ServletRequest

Overrides:

setCharacterEncoding in class ServletRequestWrapper

Throws:

UnsupportedEncodingException

getPortletSession

public PortletSession getPortletSession()

Specified by:

getPortletSession in interface PortletRequest

getPortletSession

public PortletSession getPortletSession(boolean create)

Specified by:

getPortletSession in interface PortletRequest

getParameter

public String getParameter(String name)

Specified by:

getParameter in interface PortletRequest

Specified by:

getParameter in interface ServletRequest

Overrides:

getParameter in class ServletRequestWrapper

getParameterNames

public Enumeration<String> getParameterNames()

Description copied from interface: IServiceInterfaceRequest

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

Specified by:

getParameterNames in interface ServletRequest

Specified by:

getParameterNames in interface IServiceInterfaceRequest

Overrides:

getParameterNames in class ServletRequestWrapper

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.

getParameterValues

public String[] getParameterValues(String name)

Specified by:

getParameterValues in interface PortletRequest

Specified by:

getParameterValues in interface ServletRequest

Overrides:

getParameterValues in class ServletRequestWrapper

getParameterMap

public Map<String,String[]> getParameterMap()

Description copied from interface: IServiceInterfaceRequest

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

Specified by:

getParameterMap in interface ServletRequest

Specified by:

getParameterMap in interface IServiceInterfaceRequest

Overrides:

getParameterMap in class ServletRequestWrapper

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[]).

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface PortletRequest

Specified by:

getUserPrincipal in interface HttpServletRequest

Overrides:

getUserPrincipal in class HttpServletRequestWrapper

isUserInRole

public boolean isUserInRole(String arg0)

Specified by:

isUserInRole in interface PortletRequest

Specified by:

isUserInRole in interface HttpServletRequest

Overrides:

isUserInRole in class HttpServletRequestWrapper

getLocale

public Locale getLocale()

Specified by:

getLocale in interface PortletRequest

Specified by:

getLocale in interface ServletRequest

Overrides:

getLocale in class ServletRequestWrapper

getLocales

public Enumeration getLocales()

Specified by:

getLocales in interface PortletRequest

Specified by:

getLocales in interface ServletRequest

Overrides:

getLocales in class ServletRequestWrapper

getAttributeNames

public Enumeration<String> getAttributeNames()

Description copied from interface: IServiceInterfaceRequest

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

Specified by:

getAttributeNames in interface ServletRequest

Specified by:

getAttributeNames in interface IServiceInterfaceRequest

Overrides:

getAttributeNames in class ServletRequestWrapper

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.

getAttribute

public Object getAttribute(String key)

Specified by:

getAttribute in interface PortletRequest

Specified by:

getAttribute in interface ServletRequest

Overrides:

getAttribute in class ServletRequestWrapper

setAttribute

public void setAttribute(String key,
                         Object value)

Specified by:

setAttribute in interface PortletRequest

Specified by:

setAttribute in interface ServletRequest

Overrides:

setAttribute in class ServletRequestWrapper

removeAttribute

public void removeAttribute(String key)

Specified by:

removeAttribute in interface PortletRequest

Specified by:

removeAttribute in interface ServletRequest

Overrides:

removeAttribute in class ServletRequestWrapper

getProperty

public String getProperty(String name)

Specified by:

getProperty in interface PortletRequest

getProperties

public Enumeration<String> getProperties(String name)

Specified by:

getProperties in interface PortletRequest

getPropertyNames

public Enumeration<String> getPropertyNames()

Specified by:

getPropertyNames in interface PortletRequest

getPortalContext

public PortalContext getPortalContext()

Specified by:

getPortalContext in interface PortletRequest

getPortletMode

public PortletMode getPortletMode()

Specified by:

getPortletMode in interface PortletRequest

getPreferences

public PortletPreferences getPreferences()

Specified by:

getPreferences in interface PortletRequest

getResponseContentType

public String getResponseContentType()

Specified by:

getResponseContentType in interface PortletRequest

getResponseContentTypes

public Enumeration getResponseContentTypes()

Specified by:

getResponseContentTypes in interface PortletRequest

getWindowState

public WindowState getWindowState()

Specified by:

getWindowState in interface PortletRequest

isPortletModeAllowed

public boolean isPortletModeAllowed(PortletMode mode)

Specified by:

isPortletModeAllowed in interface PortletRequest

isWindowStateAllowed

public boolean isWindowStateAllowed(WindowState state)

Specified by:

isWindowStateAllowed in interface PortletRequest

getServiceInterfaceInstanceId

public String getServiceInterfaceInstanceId()

Specified by:

getServiceInterfaceInstanceId in interface IServiceInterfaceRequest

Returns:

Returns the serviceInterfaceInstanceId.

setPageConfig

public void setPageConfig(PageConfig pageConfig)

getPageConfig

public PageConfig getPageConfig()

Specified by:

getPageConfig in interface IServiceInterfaceRequest

Returns:

setSessionConfig

public void setSessionConfig(SessionConfig sessionConfig)

Specified by:

setSessionConfig in interface IServiceInterfaceRequest

getSessionConfig

public SessionConfig getSessionConfig()

Specified by:

getSessionConfig in interface IServiceInterfaceRequest

Returns:

setServiceInterfaceInstanceConfig

public void setServiceInterfaceInstanceConfig(ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig)

getServiceInterfaceInstanceConfig

public ServiceInterfaceInstanceConfig getServiceInterfaceInstanceConfig()

Specified by:

getServiceInterfaceInstanceConfig in interface IServiceInterfaceRequest

Returns:

the source page

setServiceInterfaceConfig

public void setServiceInterfaceConfig(ServiceInterfaceConfig serviceInterfaceConfig)

getServiceInterfaceConfig

public ServiceInterfaceConfig getServiceInterfaceConfig()

Specified by:

getServiceInterfaceConfig in interface IServiceInterfaceRequest

Returns:

setServiceInstanceConfig

public void setServiceInstanceConfig(ServiceInstanceConfig serviceInstanceConfig)

getServiceInstanceConfig

public ServiceInstanceConfig getServiceInstanceConfig()

Specified by:

getServiceInstanceConfig in interface IServiceInterfaceRequest

Returns:

setServiceConfig

public void setServiceConfig(ServiceConfig serviceConfig)

getServiceConfig

public ServiceConfig getServiceConfig()

Specified by:

getServiceConfig in interface IServiceInterfaceRequest

Returns:

getServiceContainerHttpServletRequest

public ServiceContainerHttpServletRequest getServiceContainerHttpServletRequest()

getCookies

public Cookie[] getCookies()

Specified by:

getCookies in interface HttpServletRequest

Specified by:

getCookies in interface IServiceInterfaceRequest

Overrides:

getCookies in class HttpServletRequestWrapper

getCookie

public Cookie getCookie(String cookieName)

Specified by:

getCookie in interface IServiceInterfaceRequest

getRequestDispatcher

public IServiceInterfaceRequestDispatcher getRequestDispatcher(String path)

Specified by:

getRequestDispatcher in interface ServletRequest

Specified by:

getRequestDispatcher in interface IServiceInterfaceRequest

Overrides:

getRequestDispatcher in class ServletRequestWrapper

setServiceInstanceDebugLevel

public void setServiceInstanceDebugLevel(int serviceInstanceDebugLevel)

getServiceInstanceDebugLevel

public int getServiceInstanceDebugLevel()

Specified by:

getServiceInstanceDebugLevel in interface IServiceInterfaceRequest

setServiceInterfaceInstanceParameters

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

Throws:

Exception

getFileParameter

public FileParameter getFileParameter(String parameterName)

Specified by:

getFileParameter in interface IServiceInterfaceRequest

setServiceInterfaceInstanceFileParameters

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

Throws:

Exception

getCallerServiceInterfaceInstanceId

public String getCallerServiceInterfaceInstanceId()

Specified by:

getCallerServiceInterfaceInstanceId in interface IServiceInterfaceRequest

Returns:

Returns the callerServiceInterfaceInstanceConfig.

setCallerServiceInterfaceInstanceId

public void setCallerServiceInterfaceInstanceId(String callerServiceInterfaceInstanceId)

Parameters:

callerServiceInterfaceInstanceConfig - The callerServiceInterfaceInstanceConfig to set.

isPreview

public boolean isPreview()

Specified by:

isPreview in interface IServiceInterfaceRequest

setPreview

public void setPreview(boolean isPreview)

getMode

public int getMode()

Specified by:

getMode in interface IServiceInterfaceRequest

setMode

public void setMode(int mode)

Specified by:

setMode in interface IServiceInterfaceRequest

getVariableResolver

public VariableResolver getVariableResolver()

Returns the variable resolver for this request's implicit objects.

Returns:

the variable resolver for this request's implicit objects.

Since:

4.0.7