Interface ContainerConstants


  • public interface ContainerConstants
    HstComponent container constants
    Version:
    $Id$
    • Field Detail

      • HST_REQUEST

        static final String HST_REQUEST
        The key used to bind the HstRequest to the underlying HttpServletRequest.
        See Also:
        Constant Field Values
      • HST_RESPONSE

        static final String HST_RESPONSE
        The key used to bind the HstResponse to the underlying HttpServletRequest.
        See Also:
        Constant Field Values
      • HST_COMPONENT_WINDOW

        static final String HST_COMPONENT_WINDOW
        The key used to bind the HstComponentWindow to the underlying HttpServletRequest.
        See Also:
        Constant Field Values
      • HST_REQUEST_CONTEXT

        static final String HST_REQUEST_CONTEXT
        The attribute name used to set the request context object into the servlet request.
        See Also:
        Constant Field Values
      • DEFAULT_ADDON_MODULE_DESCRIPTOR_PATHS

        static final String DEFAULT_ADDON_MODULE_DESCRIPTOR_PATHS
        Default Addon module descriptor paths, which can be comma separated multiple path values.
        See Also:
        Constant Field Values
      • CONTAINER_REFERENCE_NAMESPACE

        static final String CONTAINER_REFERENCE_NAMESPACE
        The reference namespace for container managed resource url.
        See Also:
        Constant Field Values
      • HST_RESET_FILTER

        static final String HST_RESET_FILTER
        The key to indicate HstFilter should "reset" itself from being done, allowing multiple invokations.
        See Also:
        Constant Field Values
      • HEAD_ELEMENT_CONTRIBUTION_HINT_ATTRIBUTE_PREFIX

        static final String HEAD_ELEMENT_CONTRIBUTION_HINT_ATTRIBUTE_PREFIX
        The head element attribute name prefix used as a hint for container to aggregate.
        See Also:
        Constant Field Values
      • HEAD_ELEMENT_CONTRIBUTION_CATEGORY_HINT_ATTRIBUTE

        static final String HEAD_ELEMENT_CONTRIBUTION_CATEGORY_HINT_ATTRIBUTE
        The category key hint for head elements. This category can be used to filter head elements during writing head elements.
        See Also:
        Constant Field Values
      • CUSTOM_ERROR_HANDLER_PARAM_NAME

        static final String CUSTOM_ERROR_HANDLER_PARAM_NAME
        The parameter name for custom error handler class name in the root component configuration
        See Also:
        Constant Field Values
      • RESOLVED_MOUNT_REQUEST_ATTR

        static final String RESOLVED_MOUNT_REQUEST_ATTR
      • SUBJECT_REPO_CREDS_ATTR_NAME

        static final String SUBJECT_REPO_CREDS_ATTR_NAME
        Subject's repository credentials session attribute name (This one can be optionally and temporarily set in a container that doesn't support JACC.)
        See Also:
        Constant Field Values
      • PREFERRED_LOCALE_ATTR_NAME

        static final String PREFERRED_LOCALE_ATTR_NAME
        Preferred local request or session attribute name
        See Also:
        Constant Field Values
      • DISPATCH_URI_PROTOCOL

        static final String DISPATCH_URI_PROTOCOL
        The dispatch URI scheme attribute name
        See Also:
        Constant Field Values
      • HST_REQUEST_USE_FULLY_QUALIFIED_URLS

        static final String HST_REQUEST_USE_FULLY_QUALIFIED_URLS
        The parameter name used in the request to store whether or not all URLs that are created must be fully qualified
        See Also:
        Constant Field Values
      • RENDERING_HOST

        static final String RENDERING_HOST
        The parameter name used in the request to store whether or not a different host than the one in the request needs to be used
        See Also:
        Constant Field Values
      • CMS_REQUEST_RENDERING_MOUNT_ID

        static final String CMS_REQUEST_RENDERING_MOUNT_ID
        The mount id of the site that is being viewed in the channel manager
        See Also:
        Constant Field Values
      • CMS_REQUEST_USER_ID_ATTR

        static final String CMS_REQUEST_USER_ID_ATTR
        Name of the http servlet request attribute with the CMS user id during a CMS initiated request
        See Also:
        Constant Field Values
      • RENDER_VARIANT

        static final String RENDER_VARIANT
        The attribute used on the request or http session to indicate that the page should be rendered as some specific variant
        See Also:
        Constant Field Values
      • DEFAULT_PARAMETER_PREFIX

        static final String DEFAULT_PARAMETER_PREFIX
        The 'default' prefix of HST component parameters. This prefix is used when no other prefix is set or the configured prefix is empty.
        See Also:
        Constant Field Values
      • HST_FILTER_CHAIN

        static final String HST_FILTER_CHAIN
        The current servlet filter chain request attribute name.
        See Also:
        Constant Field Values
      • HST_JAAS_LOGIN_ATTEMPT_RESOURCE_URL_ATTR

        static final String HST_JAAS_LOGIN_ATTEMPT_RESOURCE_URL_ATTR
        See Also:
        Constant Field Values
      • RENDER_BRANCH_ID

        static final String RENDER_BRANCH_ID
        The attribute used on the HstRequestContext attributes to find out which branch of an HstSite or document to use during rendering. The stored value in the attribute should be of type Map<HstSite, HstSite>
        See Also:
        Constant Field Values
      • PREFER_RENDER_BRANCH_ID

        static final String PREFER_RENDER_BRANCH_ID
        The attribute used on the HstRequestContext attributes to store which branch is preferred (aka if present) to be used for rendering. The stored value in the attribute should be of type String
        See Also:
        Constant Field Values
      • FORCE_USE_PREFER_RENDER_ATTR_NAME

        static final String FORCE_USE_PREFER_RENDER_ATTR_NAME
        attribute to indicate that from HstRequestUtils the prefer branch Id should be used regardless whether the branch exists
        See Also:
        Constant Field Values
      • FORWARD_RECURSION_ERROR

        static final String FORWARD_RECURSION_ERROR
      • DEFAULT_SEARCH_ENGINE_OR_BOT_USER_AGENT_PATTERNS

        static final String DEFAULT_SEARCH_ENGINE_OR_BOT_USER_AGENT_PATTERNS
        See Also:
        Constant Field Values
      • EXTRA_SEARCH_ENGINE_OR_BOT_USER_AGENT_PATTERNS

        static final String EXTRA_SEARCH_ENGINE_OR_BOT_USER_AGENT_PATTERNS
        See Also:
        Constant Field Values
      • EXTERNAL_PREVIEW_ACCESS_REQUEST_ATTRIBUTE

        static final String EXTERNAL_PREVIEW_ACCESS_REQUEST_ATTRIBUTE
        See Also:
        Constant Field Values