Package org.hippoecm.hst.core.component

Interface HstRequest

  • All Superinterfaces:
    javax.servlet.http.HttpServletRequest, ModelContributable, javax.servlet.ServletRequest
    public interface HstRequest
extends javax.servlet.http.HttpServletRequest, ModelContributable
    The HstRequest defines the interface to provide client request information to a HstComponent. The HstComponent container creates these objects and passes them as arguments to the HstComponent's doAction, doBeforeRender and doBeforeServeResource methods.
    Version:
    $Id$

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String ACTION_PHASE
      String identifier for the HST action lifecycle phase.
      static String RENDER_PHASE
      String identifier for the HST render lifecycle phase.
      static String RESOURCE_PHASE
      String identifier for the HST resource serving lifecycle phase.

      • Fields inherited from interface javax.servlet.http.HttpServletRequest

        BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Map<String,​Object> getAttributeMap()
      Returns the attribute map of this component window.
      Map<String,​Object> getAttributeMap​(String referenceNamespace)
      Returns the attribute map of the specified reference namespace component window.
      String getLifecyclePhase()
      Returns the lifecycle phase of the current HST request.
      Map<String,​String[]> getParameterMap()
      Returns the parameter map of this component window.
      Map<String,​String[]> getParameterMap​(String referenceNamespace)
      Returns the parameter map of the specified reference namespace component window.
      String getReferenceNamespace()
      The reference namespace of the component window.
      HstRequestContext getRequestContext()
      Returns the current request context
      String getResourceID()
      Returns the resource ID which was set by the resource HST URL.

      • Methods inherited from interface javax.servlet.http.HttpServletRequest

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

      • Methods inherited from interface javax.servlet.ServletRequest

        getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

    • Field Detail

      • RESOURCE_PHASE

        static final String RESOURCE_PHASE
        String identifier for the HST resource serving lifecycle phase.
        See Also:
        Constant Field Values

    • Method Detail

      • getRequestContext

        HstRequestContext getRequestContext()
        Returns the current request context

      • getParameterMap

        Map<String,​String[]> getParameterMap()
        Returns the parameter map of this component window. If the request is in the action lifecycle, then only action parameters can be accessible. Otherwise, then only render parameters can be accessible.
        Specified by:
        getParameterMap in interface javax.servlet.ServletRequest
        Returns:
        an immutable java.util.Map<String, String []> containing parameter names as keys and parameter values as map values. The keys in the parameter map are of type String. The values in the parameter map are of type String array.

      • getReferenceNamespace

        String getReferenceNamespace()
        The reference namespace of the component window.
        Returns:
        the reference namespace of the component window

      • getParameterMap

        Map<String,​String[]> getParameterMap​(String referenceNamespace)
        Returns the parameter map of the specified reference namespace component window. If the request type is in the action lifecycle, the reference namespace parameter will be just ignored and the operation will be equivalent to getParameterMap().
        Parameters:
        referenceNamespace -

      • getAttributeMap

        Map<String,​Object> getAttributeMap()
        Returns the attribute map of this component window.

      • getAttributeMap

        Map<String,​Object> getAttributeMap​(String referenceNamespace)
        Returns the attribute map of the specified reference namespace component window.

      • getResourceID

        String getResourceID()
        Returns the resource ID which was set by the resource HST URL.