Package org.hippoecm.hst.core.container
Interface ContainerConstants
-
public interface ContainerConstants
HstComponent container constants- Version:
- $Id$
-
-
Field Summary
Fields Modifier and Type Field Description static String
BR_VERSION_UUID_REQUEST_PARAMETER
static String
CMS_REQUEST_RENDERING_MOUNT_ID
The mount id of the site that is being viewed in the channel managerstatic String
CMS_REQUEST_USER_ID_ATTR
Name of the http servlet request attribute with the CMS user id during a CMS initiated requeststatic String
CMS_USER_SESSION_ATTR_NAME
Name of theHstRequestContext
attribute with the CMS user Session if setstatic String
CMSSESSIONCONTEXT_BINDING_PATH
static String
COMPOSER_MODE_ATTR_NAME
'composer_info' attr type namestatic String
CONTAINER_REFERENCE_NAMESPACE
The reference namespace for container managed resource url.static String
CUSTOM_ERROR_HANDLER_PARAM_NAME
The parameter name for custom error handler class name in the root component configurationstatic String
DEFAULT_ADDON_MODULE_DESCRIPTOR_PATHS
Default Addon module descriptor paths, which can be comma separated multiple path values.static String
DEFAULT_PARAMETER_PREFIX
The 'default' prefix of HST component parameters.static String
DEFAULT_SEARCH_ENGINE_OR_BOT_USER_AGENT_PATTERNS
static String
DEFAULT_SITE_PIPELINE_NAME
static String
DISPATCH_URI_PROTOCOL
The dispatch URI scheme attribute namestatic String
EXTERNAL_PREVIEW_ACCESS_REQUEST_ATTRIBUTE
static String
EXTRA_SEARCH_ENGINE_OR_BOT_USER_AGENT_PATTERNS
static String
FORCE_USE_PREFER_RENDER_ATTR_NAME
attribute to indicate that from HstRequestUtils the prefer branch Id should be used regardless whether the branch existsstatic String
FORWARD_RECURSION_ERROR
static String
FREEMARKER_CLASSPATH_TEMPLATE_PROTOCOL
static String
FREEMARKER_JCR_TEMPLATE_PROTOCOL
static String
FREEMARKER_WEB_FILE_TEMPLATE_PROTOCOL
static String
HEAD_ELEMENT_CONTRIBUTION_CATEGORY_HINT_ATTRIBUTE
The category key hint for head elements.static String
HEAD_ELEMENT_CONTRIBUTION_HINT_ATTRIBUTE_PREFIX
The head element attribute name prefix used as a hint for container to aggregate.static String
HST_COMPONENT_WINDOW
The key used to bind theHstComponentWindow
to the underlyingHttpServletRequest
.static String
HST_FILTER_CHAIN
The current servlet filter chain request attribute name.static String
HST_FORWARD_PATH_INFO
The key used to set forward path.static String
HST_JAAS_LOGIN_ATTEMPT_RESOURCE_TOKEN
static String
HST_JAAS_LOGIN_ATTEMPT_RESOURCE_URL_ATTR
static String
HST_REQUEST
The key used to bind theHstRequest
to the underlyingHttpServletRequest
.static String
HST_REQUEST_CONTEXT
The attribute name used to set the request context object into the servlet request.static 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 qualifiedstatic String
HST_RESET_FILTER
The key to indicate HstFilter should "reset" itself from being done, allowing multiple invokations.static String
HST_RESPONSE
The key used to bind theHstResponse
to the underlyingHttpServletRequest
.static String
LINK_NAME_SELF
Generic Link Name for the self.static String
LINK_NAME_SITE
Generic Link Name for the site.static String
MOUNT_ALIAS_ASSETS
static String
MOUNT_ALIAS_GALLERY
static String
MOUNT_ALIAS_REST
static String
MOUNT_ALIAS_SITE
static String
PAGE_MODEL_ACCEPT_VERSION
static String
PAGE_MODEL_API_VERSION
static String
PAGE_MODEL_PIPELINE_NAME
static String
PREFER_RENDER_BRANCH_ID
The attribute used on theHstRequestContext
attributes to store which branch is preferred (aka if present) to be used for rendering.static String
PREFERRED_LOCALE_ATTR_NAME
Preferred local request or session attribute namestatic String
PREVIEW_ACCESS_TOKEN_REQUEST_ATTRIBUTE
static String
PREVIEW_URL_PROPERTY_NAME
static String
RENDER_BRANCH_ID
The attribute used on theHstRequestContext
attributes to find out which branch of anHstSite
or document to use during rendering.static String
RENDER_VARIANT
The attribute used on the request or http session to indicate that the page should be rendered as some specific variantstatic 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 usedstatic String
RESOLVED_MOUNT_REQUEST_ATTR
static String
SUBJECT_ATTR_NAME
Subject session attribute namestatic 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.)static String
VIRTUALHOSTS_REQUEST_ATTR
-
-
-
Field Detail
-
HST_REQUEST
static final String HST_REQUEST
The key used to bind theHstRequest
to the underlyingHttpServletRequest
.- See Also:
- Constant Field Values
-
HST_RESPONSE
static final String HST_RESPONSE
The key used to bind theHstResponse
to the underlyingHttpServletRequest
.- See Also:
- Constant Field Values
-
HST_COMPONENT_WINDOW
static final String HST_COMPONENT_WINDOW
The key used to bind theHstComponentWindow
to the underlyingHttpServletRequest
.- 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_FORWARD_PATH_INFO
static final String HST_FORWARD_PATH_INFO
The key used to set forward path.- 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
-
SUBJECT_ATTR_NAME
static final String SUBJECT_ATTR_NAME
Subject session attribute name- See Also:
- Constant Field Values
-
VIRTUALHOSTS_REQUEST_ATTR
static final String VIRTUALHOSTS_REQUEST_ATTR
- 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
-
MOUNT_ALIAS_REST
static final String MOUNT_ALIAS_REST
- See Also:
- Constant Field Values
-
MOUNT_ALIAS_SITE
static final String MOUNT_ALIAS_SITE
- See Also:
- Constant Field Values
-
MOUNT_ALIAS_GALLERY
static final String MOUNT_ALIAS_GALLERY
- See Also:
- Constant Field Values
-
MOUNT_ALIAS_ASSETS
static final String MOUNT_ALIAS_ASSETS
- See Also:
- Constant Field Values
-
COMPOSER_MODE_ATTR_NAME
static final String COMPOSER_MODE_ATTR_NAME
'composer_info' attr type 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
-
CMS_USER_SESSION_ATTR_NAME
static final String CMS_USER_SESSION_ATTR_NAME
Name of theHstRequestContext
attribute with the CMS user Session if set- 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
-
HST_JAAS_LOGIN_ATTEMPT_RESOURCE_TOKEN
static final String HST_JAAS_LOGIN_ATTEMPT_RESOURCE_TOKEN
- See Also:
- Constant Field Values
-
FREEMARKER_JCR_TEMPLATE_PROTOCOL
static final String FREEMARKER_JCR_TEMPLATE_PROTOCOL
- See Also:
- Constant Field Values
-
FREEMARKER_WEB_FILE_TEMPLATE_PROTOCOL
static final String FREEMARKER_WEB_FILE_TEMPLATE_PROTOCOL
- See Also:
- Constant Field Values
-
FREEMARKER_CLASSPATH_TEMPLATE_PROTOCOL
static final String FREEMARKER_CLASSPATH_TEMPLATE_PROTOCOL
- See Also:
- Constant Field Values
-
DEFAULT_SITE_PIPELINE_NAME
static final String DEFAULT_SITE_PIPELINE_NAME
- See Also:
- Constant Field Values
-
PAGE_MODEL_PIPELINE_NAME
static final String PAGE_MODEL_PIPELINE_NAME
- See Also:
- Constant Field Values
-
LINK_NAME_SELF
static final String LINK_NAME_SELF
Generic Link Name for the self.- See Also:
- Constant Field Values
-
LINK_NAME_SITE
static final String LINK_NAME_SITE
Generic Link Name for the site.- See Also:
- Constant Field Values
-
PAGE_MODEL_API_VERSION
static final String PAGE_MODEL_API_VERSION
- See Also:
- Constant Field Values
-
PAGE_MODEL_ACCEPT_VERSION
static final String PAGE_MODEL_ACCEPT_VERSION
- See Also:
- Constant Field Values
-
RENDER_BRANCH_ID
static final String RENDER_BRANCH_ID
The attribute used on theHstRequestContext
attributes to find out which branch of anHstSite
or document to use during rendering. The stored value in the attribute should be of typeMap<HstSite, HstSite>
- See Also:
- Constant Field Values
-
PREFER_RENDER_BRANCH_ID
static final String PREFER_RENDER_BRANCH_ID
The attribute used on theHstRequestContext
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
-
CMSSESSIONCONTEXT_BINDING_PATH
static final String CMSSESSIONCONTEXT_BINDING_PATH
- See Also:
- Constant Field Values
-
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
-
PREVIEW_ACCESS_TOKEN_REQUEST_ATTRIBUTE
static final String PREVIEW_ACCESS_TOKEN_REQUEST_ATTRIBUTE
- See Also:
- Constant Field Values
-
EXTERNAL_PREVIEW_ACCESS_REQUEST_ATTRIBUTE
static final String EXTERNAL_PREVIEW_ACCESS_REQUEST_ATTRIBUTE
- See Also:
- Constant Field Values
-
PREVIEW_URL_PROPERTY_NAME
static final String PREVIEW_URL_PROPERTY_NAME
- See Also:
- Constant Field Values
-
BR_VERSION_UUID_REQUEST_PARAMETER
static final String BR_VERSION_UUID_REQUEST_PARAMETER
- See Also:
- Constant Field Values
-
-