AppConstants (Ibis AdapterFramework parent 7.9-20230322.214744 API)

java.lang.Object
- java.util.Dictionary<K,V>
- - java.util.Hashtable<Object,Object>
  - - java.util.Properties
    - - nl.nn.adapterframework.util.AppConstants

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>
```
public final class AppConstants
extends Properties
implements Serializable
```
Singleton class that has the constant values for this application.

When an instance is created, it tries to load the properties file specified by the propertiesFileName field

If a property exits with the name ADDITIONAL.PROPERTIES.FILE that file is loaded also

Version:

2.0

Author:

Niels Meijer

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ADDITIONAL_PROPERTIES_FILE_SUFFIX_KEY`
`static String`	`APPLICATION_SERVER_CUSTOMIZATION_PROPERTY`
`static String`	`APPLICATION_SERVER_TYPE_PROPERTY`
`static String`	`JDBC_PROPERTIES_KEY`

Fields inherited from class java.util.Properties
defaults

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`get(Object key)`
`Properties`	`getAppConstants(String keyBase)` Returns a list of `AppConstants` which names begin with the keyBase
`Properties`	`getAppConstants(String keyBase, boolean useSystemProperties, boolean useEnvironmentVariables)` Returns a list of `AppConstants` which names begin with the keyBase
`boolean`	`getBoolean(String key, boolean dfault)` Gets a `boolean` value Returns "true" if the retrieved value is "true", otherwise "false" Uses the `getResolvedProperty(String)` method.
`double`	`getDouble(String key, double dfault)` Gets a `double` value Uses the `getResolvedProperty(String)` method.
`static AppConstants`	`getInstance()` Return the AppConstants root instance
`static AppConstants`	`getInstance(ClassLoader cl)` Retrieve an instance based on a ClassLoader.
`int`	`getInt(String key, int dfault)` Gets an `int` value Uses the `getResolvedProperty(String)` method.
`long`	`getLong(String key, long dfault)` Gets a `long` value Uses the `getResolvedProperty(String)` method.
`String`	`getProperty(String key)`
`String`	`getResolvedProperty(String key)` the method is like the `Properties.getProperty`, but provides functionality to resolve `${variable}` syntaxis.
`String`	`getString(String key, String dfault)` Gets a `String` value Uses the `getResolvedProperty(String)` method.
`StringTokenizer`	`getTokenizedProperty(String key)` Creates a tokenizer from the resolved value of this key.
`StringTokenizer`	`getTokenizedProperty(String key, String defaults)` Creates a tokenizer from the resolved value of this key.
`String`	`getUnresolvedProperty(String key)`
`Object`	`put(Object key, Object value)` Deprecated. Use `setProperty(String, String)` instead!
`void`	`put(String key, String value)` Add property to global (all) AppConstants
`static void`	`removeInstance()`
`static void`	`removeInstance(ClassLoader cl)`
`Object`	`setProperty(String key, boolean value)`
`Object`	`setProperty(String key, String value)` Add property to global AppConstants
`String`	`toXml()` Deprecated.
`String`	`toXml(boolean resolve)` Deprecated.

Methods inherited from class java.util.Properties
getProperty, list, list, load, load, loadFromXML, propertyNames, save, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable
clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, getOrDefault, hashCode, isEmpty, keys, keySet, merge, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - APPLICATION_SERVER_TYPE_PROPERTY
```
public static final String APPLICATION_SERVER_TYPE_PROPERTY
```
    See Also:
    
    Constant Field Values
  - APPLICATION_SERVER_CUSTOMIZATION_PROPERTY
```
public static final String APPLICATION_SERVER_CUSTOMIZATION_PROPERTY
```
    See Also:
    
    Constant Field Values
  - JDBC_PROPERTIES_KEY
```
public static final String JDBC_PROPERTIES_KEY
```
    See Also:
    
    Constant Field Values
  - ADDITIONAL_PROPERTIES_FILE_SUFFIX_KEY
```
public static final String ADDITIONAL_PROPERTIES_FILE_SUFFIX_KEY
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getInstance
```
public static AppConstants getInstance()
```
    Return the AppConstants root instance
    
    Returns:
    
    AppConstants instance
  - getInstance
```
public static AppConstants getInstance(ClassLoader cl)
```
    Retrieve an instance based on a ClassLoader. This should be used by classes which are part of the Ibis configuration (like pipes and senders) because the configuration might be loaded from outside the webapp classpath. Hence the Thread.currentThread().getContextClassLoader() at the time the class was instantiated should be used.
    
    Parameters:
    
    cl - ClassLoader to retrieve AppConstants from
    
    Returns:
    
    AppConstants instance
    
    See Also:
    
    IbisContext.init()
  - removeInstance
