Settings ( @enterprise 10.0 API)

java.lang.Object
- com.groiss.util.Settings

All Implemented Interfaces:

Lifecycle, Service
```
public class Settings
extends Object
implements Service
```
This class defines some settings of the server. The settings are read from the configuration file. This implies that the configuration must be loaded when this class is initialized.

Field Summary

Fields
Modifier and Type Field and Description

static org.slf4j.Marker ALWAYS_OUT

Fields
Modifier and Type	Field and Description
`static org.slf4j.Marker`	`ALWAYS_OUT`

Constructor Summary

Constructors
Constructor and Description

Settings()

Constructors
Constructor and Description
`Settings()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static List<File>`	`getApplicationClasspath()`
`static Locale[]`	`getAvailableLocales()` Return the list of locales from the configuration.
`static File`	`getBaseDir()` Return the base directory (from the configuration).
`static List<File>`	`getBootClasspath()`
`static ClassLoader`	`getClassLoader()` Get the application class loader.
`static List<File>`	`getClasspath()`
`static com.ibm.icu.text.NumberFormat`	`getDecimalFormatter()`
`static com.ibm.icu.text.NumberFormat`	`getDecimalFormatter(String maxDigitSettings, com.ibm.icu.text.NumberFormat original)` returns a `NumberFormat` where the max. fraction and integer digits are set as defined in the passed parameter. all other settings are copied from the passed `NumberFormat`
`static String`	`getEPShadowFiles()` Check if @enterprise resources are shadowed.
`static File`	`getErrorLogFile()` returns the current-error-file
`static String`	`getFormPackage()` return the name of the form class package (either com.dec.avw.appl. or com.groiss.forms.)
`static File`	`getJarArchive(Class<?> clazz)` Get the jar archive the given class is loaded from.
`static int`	`getLevel()` Deprecated. use own `Logger` instead
`static com.ibm.icu.text.NumberFormat`	`getLocalNumberFormatter()`
`static Pair<URL,ClassLoader>`	`getLocation(String resourceName)`
`static File`	`getLogFile()` returns the current log-file
`static PrintWriter`	`getLogWriter()`
`static MessageDigest`	`getMessageDigest()` Returns a new instance of the MessageDigest used by the system (e.g. in DMS)
`static String`	`getMessageDigestAlgorithmName()` Returns the Name of the MessageDigest algorithm used by the system (e.g. in DMS)
`static Pair<String,String>`	`getProcessRelation(String key)`
`static Map<String,Pair<String,String>>`	`getProcessRelations()` Returns the list of process relations.
`static List<Pair<String,String>>`	`getProcessRelationsList()`
`static String`	`getProcessRelationText(String key, boolean forward)`
`static String`	`getResourceDir()` We store the resources of an application in the "classes" directory of the application.
`static String`	`getServerId()` Get the id of the server.
`static MultiMap<String,String>`	`getShadowedFiles()` Checks the classpath for duplicate entries.
`static List<File>`	`getSystemClasspath()`
`static File`	`getTempDir()` Return the temporary directory (from the configuration).
`static String`	`getTextCharset()`
`static boolean`	`isFormclass(String classname)`
`boolean`	`isRunning()` Ask the object if it has been started
`static void`	`log(String s, int level)` Deprecated. use own `Logger` instead
`static void`	`logError(Throwable err)` Deprecated. use own `Logger` instead
`static void`	`logError(Throwable err, String errHeader)` Deprecated. use own `Logger` instead
`static void`	`logError(Throwable e, String msg, int level)` Deprecated. use own `Logger` instead
`void`	`reconfigure()`
`static String`	`removeFormPackageName(String classname)`
`static void`	`setAvailableLocales(Locale[] l)` Change the list of locales.
`static void`	`setBaseDir(String dir)` Set the base directory.
`static void`	`setClassLoader(ClassLoader cl)` Set the application class loader.
`void`	`shutdown()` This method is called on shutdown.
`void`	`startup()` This method is called when the object is "started".

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ALWAYS_OUT
```
public static final org.slf4j.Marker ALWAYS_OUT
```
- Constructor Detail
  - Settings
