Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.RuntimeCollective.webapps
Class RuntimeParameters  view RuntimeParameters download RuntimeParameters.java

java.lang.Object
  extended bycom.RuntimeCollective.webapps.RuntimeParameters

public class RuntimeParameters
extends java.lang.Object

Provides system properties, parameters and tools for the Josephine runtime environment.

Version:
$Id: RuntimeParameters.java,v 1.23 2003/09/30 15:13:04 joe Exp $

Field Summary
private static java.lang.String BLANK
           
private static EntityBeanStore c_store
           
protected static boolean clustered
           
protected static boolean clusteredInited
           
private static java.lang.String COL
           
private static java.lang.String COMMENT
           
private static java.lang.String DEBUG
           
private static java.lang.String DEBUG_BRACKET
           
private static java.lang.String END_BRACKET
           
private static java.lang.String ERROR
           
private static java.lang.String ERROR_BRACKET
           
private static java.lang.String FATAL
           
private static java.lang.String FATAL_BRACKET
           
private static java.lang.String FREE_MEMORY
           
private static java.lang.String INFO
           
private static java.lang.String INFO_BRACKET
           
private static javax.naming.InitialContext initialContext
           
static java.lang.String IS_CLUSTERED_PARAM
           
static java.lang.String LOG_LEVEL_DEBUG
           
static java.lang.String LOG_LEVEL_ERROR
           
static java.lang.String LOG_LEVEL_FATAL
           
static java.lang.String LOG_LEVEL_INFO
           
private static int LOG_LEVEL_INT_DEBUG
           
private static int LOG_LEVEL_INT_ERROR
           
private static int LOG_LEVEL_INT_FATAL
           
private static int LOG_LEVEL_INT_INFO
           
private static int LOG_LEVEL_INT_WARN
           
private static boolean[] LOG_LEVEL_SETTINGS
           
static java.lang.String LOG_LEVEL_WARN
           
private static boolean Log4jLogging
          Whether we are using a log4j logger (true) or good 'ol System.out (false)
private static javax.mail.Session mailSession
           
private static java.lang.String MEMORY
           
private static java.util.Hashtable params
           
private static java.lang.Object searchIndex
           
private static java.lang.String TOTAL_MEMORY
           
private static UserGroups userGroups
           
private static java.lang.String WARNING
           
private static java.lang.String WARNING_BRACKET
           
 
Constructor Summary
RuntimeParameters()
           
 
Method Summary
static java.lang.String get(java.lang.String paramName)
          Deprecated. use getParam instead
static boolean getLog4jLogging()
          Get whether we are using a log4j logger (true) or good 'ol System.out (false)
static org.apache.log4j.Category getLoggerForClass(java.lang.Object object)
           
static org.apache.log4j.Category getLoggerForClass(java.lang.String className)
           
static javax.mail.Session getMailSession()
          Get the JavaMail Session to be used.
static java.lang.String getParam(java.lang.String paramName)
          Get the value of a parameter.
static java.lang.Object getSearchIndex()
          Get the SearchIndex for this application.
static EntityBeanStore getStore()
          Get the EntityBeanStore for this application.
static UserGroups getUserGroups()
          Get the UserGroups object for this application.
static boolean isClustered()
          Whether the environment is clustered (default to true).
static java.lang.Object JNDILookup(java.lang.String parameterName)
          Perform a JNDI lookup, using the value of the supplied parameter.
static void log(java.lang.Object object, java.lang.String message)
          Log an information message from the given object.
static void log(java.lang.Object object, java.lang.String message, java.lang.Throwable ex)
          Log an information message from the given object.
static void log(java.lang.String className, java.lang.String message)
          Log an information message from the given class name.
static void log(java.lang.String className, java.lang.String message, java.lang.Throwable ex)
          Log an information message from the given class name.
static void logDebug(java.lang.Object object, java.lang.String message)
          Log a debug message from the given object.
static void logDebug(java.lang.Object object, java.lang.String message, java.lang.Throwable ex)
          Log a debug message from the given object.
static void logDebug(java.lang.String className, java.lang.String message)
          Log a debug message from the given class name.
static void logDebug(java.lang.String className, java.lang.String message, java.lang.Throwable ex)
          Log a debug message from the given class name.
static void logError(java.lang.Object object, java.lang.String message)
          Log an error message from the given object.
static void logError(java.lang.Object object, java.lang.String message, java.lang.Throwable ex)
          Log an error message from the given object.
