zkoss/zk

/* Attributes.java

{{IS_NOTE
    Purpose:
        
    Description:
        
    History:
        Wed Nov 17 15:05:17     2004, Created by tomyeh
}}IS_NOTE

Copyright (C) 2004 Potix Corporation. All Rights Reserved.

{{IS_RIGHT
    This program is distributed under LGPL Version 2.1 in the hope that
    it will be useful, but WITHOUT ANY WARRANTY.
}}IS_RIGHT
*/
package org.zkoss.web;

/**
 * Definition of constants used as attributes and parameters across
 * requests.
 *
 * @author tomyeh
 */
public class Attributes {
    /** Don't construct it. All members are static. */
    protected Attributes() {
    }

    /** The title (String) of a servlet or a portal.
     * Stored as an attribute of the request.
     */
    public static final String TITLE = "px_title";

    /** The session attribute used to store the preferred locale (Locale) in a session.
     */
    public static final String PREFERRED_LOCALE = "org.zkoss.web.preferred.locale";
    /** The session attribute used to store the preferred time zone (TimeZone) in a session.
     */
    public static final String PREFERRED_TIME_ZONE = "org.zkoss.web.preferred.timeZone";
    /** The session attribute used to store the preferred first-day-of-week.
     * The value must be one of {@link java.util.Calendar#SUNDAY},
     * {@link java.util.Calendar#MONDAY}, {@link java.util.Calendar#SATURDAY}
     * and so on.
     * <p>Default: -1 (it means {@link java.util.Calendar#getFirstDayOfWeek} is assumed)
     * <p>Notice that you could specify it as a library property such that
     * it will be the default value for the whole application
     * (with the higher priority than {@link java.util.Calendar}.
     * @since 5.0.3
     */
    public static final String PREFERRED_FIRST_DAY_OF_WEEK = "org.zkoss.web.preferred.firstDayOfWeek";

    /** The library property used to store the preferred 2DigitYearStart.
     * <p>Default: 1929
     * @since 8.6.2
     */
    public static final String PREFERRED_2DIGITYEARSTART = "org.zkoss.web.preferred.2DigitYearStart";

    /** The session attribute used to specify the class used to return
     * the formats of date, time or both for datebox and timebox.
     * The class must implement {@link org.zkoss.text.DateFormatInfo}.
     * @since 5.0.7
     */
    public static final String PREFERRED_DATE_FORMAT_INFO = "org.zkoss.web.preferred.dateFormatInfo";

    /** The attribute name that contains the alert passed from
     * another request {@link org.zkoss.web.servlet.http.Https#sendRedirect}.
     * It is automatically reset after the next request is responded.
     * In JSP, web authors use
     * &lt;c:object name="i.alert" scope="request"&gt; to access it.
     */
    public static final String ALERT = "px_alert";
    /** Denote the type of {@link #ALERT}.
     * It could be "error", "warning" and undefined.
     * It is used by JSP page to do more accurate page layout.
     */
    public static final String ALERT_TYPE = "px_alert_type";

    /** The attribute used to pass parameters from the caller that invokes
     * Servlets.include() or Servlets.forward()
     * with {@link org.zkoss.web.servlet.Servlets#PASS_THRU_ATTR}.
     */
    public static final String ARG = "arg";

    //-- Standard constants --//
    /** The included context path; set by the servlet container.
     * @see org.zkoss.web.servlet.http.Https#getThisContextPath
     * @see org.zkoss.web.servlet.http.Https#getOriginContextPath
     */
    public static final String INCLUDE_CONTEXT_PATH = "javax.servlet.include.context_path";
    /** The included servlet path; set by the servlet container.
     * @see org.zkoss.web.servlet.http.Https#getThisServletPath
     * @see org.zkoss.web.servlet.http.Https#getOriginServletPath
     */
    public static final String INCLUDE_SERVLET_PATH = "javax.servlet.include.servlet_path";
    /** The included request URI; set by the servlet container.
     * @see org.zkoss.web.servlet.http.Https#getThisRequestURI
     */
    public static final String INCLUDE_REQUEST_URI = "javax.servlet.include.request_uri";
    /** The included servlet path; set by the servlet container.
     * @see org.zkoss.web.servlet.http.Https#getThisPathInfo
     * @see org.zkoss.web.servlet.http.Https#getOriginPathInfo
     */
    public static final String INCLUDE_PATH_INFO = "javax.servlet.include.path_info";
    /** The included servlet path; set by the servlet container.
     * @see org.zkoss.web.servlet.http.Https#getThisQueryString
     * @see org.zkoss.web.servlet.http.Https#getOriginQueryString
     */
    public static final String INCLUDE_QUERY_STRING = "javax.servlet.include.query_string";

    /** The original context path that forwards this page; set by the servlet container.
     * @see org.zkoss.web.servlet.http.Https#getThisServletPath
     * @see org.zkoss.web.servlet.http.Https#getOriginServletPath
     */
    public static final String FORWARD_CONTEXT_PATH = "javax.servlet.forward.context_path";
    /** The original servlet path that forwards this page; set by the servlet container.
     * @see org.zkoss.web.servlet.http.Https#getThisServletPath
     * @see org.zkoss.web.servlet.http.Https#getOriginServletPath
     */
    public static final String FORWARD_SERVLET_PATH = "javax.servlet.forward.servlet_path";
    /** The original request URI that forwards this page; set by the servlet container.
     * @see org.zkoss.web.servlet.http.Https#getThisRequestURI
     */
    public static final String FORWARD_REQUEST_URI = "javax.servlet.forward.request_uri";
    /** The original servlet path that forwards this page; set by the servlet container.
     * @see org.zkoss.web.servlet.http.Https#getThisPathInfo
     * @see org.zkoss.web.servlet.http.Https#getOriginPathInfo
     */
    public static final String FORWARD_PATH_INFO = "javax.servlet.forward.path_info";
    /** The original servlet path that forwards this page; set by the servlet container.
     * @see org.zkoss.web.servlet.http.Https#getThisQueryString
     * @see org.zkoss.web.servlet.http.Https#getOriginQueryString
     */
    public static final String FORWARD_QUERY_STRING = "javax.servlet.forward.query_string";
    /** The async context path; set by the servlet container.
     * @see org.zkoss.web.servlet.http.Https#getThisContextPath
     */
    public static final String ASYNC_CONTEXT_PATH = "javax.servlet.async.context_path";
    /** The attribute to hold the exception, if any.
     */
    public static final String ERROR_EXCEPTION = "javax.servlet.error.exception";
}