Package javax.portlet.filter

Class PortletRequestWrapper

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object getAttribute​(java.lang.String name)
      The default behavior of this method is to call getAttribute(String name) on the wrapped request object.
      java.util.Enumeration<java.lang.String> getAttributeNames()
      The default behavior of this method is to call getAttributeNames() on the wrapped request object.
      java.lang.String getAuthType()
      The default behavior of this method is to call getAuthType() on the wrapped request object.
      java.lang.String getContextPath()
      The default behavior of this method is to call getContextPath() on the wrapped request object.
      javax.servlet.http.Cookie[] getCookies()
      The default behavior of this method is to call getCookies() on the wrapped request object.
      java.util.Locale getLocale()
      The default behavior of this method is to call getLocale() on the wrapped request object.
      java.util.Enumeration<java.util.Locale> getLocales()
      The default behavior of this method is to call getLocales() on the wrapped request object.
      java.lang.String getParameter​(java.lang.String name)
      The default behavior of this method is to call getParameter(String name) on the wrapped request object.
      java.util.Map<java.lang.String,​java.lang.String[]> getParameterMap()
      The default behavior of this method is to call getParameterMap() on the wrapped request object.
      java.util.Enumeration<java.lang.String> getParameterNames()
      The default behavior of this method is to call getParameterNames() on the wrapped request object.
      java.lang.String[] getParameterValues​(java.lang.String name)
      The default behavior of this method is to call getParameterValues(name) on the wrapped request object.
      PortalContext getPortalContext()
      The default behavior of this method is to call getPortalContext() on the wrapped request object.
      PortletMode getPortletMode()
      The default behavior of this method is to call getPortletMode() on the wrapped request object.
      PortletSession getPortletSession()
      The default behavior of this method is to call getPortletSession() on the wrapped request object.
      PortletSession getPortletSession​(boolean create)
      The default behavior of this method is to call getPortletSession(create) on the wrapped request object.
      PortletPreferences getPreferences()
      The default behavior of this method is to call getPreferences() on the wrapped request object.
      java.util.Map<java.lang.String,​java.lang.String[]> getPrivateParameterMap()
      The default behavior of this method is to call getPrivateParameterMap() on the wrapped request object.
      java.util.Enumeration<java.lang.String> getProperties​(java.lang.String name)
      The default behavior of this method is to call getProperteis(name) on the wrapped request object.
      java.lang.String getProperty​(java.lang.String name)
      The default behavior of this method is to call getProperty(name) on the wrapped request object.
      java.util.Enumeration<java.lang.String> getPropertyNames()
      The default behavior of this method is to call getPropertyNames() on the wrapped request object.
      java.util.Map<java.lang.String,​java.lang.String[]> getPublicParameterMap()
      The default behavior of this method is to call getPublicParameterMap() on the wrapped request object.
      java.lang.String getRemoteUser()
      The default behavior of this method is to call getRemoteUser() on the wrapped request object.
      PortletRequest getRequest()
      Return the wrapped request object.
      java.lang.String getRequestedSessionId()
      The default behavior of this method is to call getRequestedSessionId() on the wrapped request object.
      java.lang.String getResponseContentType()
      The default behavior of this method is to call getResponseContentType() on the wrapped request object.
      java.util.Enumeration<java.lang.String> getResponseContentTypes()
      The default behavior of this method is to call getResponseContentTypes() on the wrapped request object.
      java.lang.String getScheme()
      The default behavior of this method is to call getScheme() on the wrapped request object.
      java.lang.String getServerName()
      The default behavior of this method is to call getServerName() on the wrapped request object.
      int getServerPort()
      The default behavior of this method is to call getServerPort() on the wrapped request object.
      java.security.Principal getUserPrincipal()
      The default behavior of this method is to call getUserPrincipal() on the wrapped request object.
      java.lang.String getWindowID()
      The default behavior of this method is to call getWindowId() on the wrapped request object.
      WindowState getWindowState()
      The default behavior of this method is to call getWindowState() on the wrapped request object.
      boolean isPortletModeAllowed​(PortletMode mode)
      The default behavior of this method is to call isPortletModeAllowed(mode) on the wrapped request object.
      boolean isRequestedSessionIdValid()
      The default behavior of this method is to call isRequestedSessionIdValid() on the wrapped request object.
      boolean isSecure()
      The default behavior of this method is to call isSecure() on the wrapped request object.
      boolean isUserInRole​(java.lang.String role)
      The default behavior of this method is to call isUserInRole(role) on the wrapped request object.
      boolean isWindowStateAllowed​(WindowState state)
      The default behavior of this method is to call isWindowStateAllowed(state) on the wrapped request object.
      void removeAttribute​(java.lang.String name)
      The default behavior of this method is to call removeAttribute(name) on the wrapped request object.
      void setAttribute​(java.lang.String name, java.lang.Object o)
      The default behavior of this method is to call setAttribute(name, o) on the wrapped request object.
      void setRequest​(PortletRequest request)
      Sets the request object being wrapped.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PortletRequestWrapper

        public PortletRequestWrapper​(PortletRequest request)
        Creates an PortletRequest adaptor wrapping the given request object.
        Parameters:
        request - the portlet request to wrap
        Throws:
        java.lang.IllegalArgumentException - if the request is null

    • Method Detail

      • getAttribute

        public java.lang.Object getAttribute​(java.lang.String name)
        The default behavior of this method is to call getAttribute(String name) on the wrapped request object.
        Specified by:
        getAttribute in interface PortletRequest
        Parameters:
        name - 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.

      • getAttributeNames

        public java.util.Enumeration<java.lang.String> getAttributeNames()
        The default behavior of this method is to call getAttributeNames() on the wrapped request object.
        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.

      • getAuthType

        public java.lang.String getAuthType()
        The default behavior of this method is to call getAuthType() on the wrapped request object.
        Specified by:
        getAuthType in interface PortletRequest
        Returns:
        one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH (suitable for == comparison) indicating the authentication scheme, a custom one, or null if the request was not authenticated.

      • getContextPath

        public java.lang.String getContextPath()
        The default behavior of this method is to call getContextPath() on the wrapped request object.
        Specified by:
        getContextPath in interface PortletRequest
        Returns:
        a String specifying the portion of the request URL that indicates the context of the request
        See Also:
        PortletResponse.encodeURL(java.lang.String)

      • getLocale

        public java.util.Locale getLocale()
        The default behavior of this method is to call getLocale() on the wrapped request object.
        Specified by:
        getLocale in interface PortletRequest
        Returns:
        the preferred Locale in which the portal will accept content.

      • getLocales

        public java.util.Enumeration<java.util.Locale> getLocales()
        The default behavior of this method is to call getLocales() on the wrapped request object.
        Specified by:
        getLocales in interface PortletRequest
        Returns:
        an Enumeration of Locales, in decreasing order, in which the portal will accept content for this request

      • getParameter

        public java.lang.String getParameter​(java.lang.String name)
        The default behavior of this method is to call getParameter(String name) on the wrapped request object.
        Specified by:
        getParameter in interface PortletRequest
        Parameters:
        name - a String specifying the name of the parameter
        Returns:
        a String representing the single value of the parameter
        See Also:
        PortletRequest.getParameterValues(java.lang.String)

      • getParameterMap

        public java.util.Map<java.lang.String,​java.lang.String[]> getParameterMap()
        The default behavior of this method is to call getParameterMap() on the wrapped request object.
        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[]).

      • getParameterNames

        public java.util.Enumeration<java.lang.String> getParameterNames()
        The default behavior of this method is to call getParameterNames() on the wrapped request object.
        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.

      • getParameterValues

        public java.lang.String[] getParameterValues​(java.lang.String name)
        The default behavior of this method is to call getParameterValues(name) on the wrapped request object.
        Specified by:
        getParameterValues in interface PortletRequest
        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:
        PortletRequest.getParameter(java.lang.String)

      • getPortalContext

        public PortalContext getPortalContext()
        The default behavior of this method is to call getPortalContext() on the wrapped request object.
        Specified by:
        getPortalContext in interface PortletRequest
        Returns:
        the context of the calling portal

      • getPortletMode

        public PortletMode getPortletMode()
        The default behavior of this method is to call getPortletMode() on the wrapped request object.
        Specified by:
        getPortletMode in interface PortletRequest
        Returns:
        the portlet mode

      • getPortletSession

        public PortletSession getPortletSession()
        The default behavior of this method is to call getPortletSession() on the wrapped request object.
        Specified by:
        getPortletSession in interface PortletRequest
        Returns:
        the portlet session

      • getPortletSession

        public PortletSession getPortletSession​(boolean create)
        The default behavior of this method is to call getPortletSession(create) on the wrapped request object.
        Specified by:
        getPortletSession in interface PortletRequest
        Parameters:
        create - true to create a new session,
        false to return null if there is no current session
        Returns:
        the portlet session

      • getPreferences

        public PortletPreferences getPreferences()
        The default behavior of this method is to call getPreferences() on the wrapped request object.
        Specified by:
        getPreferences in interface PortletRequest
        Returns:
        the portlet preferences

      • getProperties

        public java.util.Enumeration<java.lang.String> getProperties​(java.lang.String name)
        The default behavior of this method is to call getProperteis(name) on the wrapped request object.
        Specified by:
        getProperties in interface PortletRequest
        Parameters:
        name - a String specifying the property name
        Returns:
        a Enumeration containing the values of the requested property. If the request does not have any properties of that name return an empty Enumeration.

      • getProperty

        public java.lang.String getProperty​(java.lang.String name)
        The default behavior of this method is to call getProperty(name) on the wrapped request object.
        Specified by:
        getProperty in interface PortletRequest
        Parameters:
        name - a String specifying the property name
        Returns:
        a String containing the value of the requested property, or null if the request does not have a property of that name.

      • getPropertyNames

        public java.util.Enumeration<java.lang.String> getPropertyNames()
        The default behavior of this method is to call getPropertyNames() on the wrapped request object.
        Specified by:
        getPropertyNames in interface PortletRequest
        Returns:
        an Enumeration of all the property names sent with this request; if the request has no properties, an empty Enumeration.

      • getRemoteUser

        public java.lang.String getRemoteUser()
        The default behavior of this method is to call getRemoteUser() on the wrapped request object.
        Specified by:
        getRemoteUser in interface PortletRequest
        Returns:
        a String specifying the login of the user making this request, or null if the user login is not known.

      • getRequestedSessionId

        public java.lang.String getRequestedSessionId()
        The default behavior of this method is to call getRequestedSessionId() on the wrapped request object.
        Specified by:
        getRequestedSessionId in interface PortletRequest
        Returns:
        a String specifying the session ID, or null if the request did not specify a session ID
        See Also:
        PortletRequest.isRequestedSessionIdValid()

      • getResponseContentType

        public java.lang.String getResponseContentType()
        The default behavior of this method is to call getResponseContentType() on the wrapped request object.
        Specified by:
        getResponseContentType in interface PortletRequest
        Returns:
        preferred MIME type of the response

      • getResponseContentTypes

        public java.util.Enumeration<java.lang.String> getResponseContentTypes()
        The default behavior of this method is to call getResponseContentTypes() on the wrapped request object.
        Specified by:
        getResponseContentTypes in interface PortletRequest
        Returns:
        ordered list of MIME types for the response

      • getScheme

        public java.lang.String getScheme()
        The default behavior of this method is to call getScheme() on the wrapped request object.
        Specified by:
        getScheme in interface PortletRequest
        Returns:
        a String containing the name of the scheme used to make this request

      • getServerName

        public java.lang.String getServerName()
        The default behavior of this method is to call getServerName() on the wrapped request object.
        Specified by:
        getServerName in interface PortletRequest
        Returns:
        a String containing the name of the server to which the request was sent

      • getServerPort

        public int getServerPort()
        The default behavior of this method is to call getServerPort() on the wrapped request object.
        Specified by:
        getServerPort in interface PortletRequest
        Returns:
        an integer specifying the port number

      • getUserPrincipal

        public java.security.Principal getUserPrincipal()
        The default behavior of this method is to call getUserPrincipal() on the wrapped request object.
        Specified by:
        getUserPrincipal in interface PortletRequest
        Returns:
        a java.security.Principal containing the name of the user making this request, or null if the user has not been authenticated.

      • getWindowID

        public java.lang.String getWindowID()
        The default behavior of this method is to call getWindowId() on the wrapped request object.
        Specified by:
        getWindowID in interface PortletRequest
        Returns:
        the portlet window ID

      • getWindowState

        public WindowState getWindowState()
        The default behavior of this method is to call getWindowState() on the wrapped request object.
        Specified by:
        getWindowState in interface PortletRequest
        Returns:
        the window state

      • isPortletModeAllowed

        public boolean isPortletModeAllowed​(PortletMode mode)
        The default behavior of this method is to call isPortletModeAllowed(mode) on the wrapped request object.
        Specified by:
        isPortletModeAllowed in interface PortletRequest
        Parameters:
        mode - portlet mode to check
        Returns:
        true, if it is valid for this portlet in this request to change to the given portlet mode

      • isSecure

        public boolean isSecure()
        The default behavior of this method is to call isSecure() on the wrapped request object.
        Specified by:
        isSecure in interface PortletRequest
        Returns:
        true, if the request was made using a secure channel.

      • isUserInRole

        public boolean isUserInRole​(java.lang.String role)
        The default behavior of this method is to call isUserInRole(role) on the wrapped request object.
        Specified by:
        isUserInRole in interface PortletRequest
        Parameters:
        role - a String specifying the name of the role
        Returns:
        a boolean indicating whether the user making this request belongs to a given role; false if the user has not been authenticated.

      • isWindowStateAllowed

        public boolean isWindowStateAllowed​(WindowState state)
        The default behavior of this method is to call isWindowStateAllowed(state) on the wrapped request object.
        Specified by:
        isWindowStateAllowed in interface PortletRequest
        Parameters:
        state - window state to checked
        Returns:
        true, if it is valid for this portlet in this request to change to the given window state

      • removeAttribute

        public void removeAttribute​(java.lang.String name)
        The default behavior of this method is to call removeAttribute(name) on the wrapped request object.
        Specified by:
        removeAttribute in interface PortletRequest
        Parameters:
        name - a String specifying the name of the attribute to be removed

      • setAttribute

        public void setAttribute​(java.lang.String name,
                         java.lang.Object o)
        The default behavior of this method is to call setAttribute(name, o) on the wrapped request object.
        Specified by:
        setAttribute in interface PortletRequest
        Parameters:
        name - a String specifying the name of the attribute
        o - the Object to be stored

      • getRequest

        public PortletRequest getRequest()
        Return the wrapped request object.
        Returns:
        the wrapped request

      • setRequest

        public void setRequest​(PortletRequest request)
        Sets the request object being wrapped.
        Parameters:
        request - the request to set
        Throws:
        java.lang.IllegalArgumentException - if the request is null.

      • getCookies

        public javax.servlet.http.Cookie[] getCookies()
        The default behavior of this method is to call getCookies() on the wrapped request object.
        Specified by:
        getCookies in interface PortletRequest
        Returns:
        array of cookie properties, or null if no cookies exist.
        See Also:
        PortletResponse.addProperty(Cookie)

      • getPrivateParameterMap

        public java.util.Map<java.lang.String,​java.lang.String[]> getPrivateParameterMap()
        The default behavior of this method is to call getPrivateParameterMap() on the wrapped request object.
        Specified by:
        getPrivateParameterMap in interface PortletRequest
        Returns:
        an immutable Map containing private parameter names as keys and private parameter values as map values, or an empty Map if no private parameters exist. The keys in the parameter map are of type String. The values in the parameter map are of type String array (String[]).

      • getPublicParameterMap

        public java.util.Map<java.lang.String,​java.lang.String[]> getPublicParameterMap()
        The default behavior of this method is to call getPublicParameterMap() on the wrapped request object.
        Specified by:
        getPublicParameterMap in interface PortletRequest
        Returns:
        an immutable Map containing public parameter names as keys and public parameter values as map values, or an empty Map if no public parameters exist. The keys in the parameter map are of type String. The values in the parameter map are of type String array (String[]).