static void logError(java.lang.String className, java.lang.String message)
          Log an error message from the given class name.
static void logError(java.lang.String className, java.lang.String message, java.lang.Throwable ex)
          Log an error message from the given class name.
static void logFatal(java.lang.Object object, java.lang.String message)
          Log a fatal error message from the given object.
static void logFatal(java.lang.Object object, java.lang.String message, java.lang.Throwable ex)
          Log a fatal error message from the given object.
static void logFatal(java.lang.String className, java.lang.String message)
          Log a fatal error message from the given class name.
static void logFatal(java.lang.String className, java.lang.String message, java.lang.Throwable ex)
          Log a fatal error message from the given class name.
static void logInfo(java.lang.Object object, java.lang.String message)
          Log an information message from the given object.
static void logInfo(java.lang.Object object, java.lang.String message, java.lang.Throwable ex)
          Log an information message from the given object.
static void logInfo(java.lang.String className, java.lang.String message)
          Log an information message from the given class name.
static void logInfo(java.lang.String className, java.lang.String message, java.lang.Throwable ex)
          Log an information message from the given class name.
static void logWarn(java.lang.Object object, java.lang.String message)
          Log a warning message from the given object.
static void logWarn(java.lang.Object object, java.lang.String message, java.lang.Throwable ex)
          Log a warning message from the given object.
static void logWarn(java.lang.String className, java.lang.String message)
          Log a warning message from the given class name.
static void logWarn(java.lang.String className, java.lang.String message, java.lang.Throwable ex)
          Log a warning message from the given class name.
static void memCheck(java.lang.Object o)
          Logs memory information to Debug.
static void memCheck(java.lang.Object o, java.lang.String comment)
          Logs memory information to Debug.
static void set(java.lang.String paramName, java.lang.String paramValue)
          Add a parameter.
static void setLog4jLogging(boolean log4jLogging)
          Set whether we are using a log4j logger (true) or good 'ol System.out (false)
static void setLogLevel(java.lang.String logLevel)
          Set the level of logging, only used for non-log4j logging.
static void setMailSession(javax.mail.Session ms)
          Set the JavaMail Session to be used.
static void setSearchIndex(java.lang.Object si)
          Define the SearchIndex to be used for this application, if any.
static void setStore(EntityBeanStore store)
          Define the EntityBeanStore to be used for this application.
static void setUserGroups(UserGroups ug)
          Define the UserGroups object to be used for this application.
static void systemLogMaybe(int level, java.lang.String message)
          Log a message to system out, if that level is meant to be logged.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

params

private static java.util.Hashtable params

c_store

private static EntityBeanStore c_store

userGroups

private static UserGroups userGroups

mailSession

private static javax.mail.Session mailSession

LOG_LEVEL_DEBUG

public static java.lang.String LOG_LEVEL_DEBUG

LOG_LEVEL_INFO

public static java.lang.String LOG_LEVEL_INFO

LOG_LEVEL_WARN

public static java.lang.String LOG_LEVEL_WARN

LOG_LEVEL_ERROR

public static java.lang.String LOG_LEVEL_ERROR

LOG_LEVEL_FATAL

public static java.lang.String LOG_LEVEL_FATAL

LOG_LEVEL_INT_DEBUG

private static int LOG_LEVEL_INT_DEBUG

LOG_LEVEL_INT_INFO

private static int LOG_LEVEL_INT_INFO

LOG_LEVEL_INT_WARN

private static int LOG_LEVEL_INT_WARN

LOG_LEVEL_INT_ERROR

private static int LOG_LEVEL_INT_ERROR

LOG_LEVEL_INT_FATAL

private static int LOG_LEVEL_INT_FATAL

LOG_LEVEL_SETTINGS

private static boolean[] LOG_LEVEL_SETTINGS

DEBUG

private static final java.lang.String DEBUG
See Also:
Constant Field Values

INFO

private static final java.lang.String INFO
See Also:
Constant Field Values

WARNING

private static final java.lang.String WARNING
See Also:
Constant Field Values

ERROR

private static final java.lang.String ERROR
See Also:
Constant Field Values

FATAL

private static final java.lang.String FATAL
See Also:
Constant Field Values

DEBUG_BRACKET

private static final java.lang.String DEBUG_BRACKET
See Also:
Constant Field Values

INFO_BRACKET

private static final java.lang.String INFO_BRACKET
See Also:
Constant Field Values

WARNING_BRACKET

