ERXConfigurationManager (Project Wonder Reference Documentation)

java.lang.Object
- er.extensions.foundation.ERXConfigurationManager

public class ERXConfigurationManager
extends Object

Handles rapid turnaround for system configuration as well as swizzling of the EOModel connection dictionaries.

Placing configuration parameters

You can provide the system configuration by the following ways:

Note: This is the standard way for WebObjects 5.x applications.

Properties file under the Resources group of the application and framework project. It's a Properties file and Project Wonder's standard project templates include it. (The templates won't be available on some platforms at this moment.)
WebObjects.properties under the user home directory; same format to Properties.
Note that the user home directory depends on the user who launch the application. They may change between the development and deployment time.
Command line arguments
For example: -WOCachingEnabled false -com.webobjects.pid $$
Don't forget to put a dash "-" before the key.

Loading order of the configuration parameters

When the application launches, configuration parameters will be loaded by the following order. ERXConfigurationManager tries to reload them by the exactly same order when one of those configuration files changes.

Properties in frameworks that the application links to
Properties in the application
WebObjects.properties under the home directory
Command line arguments

If there is a conflicting parameter between the files and arguments, the latter one overrides the earlier one.

Note that the order between frameworks does not seems to be specified. You should not put conflicting parameters between framework Properties files. On the other hand, the application Properties should be always loaded after all framework Properties are loaded. You can safely override parameters on the frameworks from the applications Properties.

Changing the connection dictionary

To do this for Oracle you can either specify on a per model basis or on a global basis.

 Global:
      dbConnectServerGLOBAL = myDatabaseServer
      dbConnectUserGLOBAL = me
      dbConnectPasswordGLOBAL = secret
      dbConnectPluginGLOBAL = Oracle
 Per Model for say model ER:
      ER.DBServer = myDatabaseServer
      ER.DBUser = me
      ER.DBPassword = secret
      ER.DBPlugin = Oracle
 
 Openbase: same, with DBDatabase and DBHostname
 
 JDBC: same with dbConnectURLGLOBAL, or ER.DBURL

Prototypes can be swapped globally or per model either by hydrating an archived prototype entity for a file or from another entity.

Properties
Name	Description
`er.extensions.ERXConfigurationManager.PropertiesTouchFile`	if this property is set to a file name, the application will register for notifications of changes to that file and when that file is touched, the application will re-load properties.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`_hostName` holds the host name
`static String`	`ConfigurationDidChangeNotification` Notification posted when the configuration is updated.
`protected String`	`documentRoot`
`static int`	`MacOSXOperatingSystem`
`static int`	`SolarisOperatingSystem`
`static int`	`UnknownOperatingSystem`
`static int`	`WindowsOperatingSystem`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Properties`	`applyConfiguration(Properties systemProperties)` This will overlay the current system config files.
`Properties`	`commandLineArgumentProperties()` Returns the command line arguments as Properties.
`String[]`	`commandLineArguments()` Returns the command line arguments.
`void`	`configureRapidTurnAround()` Sets up the system for rapid turnaround mode.
`static ERXConfigurationManager`	`defaultManager()` Returns the single instance of this class
`Properties`	`defaultProperties()` Returns the command line arguments as Properties.
`String`	`documentRoot()` Path to the web server's document root.
`String`	`hostName()` Gets the default host name for the current local host.
`void`	`initialize()` Initializes the configuration manager.
`boolean`	`isDeployedAsServlet()` Is the application deployed as a servlet? The heuristic used here is whether `contextClassName()` is set to `WOServletContext` or `ERXWOServletContext` (or some other name containing "Servlet").
`void`	`loadConfiguration()` This will overlay the current system config files.
`int`	`operatingSystem()`
`void`	`setCommandLineArguments(String[] newCommandLineArguments)` Sets the command line arguments.
`void`	`updateAllSystemProperties(NSNotification notification)`
`void`	`updateSystemProperties(NSNotification n)` Updates the configuration from the current configuration and posts `ConfigurationDidChangeNotification`.

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

- Field Detail
  - ConfigurationDidChangeNotification
```
public static final String ConfigurationDidChangeNotification
```
    Notification posted when the configuration is updated. The Java system properties is the part of the configuration.
    
    See Also:
    
    Constant Field Values
  - WindowsOperatingSystem
```
public static final int WindowsOperatingSystem
```
    See Also:
    
    Constant Field Values
  - MacOSXOperatingSystem
```
public static final int MacOSXOperatingSystem
```
    See Also:
    
    Constant Field Values
  - SolarisOperatingSystem
```
public static final int SolarisOperatingSystem
```
    See Also:
    
    Constant Field Values
  - UnknownOperatingSystem
```
public static final int UnknownOperatingSystem
```
    See Also:
    
    Constant Field Values
  - documentRoot
```
protected String documentRoot
```
  - _hostName
```
protected String _hostName
```
    holds the host name
- Method Detail
  - defaultManager
```
public static ERXConfigurationManager defaultManager()
```
    Returns the single instance of this class
    
    Returns:
    
    the configuration manager
  - commandLineArguments
```
public String[] commandLineArguments()
```
    Returns the command line arguments. ERXApplication.main(String[], Class) sets this value.
    
    Returns:
    
    the command line arguments as a String[]
    
    See Also:
    
    setCommandLineArguments(java.lang.String[])
  - commandLineArgumentProperties
```
public Properties commandLineArgumentProperties()
```
    Returns the command line arguments as Properties. ERXApplication.main(String[], Class) sets this value.
    
    Returns:
    
    the command line arguments as a String[]
    
    See Also:
    
    setCommandLineArguments(String[])
  - defaultProperties
```
public Properties defaultProperties()
```
    Returns the command line arguments as Properties. ERXApplication.main(String[], Class) sets this value.
    
    Returns:
    
    the command line arguments as a String[]
    
    See Also:
    
    setCommandLineArguments(String[])
  - setCommandLineArguments
```
public void setCommandLineArguments(String[] newCommandLineArguments)
```
    Sets the command line arguments. ERXApplication.main(String[], Class) will call this method when the application starts up.
    
    See Also:
    
    commandLineArguments()
  - initialize
```
public void initialize()
```
    Initializes the configuration manager. The framework principal ERXExtensions calls this method when the ERExtensions framework is loaded.
  - configureRapidTurnAround
```
public void configureRapidTurnAround()
```
    Sets up the system for rapid turnaround mode. It will watch the changes on Properties files in application and framework bundles and WebObjects.properties under the home directory. Rapid turnaround mode will only be enabled if there are such files available and system has WOCaching disabled.
  - loadConfiguration
```
public void loadConfiguration()
```
    This will overlay the current system config files. It will then re-load the command line args.
  - applyConfiguration
```
public Properties applyConfiguration(Properties systemProperties)
```
    This will overlay the current system config files. It will then re-load the command line args.
  - updateSystemProperties
```
public void updateSystemProperties(NSNotification n)
```
    Updates the configuration from the current configuration and posts ConfigurationDidChangeNotification. It also calls ERXLogger.configureLoggingWithSystemProperties() to reconfigure the logging system.
    The configuration files: Properties and WebObjects.properties files are reloaded to the Java system properties by the same order to the when the system starts up. Then the command line arguments will be applied to the properties again so that the configuration will be consistent during the application lifespan.
    This method is called when rapid turnaround is enabled and one of the configuration files changes.
    
    Parameters:
    
    n - NSNotification object for the event (null means load all files)
  - updateAllSystemProperties
```
public void updateAllSystemProperties(NSNotification notification)
```
  - operatingSystem
```
public int operatingSystem()
```
  - documentRoot
```
public String documentRoot()
```
    Path to the web server's document root. This implementation tries first to resolve the application.name()+ "DocumentRoot" property value, then the ERXDocumentRoot property before getting the DocumentRoot key in your WebServerConfig.plist in the JavaWebObjects bundle.
    
    Returns:
    
    to the web server's document root.
  - hostName
```
public String hostName()
```
    Gets the default host name for the current local host.
    
    Returns:
    
    host name or UnknownHost if the host is unknown.
  - isDeployedAsServlet
```
public boolean isDeployedAsServlet()
```
    Is the application deployed as a servlet? The heuristic used here is whether contextClassName() is set to WOServletContext or ERXWOServletContext (or some other name containing "Servlet").
    
    Returns:
    
    true if the application is deployed as a servlet, otherwise false

Class ERXConfigurationManager

Placing configuration parameters

Loading order of the configuration parameters

Changing the connection dictionary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ConfigurationDidChangeNotification

WindowsOperatingSystem

MacOSXOperatingSystem

SolarisOperatingSystem

UnknownOperatingSystem

documentRoot

_hostName

Method Detail

defaultManager

commandLineArguments

commandLineArgumentProperties

defaultProperties

setCommandLineArguments

initialize

configureRapidTurnAround

loadConfiguration

applyConfiguration

updateSystemProperties

updateAllSystemProperties

operatingSystem

documentRoot

hostName

isDeployedAsServlet