```
public Settings()
```
- Method Detail
  - setClassLoader
```
public static void setClassLoader(ClassLoader cl)
```
    Set the application class loader.
    
    Parameters:
    
    cl - a class loader
  - getClassLoader
```
public static ClassLoader getClassLoader()
```
    Get the application class loader.
    
    Returns:
    
    a class loader
  - log
```
@Deprecated
public static void log(String s,
                                   int level)
```
    Deprecated. use own Logger instead
    
    Write a message to the log. The message is written when the current log level is greater or equal the given level.
    
    Parameters:
    
    s - the message
    
    level - the log level
  - logError
```
@Deprecated
public static void logError(Throwable err)
```
    Deprecated. use own Logger instead
    
    Log an error
    
    Parameters:
    
    err - a throwable.
  - logError
```
@Deprecated
public static void logError(Throwable err,
                                        String errHeader)
```
    Deprecated. use own Logger instead
    
    Prints a header line and a stack trace for the given Error or Exception
    
    Parameters:
    
    err - a throwable.
    
    errHeader - the text for the header line
  - getBaseDir
```
public static File getBaseDir()
```
    Return the base directory (from the configuration).
    
    Returns:
    
    a File object
  - getTempDir
```
public static File getTempDir()
```
    Return the temporary directory (from the configuration).
    
    Returns:
    
    a File object
  - setBaseDir
```
public static void setBaseDir(String dir)
```
    Set the base directory.
    
    Parameters:
    
    dir - the directory path
  - getServerId
```
public static String getServerId()
```
    Get the id of the server.
    
    Returns:
    
    a string containing the server name
  - getAvailableLocales
```
public static Locale[] getAvailableLocales()
```
    Return the list of locales from the configuration.
    
    Returns:
    
    an array of Locale objects
  - setAvailableLocales
```
public static void setAvailableLocales(Locale[] l)
```
    Change the list of locales.
    
    Parameters:
    
    l - an array of Locale objects
  - getDecimalFormatter
```
public static com.ibm.icu.text.NumberFormat getDecimalFormatter()
```
  - getLocalNumberFormatter
```
public static com.ibm.icu.text.NumberFormat getLocalNumberFormatter()
```
  - startup
```
public void startup()
```
    Description copied from interface: Lifecycle
    
    This method is called when the object is "started".
    
    Specified by:
    
    startup in interface Lifecycle
  - shutdown
```
public void shutdown()
```
    Description copied from interface: Lifecycle
    
    This method is called on shutdown.
    
    Specified by:
    
    shutdown in interface Lifecycle
  - isRunning
```
public boolean isRunning()
```
    Description copied from interface: Service
    
    Ask the object if it has been started
    
    Specified by:
    
    isRunning in interface Service
    
    Returns:
    
    true if running.
  - reconfigure
```
public void reconfigure()
```
  - getProcessRelations
```
public static Map<String,Pair<String,String>> getProcessRelations()
```
    Returns the list of process relations.
    
    Returns:
    
    a map with the relation-key and a pair of names for each relation.
  - getProcessRelation
```
public static Pair<String,String> getProcessRelation(String key)
```
  - getProcessRelationText
```
public static String getProcessRelationText(String key,
                                            boolean forward)
```
  - getProcessRelationsList
```
public static List<Pair<String,String>> getProcessRelationsList()
```
  - getDecimalFormatter
```
public static com.ibm.icu.text.NumberFormat getDecimalFormatter(String maxDigitSettings,
                                                                com.ibm.icu.text.NumberFormat original)
```
    returns a NumberFormat where the max. fraction and integer digits are set as defined in the passed parameter. all other settings are copied from the passed NumberFormat
    
    Parameters:
    
    maxDigitSettings - the settings for the max. fraction and integer digits. e.g. 18,8 means 10 integer digits and 8 fraction digits
    
    original - the reference-number-format - all other settings are copied from this format
  - getShadowedFiles