private static final java.lang.String WARNING_BRACKET
See Also:
Constant Field Values

ERROR_BRACKET

private static final java.lang.String ERROR_BRACKET
See Also:
Constant Field Values

FATAL_BRACKET

private static final java.lang.String FATAL_BRACKET
See Also:
Constant Field Values

COL

private static final java.lang.String COL
See Also:
Constant Field Values

END_BRACKET

private static final java.lang.String END_BRACKET
See Also:
Constant Field Values

MEMORY

private static final java.lang.String MEMORY
See Also:
Constant Field Values

BLANK

private static final java.lang.String BLANK
See Also:
Constant Field Values

COMMENT

private static final java.lang.String COMMENT
See Also:
Constant Field Values

FREE_MEMORY

private static final java.lang.String FREE_MEMORY
See Also:
Constant Field Values

TOTAL_MEMORY

private static final java.lang.String TOTAL_MEMORY
See Also:
Constant Field Values

searchIndex

private static java.lang.Object searchIndex

initialContext

private static javax.naming.InitialContext initialContext

Log4jLogging

private static boolean Log4jLogging
Whether we are using a log4j logger (true) or good 'ol System.out (false)


clustered

protected static boolean clustered

clusteredInited

protected static boolean clusteredInited

IS_CLUSTERED_PARAM

public static final java.lang.String IS_CLUSTERED_PARAM
See Also:
Constant Field Values
Constructor Detail

RuntimeParameters

public RuntimeParameters()
Method Detail

set

public static void set(java.lang.String paramName,
                       java.lang.String paramValue)
Add a parameter. If there is already a value stored for this parameter name, then it will be overwritten.


get

public static java.lang.String get(java.lang.String paramName)
Deprecated. use getParam instead

Get the value of a parameter.


getParam

public static java.lang.String getParam(java.lang.String paramName)
Get the value of a parameter. returns null if the parameter has not been set.


setStore

public static void setStore(EntityBeanStore store)
Define the EntityBeanStore to be used for this application.


getStore

public static EntityBeanStore getStore()
Get the EntityBeanStore for this application.


setUserGroups

public static void setUserGroups(UserGroups ug)
Define the UserGroups object to be used for this application.


getUserGroups

public static UserGroups getUserGroups()
Get the UserGroups object for this application.


setSearchIndex

public static void setSearchIndex(java.lang.Object si)
Define the SearchIndex to be used for this application, if any.


getSearchIndex

public static java.lang.Object getSearchIndex()
Get the SearchIndex for this application.


setMailSession

public static void setMailSession(javax.mail.Session ms)
Set the JavaMail Session to be used.


getMailSession

public static javax.mail.Session getMailSession()
Get the JavaMail Session to be used.


JNDILookup

public static java.lang.Object JNDILookup(java.lang.String parameterName)
                                   throws javax.naming.NamingException
Perform a JNDI lookup, using the value of the supplied parameter.


getLog4jLogging

public static boolean getLog4jLogging()
Get whether we are using a log4j logger (true) or good 'ol System.out (false)


setLog4jLogging

public static void setLog4jLogging(boolean log4jLogging)
Set whether we are using a log4j logger (true) or good 'ol System.out (false)


setLogLevel

public static void setLogLevel(java.lang.String logLevel)
Set the level of logging, only used for non-log4j logging.


getLoggerForClass

public static org.apache.log4j.Category getLoggerForClass(java.lang.String className)

getLoggerForClass

public static org.apache.log4j.Category getLoggerForClass(java.lang.Object object)

log

public static void log(java.lang.Object object,
                       java.lang.String message)
Log an information message from the given object. This level of logging should be used for coarse-grained messages issued during normal operation of the application.


log

public static void log(java.lang.Object object,
                       java.lang.String message,
                       java.lang.Throwable ex)
Log an information message from the given object. This level of logging should be used for coarse-grained messages issued during normal operation of the application.


logInfo

public static void logInfo(java.lang.Object object,
                           java.lang.String message)
Log an information message from the given object. This level of logging should be used for coarse-grained messages issued during normal operation of the application.


logInfo

public static void logInfo(java.lang.Object object,
                           java.lang.String message,
                           java.lang.Throwable ex)
Log an information message from the given object. This level of logging should be used for coarse-grained messages issued during normal operation of the application.


logDebug

public static void logDebug(java.lang.Object object,
                            java.lang.String message)
Log a debug message from the given object. This level of logging should be used for fine-grained messages issued during normal operation of the application, but which may be useful for debugging purposes.