```
public static void removeInstance()
```
  - removeInstance
```
public static void removeInstance(ClassLoader cl)
```
  - get
```
public String get(Object key)
```
    Specified by:
    
    get in interface Map<Object,Object>
    
    Overrides:
    
    get in class Hashtable<Object,Object>
  - getProperty
```
public String getProperty(String key)
```
    Overrides:
    
    getProperty in class Properties
  - getUnresolvedProperty
```
public String getUnresolvedProperty(String key)
```
  - getResolvedProperty
```
public String getResolvedProperty(String key)
```
    the method is like the Properties.getProperty, but provides functionality to resolve ${variable} syntaxis. It uses the AppConstants values and systemvalues to resolve the variables, and does this recursively.
    
    See Also:
    
    StringResolver
  - getTokenizedProperty
```
public StringTokenizer getTokenizedProperty(String key)
```
    Creates a tokenizer from the resolved value of this key. As a separator the "," is used. Uses the getResolvedProperty(String) method. Can be used to process lists of values.
  - getTokenizedProperty
```
public StringTokenizer getTokenizedProperty(String key,
                                            String defaults)
```
    Creates a tokenizer from the resolved value of this key. As a separator the "," is used. Uses the getResolvedProperty(String) method. Can be used to process lists of values.
  - getAppConstants
```
public Properties getAppConstants(String keyBase)
```
    Returns a list of AppConstants which names begin with the keyBase
  - getAppConstants
```
public Properties getAppConstants(String keyBase,
                                  boolean useSystemProperties,
                                  boolean useEnvironmentVariables)
```
    Returns a list of AppConstants which names begin with the keyBase
  - put
```
@Deprecated
public Object put(Object key,
                              Object value)
```
    Deprecated. Use setProperty(String, String) instead!
    
    Add property only in the local AppConstants! Try to avoid using this method and use setProperty(String, String) if you want to set the property globally!
    This method is used by Properties.load(InputStream) to add all properties found (in a file/stream) to the Hashtable.
    
    Specified by:
    
    put in interface Map<Object,Object>
    
    Overrides:
    
    put in class Hashtable<Object,Object>
  - setProperty
```
public Object setProperty(String key,
                          String value)
```
    Add property to global AppConstants
    
    Overrides:
    
    setProperty in class Properties
  - setProperty
```
public Object setProperty(String key,
                          boolean value)
```
  - put
```
public void put(String key,
                String value)
```
    Add property to global (all) AppConstants
  - toXml
```
@Deprecated
public String toXml()
```
    Deprecated.
  - toXml
```
@Deprecated
public String toXml(boolean resolve)
```
    Deprecated.
  - getString
```
public String getString(String key,
                        String dfault)
```
    Gets a String value Uses the getResolvedProperty(String) method.
    
    Parameters:
    
    key - the Key
    
    dfault - the default value
    
    Returns:
    
    String
  - getBoolean
```
public boolean getBoolean(String key,
                          boolean dfault)
```
    Gets a boolean value Returns "true" if the retrieved value is "true", otherwise "false" Uses the getResolvedProperty(String) method.
    
    Parameters:
    
    key - the Key
    
    dfault - the default value
    
    Returns:
    
    double
  - getInt
```
public int getInt(String key,
                  int dfault)
```
    Gets an int value Uses the getResolvedProperty(String) method.
    
    Parameters:
    
    key - the Key
    
    dfault - the default value
    
    Returns:
    
    int
  - getLong
```
public long getLong(String key,
                    long dfault)
```
    Gets a long value Uses the getResolvedProperty(String) method.
    
    Parameters:
    
    key - the Key
    
    dfault - the default value
    
    Returns:
    
    long
  - getDouble
```
public double getDouble(String key,
                        double dfault)
```
    Gets a double value Uses the getResolvedProperty(String) method.
    
    Parameters:
    
    key - the Key
    
    dfault - the default value
    
    Returns:
    
    double

Class AppConstants

Field Summary

Fields inherited from class java.util.Properties

Method Summary

Methods inherited from class java.util.Properties

Methods inherited from class java.util.Hashtable

Methods inherited from class java.lang.Object

Field Detail

APPLICATION_SERVER_TYPE_PROPERTY

APPLICATION_SERVER_CUSTOMIZATION_PROPERTY

JDBC_PROPERTIES_KEY

ADDITIONAL_PROPERTIES_FILE_SUFFIX_KEY

Method Detail

getInstance

getInstance

removeInstance

removeInstance

get

getProperty

getUnresolvedProperty

getResolvedProperty

getTokenizedProperty

getTokenizedProperty

getAppConstants

getAppConstants

put

setProperty

setProperty

put

toXml

toXml

getString

getBoolean

getInt

getLong

getDouble