```
public static MultiMap<String,String> getShadowedFiles()
```
    Checks the classpath for duplicate entries.
    
    Returns:
    
    MultiMap containing all duplicate entries (key) and their occurances (value)
  - getEPShadowFiles
```
public static String getEPShadowFiles()
                               throws IOException
```
    Check if @enterprise resources are shadowed.
    
    Returns:
    
    null if resources are not loaded from jar file, empty string if no shadowing, else string containing shadow paths.
    
    Throws:
    
    IOException
  - getJarArchive
```
public static File getJarArchive(Class<?> clazz)
```
    Get the jar archive the given class is loaded from.
  - getBootClasspath
```
public static List<File> getBootClasspath()
```
  - getSystemClasspath
```
public static List<File> getSystemClasspath()
```
  - getApplicationClasspath
```
public static List<File> getApplicationClasspath()
```
  - getClasspath
```
public static List<File> getClasspath()
```
  - getLocation
```
public static Pair<URL,ClassLoader> getLocation(String resourceName)
```
  - getLevel
```
@Deprecated
public static int getLevel()
```
    Deprecated. use own Logger instead
    
    Returns:
    
    the current root-loglevel
  - logError
```
@Deprecated
public static void logError(Throwable e,
                                        String msg,
                                        int level)
```
    Deprecated. use own Logger instead
    
    writes logstatements to the root-logger
    
    Parameters:
    
    e - the exception
    
    msg - the message
    
    level - the level
  - getLogFile
```
public static File getLogFile()
```
    returns the current log-file
    
    Returns:
    
    the file log-messages are written to
  - getErrorLogFile
```
public static File getErrorLogFile()
```
    returns the current-error-file
    
    Returns:
    
    the file errors are writen to
  - getLogWriter
```
public static PrintWriter getLogWriter()
```
    Returns:
    
    a printwriter which writes to the log, the default loglevel is INFO
    
    See Also:
    
    LogOutputStream
  - getMessageDigestAlgorithmName
```
public static String getMessageDigestAlgorithmName()
```
    Returns the Name of the MessageDigest algorithm used by the system (e.g. in DMS)
  - getMessageDigest
```
public static MessageDigest getMessageDigest()
```
    Returns a new instance of the MessageDigest used by the system (e.g. in DMS)
  - getFormPackage
```
public static String getFormPackage()
```
    return the name of the form class package (either com.dec.avw.appl. or com.groiss.forms.)
  - isFormclass
```
public static boolean isFormclass(String classname)
```
  - removeFormPackageName
```
public static String removeFormPackageName(String classname)
```
  - getResourceDir
```
public static String getResourceDir()
```
    We store the resources of an application in the "classes" directory of the application. The method returns the constant "classes".
  - getTextCharset
```
public static String getTextCharset()
```

Class Settings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ALWAYS_OUT

Constructor Detail

Settings

Method Detail

setClassLoader

getClassLoader

log

logError

logError

getBaseDir

getTempDir

setBaseDir

getServerId

getAvailableLocales

setAvailableLocales

getDecimalFormatter

getLocalNumberFormatter

startup

shutdown

isRunning

reconfigure

getProcessRelations

getProcessRelation

getProcessRelationText

getProcessRelationsList

getDecimalFormatter

getShadowedFiles

getEPShadowFiles

getJarArchive

getBootClasspath

getSystemClasspath

getApplicationClasspath

getClasspath

getLocation

getLevel

logError

getLogFile

getErrorLogFile

getLogWriter

getMessageDigestAlgorithmName

getMessageDigest

getFormPackage

isFormclass

removeFormPackageName

getResourceDir

getTextCharset