logDebug

public static void logDebug(java.lang.Object object,
                            java.lang.String message,
                            java.lang.Throwable ex)
Log a debug message from the given object. This level of logging should be used for fine-grained messages issued during normal operation of the application, but which may be useful for debugging purposes.


logWarn

public static void logWarn(java.lang.Object object,
                           java.lang.String message)
Log a warning message from the given object. This level of logging should be used for reporting events which are potentially harmful, but were successfully trapped and handled.


logWarn

public static void logWarn(java.lang.Object object,
                           java.lang.String message,
                           java.lang.Throwable ex)
Log a warning message from the given object. This level of logging should be used for reporting events which are potentially harmful, but were successfully trapped and handled.


logError

public static void logError(java.lang.Object object,
                            java.lang.String message)
Log an error message from the given object. This level of logging should be used for reporting events which are harmful, and which would interrupt normal operation.


logError

public static void logError(java.lang.Object object,
                            java.lang.String message,
                            java.lang.Throwable ex)
Log an error message from the given object. This level of logging should be used for reporting events which are harmful, and which would interrupt normal operation.


logFatal

public static void logFatal(java.lang.Object object,
                            java.lang.String message)
Log a fatal error message from the given object. This level of logging should be used for events which would cause the application to die.


logFatal

public static void logFatal(java.lang.Object object,
                            java.lang.String message,
                            java.lang.Throwable ex)
Log a fatal error message from the given object. This level of logging should be used for events which would cause the application to die.


log

public static void log(java.lang.String className,
                       java.lang.String message)
Log an information message from the given class name. This level of logging should be used for coarse-grained messages issued during normal operation of the application.


log

public static void log(java.lang.String className,
                       java.lang.String message,
                       java.lang.Throwable ex)
Log an information message from the given class name. This level of logging should be used for coarse-grained messages issued during normal operation of the application.


logInfo

public static void logInfo(java.lang.String className,
                           java.lang.String message)
Log an information message from the given class name. This level of logging should be used for coarse-grained messages issued during normal operation of the application.


logInfo

public static void logInfo(java.lang.String className,
                           java.lang.String message,
                           java.lang.Throwable ex)
Log an information message from the given class name. This level of logging should be used for coarse-grained messages issued during normal operation of the application.


logDebug

public static void logDebug(java.lang.String className,
                            java.lang.String message)
Log a debug message from the given class name. This level of logging should be used for fine-grained messages issued during normal operation of the application, but which may be useful for debugging purposes.


logDebug

public static void logDebug(java.lang.String className,
                            java.lang.String message,
                            java.lang.Throwable ex)
Log a debug message from the given class name. This level of logging should be used for fine-grained messages issued during normal operation of the application, but which may be useful for debugging purposes.


logWarn

public static void logWarn(java.lang.String className,
                           java.lang.String message)
Log a warning message from the given class name. This level of logging should be used for reporting events which are potentially harmful, but were successfully trapped and handled.


logWarn

public static void logWarn(java.lang.String className,
                           java.lang.String message,
                           java.lang.Throwable ex)
Log a warning message from the given class name. This level of logging should be used for reporting events which are potentially harmful, but were successfully trapped and handled.


logError

public static void logError(java.lang.String className,
                            java.lang.String message)
Log an error message from the given class name. This level of logging should be used for reporting events which are harmful, and which would interrupt normal operation.


logError

public static void logError(java.lang.String className,
                            java.lang.String message,
                            java.lang.Throwable ex)
Log an error message from the given class name. This level of logging should be used for reporting events which are harmful, and which would interrupt normal operation.


logFatal

public static void logFatal(java.lang.String className,
                            java.lang.String message)
Log a fatal error message from the given class name. This level of logging should be used for events which would cause the application to die.


logFatal

public static void logFatal(java.lang.String className,
                            java.lang.String message,
                            java.lang.Throwable ex)
Log a fatal error message from the given class name. This level of logging should be used for events which would cause the application to die.


systemLogMaybe

public static void systemLogMaybe(int level,
                                  java.lang.String message)
Log a message to system out, if that level is meant to be logged.


memCheck

public static void memCheck(java.lang.Object o)
Logs memory information to Debug.


memCheck

public static void memCheck(java.lang.Object o,
                            java.lang.String comment)
Logs memory information to Debug.


isClustered

public static boolean isClustered()
Whether the environment is clustered (default to true).