Class Config


  • public class Config
    extends java.lang.Object
    Class supporting access to configuration settings.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String FMT_FALLBACK_LOCALE
      Name of configuration setting for fallback locale
      static java.lang.String FMT_LOCALE
      Name of configuration setting for application- (as opposed to browser-) based preferred locale
      static java.lang.String FMT_LOCALIZATION_CONTEXT
      Name of configuration setting for i18n localization context
      static java.lang.String FMT_TIME_ZONE
      Name of localization setting for time zone
      static java.lang.String SQL_DATA_SOURCE
      Name of configuration setting for SQL data source
      static java.lang.String SQL_MAX_ROWS
      Name of configuration setting for maximum number of rows to be included in SQL query result
    • Constructor Summary

      Constructors 
      Constructor Description
      Config()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.Object find​(PageContext pc, java.lang.String name)
      Finds the value associated with a specific configuration setting identified by its context initialization parameter name.
      static java.lang.Object get​(HttpSession session, java.lang.String name)
      Looks up a configuration variable in the "session" scope.
      static java.lang.Object get​(PageContext pc, java.lang.String name, int scope)
      Looks up a configuration variable in the given scope.
      static java.lang.Object get​(ServletContext context, java.lang.String name)
      Looks up a configuration variable in the "application" scope.
      static java.lang.Object get​(ServletRequest request, java.lang.String name)
      Looks up a configuration variable in the "request" scope.
      static void remove​(HttpSession session, java.lang.String name)
      Removes a configuration variable from the "session" scope.
      static void remove​(PageContext pc, java.lang.String name, int scope)
      Removes a configuration variable from the given scope.
      static void remove​(ServletContext context, java.lang.String name)
      Removes a configuration variable from the "application" scope.
      static void remove​(ServletRequest request, java.lang.String name)
      Removes a configuration variable from the "request" scope.
      static void set​(HttpSession session, java.lang.String name, java.lang.Object value)
      Sets the value of a configuration variable in the "session" scope.
      static void set​(PageContext pc, java.lang.String name, java.lang.Object value, int scope)
      Sets the value of a configuration variable in the given scope.
      static void set​(ServletContext context, java.lang.String name, java.lang.Object value)
      Sets the value of a configuration variable in the "application" scope.
      static void set​(ServletRequest request, java.lang.String name, java.lang.Object value)
      Sets the value of a configuration variable in the "request" scope.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • FMT_LOCALE

        public static final java.lang.String FMT_LOCALE
        Name of configuration setting for application- (as opposed to browser-) based preferred locale
        See Also:
        Constant Field Values
      • FMT_FALLBACK_LOCALE

        public static final java.lang.String FMT_FALLBACK_LOCALE
        Name of configuration setting for fallback locale
        See Also:
        Constant Field Values
      • FMT_LOCALIZATION_CONTEXT

        public static final java.lang.String FMT_LOCALIZATION_CONTEXT
        Name of configuration setting for i18n localization context
        See Also:
        Constant Field Values
      • FMT_TIME_ZONE

        public static final java.lang.String FMT_TIME_ZONE
        Name of localization setting for time zone
        See Also:
        Constant Field Values
      • SQL_DATA_SOURCE

        public static final java.lang.String SQL_DATA_SOURCE
        Name of configuration setting for SQL data source
        See Also:
        Constant Field Values
      • SQL_MAX_ROWS

        public static final java.lang.String SQL_MAX_ROWS
        Name of configuration setting for maximum number of rows to be included in SQL query result
        See Also:
        Constant Field Values
    • Constructor Detail

      • Config

        public Config()
    • Method Detail

      • get

        public static java.lang.Object get​(PageContext pc,
                                           java.lang.String name,
                                           int scope)
        Looks up a configuration variable in the given scope.

        The lookup of configuration variables is performed as if each scope had its own name space, that is, the same configuration variable name in one scope does not replace one stored in a different scope.

        Parameters:
        pc - Page context in which the configuration variable is to be looked up
        name - Configuration variable name
        scope - Scope in which the configuration variable is to be looked up
        Returns:
        The java.lang.Object associated with the configuration variable, or null if it is not defined.
      • get

        public static java.lang.Object get​(ServletRequest request,
                                           java.lang.String name)
        Looks up a configuration variable in the "request" scope.

        The lookup of configuration variables is performed as if each scope had its own name space, that is, the same configuration variable name in one scope does not replace one stored in a different scope.

        Parameters:
        request - Request object in which the configuration variable is to be looked up
        name - Configuration variable name
        Returns:
        The java.lang.Object associated with the configuration variable, or null if it is not defined.
      • get

        public static java.lang.Object get​(HttpSession session,
                                           java.lang.String name)
        Looks up a configuration variable in the "session" scope.

        The lookup of configuration variables is performed as if each scope had its own name space, that is, the same configuration variable name in one scope does not replace one stored in a different scope.

        Parameters:
        session - Session object in which the configuration variable is to be looked up
        name - Configuration variable name
        Returns:
        The java.lang.Object associated with the configuration variable, or null if it is not defined, if session is null, or if the session is invalidated.
      • get

        public static java.lang.Object get​(ServletContext context,
                                           java.lang.String name)
        Looks up a configuration variable in the "application" scope.

        The lookup of configuration variables is performed as if each scope had its own name space, that is, the same configuration variable name in one scope does not replace one stored in a different scope.

        Parameters:
        context - Servlet context in which the configuration variable is to be looked up
        name - Configuration variable name
        Returns:
        The java.lang.Object associated with the configuration variable, or null if it is not defined.
      • set

        public static void set​(PageContext pc,
                               java.lang.String name,
                               java.lang.Object value,
                               int scope)
        Sets the value of a configuration variable in the given scope.

        Setting the value of a configuration variable is performed as if each scope had its own namespace, that is, the same configuration variable name in one scope does not replace one stored in a different scope.

        Parameters:
        pc - Page context in which the configuration variable is to be set
        name - Configuration variable name
        value - Configuration variable value
        scope - Scope in which the configuration variable is to be set
      • set

        public static void set​(ServletRequest request,
                               java.lang.String name,
                               java.lang.Object value)
        Sets the value of a configuration variable in the "request" scope.

        Setting the value of a configuration variable is performed as if each scope had its own namespace, that is, the same configuration variable name in one scope does not replace one stored in a different scope.

        Parameters:
        request - Request object in which the configuration variable is to be set
        name - Configuration variable name
        value - Configuration variable value
      • set

        public static void set​(HttpSession session,
                               java.lang.String name,
                               java.lang.Object value)
        Sets the value of a configuration variable in the "session" scope.

        Setting the value of a configuration variable is performed as if each scope had its own namespace, that is, the same configuration variable name in one scope does not replace one stored in a different scope.

        Parameters:
        session - Session object in which the configuration variable is to be set
        name - Configuration variable name
        value - Configuration variable value
      • set

        public static void set​(ServletContext context,
                               java.lang.String name,
                               java.lang.Object value)
        Sets the value of a configuration variable in the "application" scope.

        Setting the value of a configuration variable is performed as if each scope had its own namespace, that is, the same configuration variable name in one scope does not replace one stored in a different scope.

        Parameters:
        context - Servlet context in which the configuration variable is to be set
        name - Configuration variable name
        value - Configuration variable value
      • remove

        public static void remove​(PageContext pc,
                                  java.lang.String name,
                                  int scope)
        Removes a configuration variable from the given scope.

        Removing a configuration variable is performed as if each scope had its own namespace, that is, the same configuration variable name in one scope does not impact one stored in a different scope.

        Parameters:
        pc - Page context from which the configuration variable is to be removed
        name - Configuration variable name
        scope - Scope from which the configuration variable is to be removed
      • remove

        public static void remove​(ServletRequest request,
                                  java.lang.String name)
        Removes a configuration variable from the "request" scope.

        Removing a configuration variable is performed as if each scope had its own namespace, that is, the same configuration variable name in one scope does not impact one stored in a different scope.

        Parameters:
        request - Request object from which the configuration variable is to be removed
        name - Configuration variable name
      • remove

        public static void remove​(HttpSession session,
                                  java.lang.String name)
        Removes a configuration variable from the "session" scope.

        Removing a configuration variable is performed as if each scope had its own namespace, that is, the same configuration variable name in one scope does not impact one stored in a different scope.

        Parameters:
        session - Session object from which the configuration variable is to be removed
        name - Configuration variable name
      • remove

        public static void remove​(ServletContext context,
                                  java.lang.String name)
        Removes a configuration variable from the "application" scope.

        Removing a configuration variable is performed as if each scope had its own namespace, that is, the same configuration variable name in one scope does not impact one stored in a different scope.

        Parameters:
        context - Servlet context from which the configuration variable is to be removed
        name - Configuration variable name
      • find

        public static java.lang.Object find​(PageContext pc,
                                            java.lang.String name)
        Finds the value associated with a specific configuration setting identified by its context initialization parameter name.

        For each of the JSP scopes (page, request, session, application), get the value of the configuration variable identified by name using method get(). Return as soon as a non-null value is found. If no value is found, get the value of the context initialization parameter identified by name.

        Parameters:
        pc - Page context in which the configuration setting is to be searched
        name - Context initialization parameter name of the configuration setting
        Returns:
        The java.lang.Object associated with the configuration setting identified by name, or null if it is not defined.