Package lumis.portal.servicecontainer

Class ServiceContainerRequest

    • Field Detail

      • serviceInterfaceInstanceId

        protected java.lang.String serviceInterfaceInstanceId

      • callerServiceInterfaceInstanceId

        protected java.lang.String callerServiceInterfaceInstanceId

      • serviceInstanceDebugLevel

        protected int serviceInstanceDebugLevel

      • isPreview

        protected boolean isPreview

      • preferences

        protected IPreferences 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

    • Method Detail

      • setCharacterEncoding

        public void setCharacterEncoding​(java.lang.String encoding)
                          throws java.io.UnsupportedEncodingException
        This method does nothing. The ServiceContainerRequest character encoding may not be changed.
        Specified by:
        setCharacterEncoding in interface javax.servlet.ServletRequest
        Overrides:
        setCharacterEncoding in class javax.servlet.ServletRequestWrapper
        Throws:
        java.io.UnsupportedEncodingException

      • getPortletSession

        public javax.portlet.PortletSession getPortletSession()
        Specified by:
        getPortletSession in interface javax.portlet.PortletRequest

      • getPortletSession

        public javax.portlet.PortletSession getPortletSession​(boolean create)
        Specified by:
        getPortletSession in interface javax.portlet.PortletRequest

      • getParameter

        public java.lang.String getParameter​(java.lang.String name)
        Description copied from interface: IPageWebResourceRequest
        Returns the value of a request parameter as a String, or null if the parameter does not exist. Request parameters are extra information sent with the request. The returned parameter are "x-www-form-urlencoded" decoded.

        This method should only be used if the parameter has only one value. If the parameter might have more than one value, use IPageWebResourceRequest.getParameterValues(java.lang.String).

        If this method is used with a multivalued parameter, the value returned is equal to the first value in the array returned by getParameterValues.

        Specified by:
        getParameter in interface IPageWebResourceRequest
        Specified by:
        getParameter in interface javax.portlet.PortletRequest
        Specified by:
        getParameter in interface javax.servlet.ServletRequest
        Overrides:
        getParameter in class PageWebResourceRequest
        Parameters:
        name - a String specifying the name of the parameter
        Returns:
        a String representing the single value of the parameter
        See Also:
        IPageWebResourceRequest.getParameterValues(java.lang.String)

      • getParameterNames

        public java.util.Enumeration<java.lang.String> getParameterNames()
        Description copied from interface: IPageWebResourceRequest
        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 .
        Specified by:
        getParameterNames in interface IPageWebResourceRequest
        Specified by:
        getParameterNames in interface IServiceInterfaceRequest
        Specified by:
        getParameterNames in interface javax.portlet.PortletRequest
        Specified by:
        getParameterNames in interface javax.servlet.ServletRequest
        Overrides:
        getParameterNames in class PageWebResourceRequest
        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 java.lang.String[] getParameterValues​(java.lang.String name)
        Description copied from interface: IPageWebResourceRequest
        Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist. The returned parameters are "x-www-form-urlencoded" decoded.

        If the parameter has a single value, the array has a length of 1.

        Specified by:
        getParameterValues in interface IPageWebResourceRequest
        Specified by:
        getParameterValues in interface javax.portlet.PortletRequest
        Specified by:
        getParameterValues in interface javax.servlet.ServletRequest
        Overrides:
        getParameterValues in class PageWebResourceRequest
        Parameters:
        name - a String containing the name of the parameter the value of which is requested
        Returns:
        an array of String objects containing the parameter values.
        See Also:
        IPageWebResourceRequest.getParameter(java.lang.String)

      • getParameterMap

        public java.util.Map<java.lang.String,​java.lang.String[]> getParameterMap()
        Description copied from interface: IPageWebResourceRequest
        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 IServiceInterfaceRequest
        Specified by:
        getParameterMap in interface javax.portlet.PortletRequest
        Specified by:
        getParameterMap in interface javax.servlet.ServletRequest
        Overrides:
        getParameterMap in class PageWebResourceRequest
        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 java.security.Principal getUserPrincipal()
        Specified by:
        getUserPrincipal in interface javax.servlet.http.HttpServletRequest
        Specified by:
        getUserPrincipal in interface javax.portlet.PortletRequest
        Overrides:
        getUserPrincipal in class javax.servlet.http.HttpServletRequestWrapper

      • isUserInRole

        public boolean isUserInRole​(java.lang.String arg0)
        Specified by:
        isUserInRole in interface javax.servlet.http.HttpServletRequest
        Specified by:
        isUserInRole in interface javax.portlet.PortletRequest
        Overrides:
        isUserInRole in class javax.servlet.http.HttpServletRequestWrapper

      • getLocale

        public java.util.Locale getLocale()
        Specified by:
        getLocale in interface javax.portlet.PortletRequest
        Specified by:
        getLocale in interface javax.servlet.ServletRequest
        Overrides:
        getLocale in class javax.servlet.ServletRequestWrapper

      • getLocales

        public java.util.Enumeration<java.util.Locale> getLocales()
        Specified by:
        getLocales in interface javax.portlet.PortletRequest
        Specified by:
        getLocales in interface javax.servlet.ServletRequest
        Overrides:
        getLocales in class javax.servlet.ServletRequestWrapper

      • getAttributeNames

        public java.util.Enumeration<java.lang.String> getAttributeNames()
        Description copied from interface: IPageWebResourceRequest
        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 IServiceInterfaceRequest
        Specified by:
        getAttributeNames in interface javax.portlet.PortletRequest
        Specified by:
        getAttributeNames in interface javax.servlet.ServletRequest
        Overrides:
        getAttributeNames in class PageWebResourceRequest
        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 java.lang.Object getAttribute​(java.lang.String key)
        Description copied from interface: IPageWebResourceRequest
        Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
        Specified by:
        getAttribute in interface IPageWebResourceRequest
        Specified by:
        getAttribute in interface javax.portlet.PortletRequest
        Specified by:
        getAttribute in interface javax.servlet.ServletRequest
        Overrides:
        getAttribute in class PageWebResourceRequest
        Parameters:
        key - a String specifying the name of the attribute
        Returns:
        an Object containing the value of the attribute, or null if the attribute does not exist.

      • setAttribute

        public void setAttribute​(java.lang.String key,
                         java.lang.Object value)
        Description copied from interface: IPageWebResourceRequest
        Stores an attribute in this request.
        Specified by:
        setAttribute in interface IPageWebResourceRequest
        Specified by:
        setAttribute in interface javax.portlet.PortletRequest
        Specified by:
        setAttribute in interface javax.servlet.ServletRequest
        Overrides:
        setAttribute in class PageWebResourceRequest
        Parameters:
        key - a String specifying the name of the attribute
        value - the Object to be stored

      • removeAttribute

        public void removeAttribute​(java.lang.String key)
        Description copied from interface: IPageWebResourceRequest
        Removes an attribute from this request. This method is not generally needed, as attributes only persist as long as the request is being handled.
        Specified by:
        removeAttribute in interface IPageWebResourceRequest
        Specified by:
        removeAttribute in interface javax.portlet.PortletRequest
        Specified by:
        removeAttribute in interface javax.servlet.ServletRequest
        Overrides:
        removeAttribute in class PageWebResourceRequest
        Parameters:
        key - a String specifying the name of the attribute to be removed

      • getProperty

        public java.lang.String getProperty​(java.lang.String name)
        Specified by:
        getProperty in interface javax.portlet.PortletRequest

      • getProperties

        public java.util.Enumeration<java.lang.String> getProperties​(java.lang.String name)
        Specified by:
        getProperties in interface javax.portlet.PortletRequest

      • getPropertyNames

        public java.util.Enumeration<java.lang.String> getPropertyNames()
        Specified by:
        getPropertyNames in interface javax.portlet.PortletRequest

      • getPortalContext

        public javax.portlet.PortalContext getPortalContext()
        Specified by:
        getPortalContext in interface javax.portlet.PortletRequest

      • getPortletMode

        public javax.portlet.PortletMode getPortletMode()
        Specified by:
        getPortletMode in interface javax.portlet.PortletRequest

      • getResponseContentType

        public java.lang.String getResponseContentType()
        Specified by:
        getResponseContentType in interface javax.portlet.PortletRequest

      • getResponseContentTypes

        public java.util.Enumeration<java.lang.String> getResponseContentTypes()
        Specified by:
        getResponseContentTypes in interface javax.portlet.PortletRequest

      • getWindowState

        public javax.portlet.WindowState getWindowState()
        Specified by:
        getWindowState in interface javax.portlet.PortletRequest

      • isPortletModeAllowed

        public boolean isPortletModeAllowed​(javax.portlet.PortletMode mode)
        Specified by:
        isPortletModeAllowed in interface javax.portlet.PortletRequest

      • isWindowStateAllowed

        public boolean isWindowStateAllowed​(javax.portlet.WindowState state)
        Specified by:
        isWindowStateAllowed in interface javax.portlet.PortletRequest

      • setServiceInterfaceInstanceConfig

        public void setServiceInterfaceInstanceConfig​(ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig)

      • setServiceInterfaceConfig

        public void setServiceInterfaceConfig​(ServiceInterfaceConfig serviceInterfaceConfig)

      • setServiceInstanceConfig

        public void setServiceInstanceConfig​(ServiceInstanceConfig serviceInstanceConfig)

      • setServiceConfig

        public void setServiceConfig​(ServiceConfig serviceConfig)

      • setServiceInstanceDebugLevel

        public void setServiceInstanceDebugLevel​(int serviceInstanceDebugLevel)

      • setServiceInterfaceInstanceParameters

        public void setServiceInterfaceInstanceParameters​(java.util.Map<java.lang.String,​java.lang.String[]> parameters)
                                           throws java.lang.Exception
        Throws:
        java.lang.Exception

      • setServiceInterfaceInstanceFileParameters

        public void setServiceInterfaceInstanceFileParameters​(java.util.Map<java.lang.String,​FileParameter> parameters)
                                               throws java.lang.Exception
        Throws:
        java.lang.Exception

      • setCallerServiceInterfaceInstanceId

        public void setCallerServiceInterfaceInstanceId​(java.lang.String callerServiceInterfaceInstanceId)
        Parameters:
        callerServiceInterfaceInstanceConfig - The callerServiceInterfaceInstanceConfig to set.

      • setPreview

        public void setPreview​(boolean isPreview)

      • getPrivateParameterMap

        public java.util.Map<java.lang.String,​java.lang.String[]> getPrivateParameterMap()
        Specified by:
        getPrivateParameterMap in interface javax.portlet.PortletRequest

      • getPublicParameterMap

        public java.util.Map<java.lang.String,​java.lang.String[]> getPublicParameterMap()
        Specified by:
        getPublicParameterMap in interface javax.portlet.PortletRequest

      • getWindowID

        public java.lang.String getWindowID()
        Specified by:
        getWindowID in interface javax.portlet.PortletRequest

      • createFunctionMapper

        protected javax.servlet.jsp.el.FunctionMapper createFunctionMapper​(ServiceContainerResponse response)
        Creates a FunctionMapper based on the given response.
        Parameters:
        response - the response.
        Returns:
        the created FunctionMapper.
        Since:
        7.0.0

      • setResponse

        protected void setResponse​(ServiceContainerResponse response)
        Sets the given response in this request.
        Parameters:
        response - the response.
        Since:
        7.0.0

      • getBaseServiceInterfaceInstanceConfig

        public ServiceInterfaceInstanceConfig getBaseServiceInterfaceInstanceConfig()
        Returns the base service interface instance.
        Returns:
        the base service interface instance.
        Since:
        7.0.0

      • setBaseServiceInterfaceInstanceConfig

        public void setBaseServiceInterfaceInstanceConfig​(ServiceInterfaceInstanceConfig baseServiceInterfaceInstanceConfig)
        Sets the base interface instance.
        Parameters:
        baseServiceInterfaceInstanceConfig - the base interface instance.
        Since:
        7.0.0