Class AbstractRequestVariableResolver

  • All Implemented Interfaces:
    VariableResolver
    Direct Known Subclasses:
    HttpServletRequestVariableResolver, ServiceContainerRequestVariableResolver

    public abstract class AbstractRequestVariableResolver
    extends PortalVariableResolver
    Abstract VariableResolver that resolves general request variables. The implicit objects resolved by this class are:
    • param: Maps a request parameter name to a single value.
    • paramValues: Maps a request parameter name to an array of values.
    • header: Maps a request header name to a single value.
    • headerValues: Maps a request header name to an array of values.
    • cookie: Maps a cookie name to a single cookie.
    • initParam: Maps a context initialization parameter name to a single value.
    • requestScope: Maps request-scoped variable names to their values.
    • sessionScope: Maps session-scoped variable names to their values. Corresponds to the application scope of the PortletSession.
    • applicationScope: Maps application-scoped variable names to their values.
    • businessContext: Maps business context property identifiers to their values.
    Since:
    7.0.0
    Version:
    $Revision: 17685 $ $Date: 2015-08-17 19:29:13 -0300 (Mon, 17 Aug 2015) $
    • Constructor Detail

      • AbstractRequestVariableResolver

        public AbstractRequestVariableResolver()
    • Method Detail

      • getParameter

        protected abstract String getParameter​(String parameterName)
        Returns the parameter with the given name.
        Parameters:
        parameterName - the parameter name.
        Returns:
        the parameter with the given name.
        Since:
        7.0.0
      • getAttribute

        protected abstract Object getAttribute​(String attributeName)
        Returns the attribute with the given name.
        Parameters:
        attributeName - the attribute name.
        Returns:
        the attribute with the given name.
        Since:
        7.0.0
      • getCookies

        protected abstract Cookie[] getCookies()
        Returns the cookies.
        Returns:
        the cookies.
        Since:
        7.0.0
      • getHeaders

        protected abstract Enumeration getHeaders​(String headerName)
        Returns the headers with the given name.
        Parameters:
        headerName - the header name.
        Returns:
        the headers with the given name.
        Since:
        7.0.0
      • getHeader

        protected abstract String getHeader​(String headerName)
        Returns the header with the given name.
        Parameters:
        headerName -
        Returns:
        the header with the given name.
        Since:
        7.0.0
      • getParameterMap

        protected abstract Object getParameterMap()
        Returns the parameter map.
        Returns:
        the parameter map.
        Since:
        7.0.0
      • getSessionScopeMap

        protected abstract Map<String,​Object> getSessionScopeMap()
        Returns the session scope map.
        Returns:
        the session scope map.
        Since:
        7.0.0
      • getInitParamMap

        protected abstract Map<String,​Object> getInitParamMap()
        Returns the init parameters.
        Returns:
        the init parameters.
        Since:
        7.0.0
      • getApplicationScopeMap

        protected abstract Map<String,​Object> getApplicationScopeMap()
        Returns the application scope map.
        Returns:
        the application scope map.
        Since:
        7.0.0
      • getBusinessContextProperty

        protected abstract String getBusinessContextProperty​(String key)
        Returns the value with the given property id.
        Parameters:
        key - the property id.
        Returns:
        the value of the property with the given id.
        Since:
        7.0.0