Next Previous

Retired Document

Important: This document may not represent best practices for current development. Links to downloads and other resources may no longer be valid.

Application Properties

This chapter describes the properties you can configure when launching a WebObjects application.

The application properties are described in Table 1. Note that some properties are for deployment, and others are for development only. Some properties are specific to certain types of WebObjects applications—for example, Direct to Web applications. Most properties correspond to a method in one of the WebObjects frameworks. See the property description for links to the related reference document.

There are several ways to set these properties. You can specify these arguments on the command line using Java-style command-line arguments with the following format:

<appName> -D<optionName>=<value> -D<optionName>=<value> ...

For example, you set the WOAllowsConcurrentRequestHandling property to true as follows:

./myApp -DWOAllowsConcurrentRequestHandling=true

You can also specify these properties in the application’s Properties file. The Properties file is located in the Contents/Resources directory of an application folder. See the API reference for NSProperties in WebObjects 5.3 Reference to learn more about property specifications in WebObjects.

Read WebObjects Deployment Guide Using JavaMonitor for how to set some of these properties using deployment tools.

**Table 1** Application properties
Property	Type	Description
`D2WTraceRuleFiringEnabled`	boolean	A Boolean value that determines whether or not rule firing should be logged. Set to `true` to log rule firing; otherwise, `false`.
`D2WTraceRuleModificationsEnabled`	boolean	A Boolean value that determines whether or not rule modifications should be logged. Set to `true` to log rule modifications; otherwise, `false`.
`EOAdaptorDebugEnabled`	boolean	A Boolean value that determines whether or not SQL sent by an application’s `EOAdaptor` object to a data source should be logged. Set to `true` to turn on `EOAdaptor` logging; otherwise, `false`.
`EOAdaptorUseBindVariables`	boolean	A Boolean value that determines whether or not the `EOAdaptor` object should use binding variables. Set to `true` to require bind variables; otherwise, `false`. See the useBindVariables method of `EOSQLExpression` for details.
`EOAssistantEnabled`	boolean	A Boolean value that determines whether or not to launch the Direct to Java Client Assistant for Direct to Java Client applications. Set to `true` to enable the assistant; otherwise, `false`.
`EOEventLoggingLimit`	integer	The limit of the event logging stack. See the EOEventCenter class reference for details.
`EOEventLoggingOverflowDisplay`	boolean	A Boolean value that determines whether or not event data should be logged when the event log limit is exceeded. Set to `true` to enable overflow logging; otherwise, `false`. See the EOEventCenter class reference for details.
`EOEventLoggingPassword`	string	The password that allows access to event logging data. See the EOEventCenter class reference for details.
`NSCurrencySymbol`	string	The currency symbol to use in the application. See the currencySymbol method of `NSNumberFormatter` for details.
`NSDebugGroups`	string or bit position	Indicates the debugging groups to enable. Groups are used to track individual issues. See the NSLog class reference for details.
`NSDebugLevel`	integer or string	Represents the debug logging level. See the NSLog class reference for details.
`NSProjectSearchPath`	array	An array of strings representing file system paths in which to look for projects for rapid turnaround mode. This property is not used by Xcode. See the projectSearchPath method of `WOApplication` for details.
`NSXMLValidation`	boolean	A Boolean value that determines whether or not the XML parser performs validation while deserializing an XML document. Set to `true` to validate; otherwise, `false`.
`WOAcceptMalformedCookies`	boolean	A Boolean value that determines whether or not to control what happens when a malformed cookie is received in a request. Set to `true` to accept the request containing a malformed cookie; otherwise, `false`. See the WOMessage class reference for details.
`WOAdaptor`	string	The class name of the application’s primary adaptor. See the adaptor method of `WOApplication` for details.
`WOAdditionalAdaptors`	array	An array of dictionaries representing the class names of the application’s additional adaptors. See the additionalAdaptors method of `WOApplication` for details.
`WOAllowsCacheControlHeader`	boolean	A Boolean value that determines whether or not client-side page caching is on. Set to `true` to enable client-side page caching; otherwise, `false`. See the disableClientCaching method of `WOResponse` for details.
`WOAllowsConcurrentRequestHandling`	boolean	A Boolean value that determines whether or not concurrent request handling is on. Set to `true` to turn on concurrent request handling; otherwise, `false`. See the allowsConcurrentRequestHandling method of `WOApplication` for details.
`WOAllowRapidTurnaround`	boolean	A Boolean value that determines whether or not rapid turnaround mode is on. Set to `true` to turn rapid turnaround on; otherwise, `false`. The default value is `true` in development mode and `false` in deployment mode.
`WOApplicationBaseURL`	string	A path indicating the location of the WebObjects application under the document root, not including the application name. See the applicationBaseURL method of `WOApplication` for details.
`WOApplicationName`	string	The WebObjects application name. The default value is the name of the executable file without any extensions. See the name method of `WOApplication` for details. This property is used by the HTTP adaptor to implement load balancing. The adaptor can load-balance only between instances with the same application name. This setting can be used to create groups of instances, even when the instances share the same executable file. This argument is set automatically for instances started by wotaskd.
`WOAutoOpenInBrowser`	boolean	A Boolean value that determines whether or not the application is automatically opened in a browser window. Set to `true` to open the application in a browser; otherwise, `false`. By default, the application opens in a browser. See the autoOpenInBrowser method of `WOApplication` for details.
`WOAutoOpenClientApplication`	boolean	A Boolean value that determines whether or not the client-side application is automatically launched in a three-tier Java Client application. Set to `true` to auto launch the client; otherwise, `false`. See the autoOpenClientApplication method of `WOApplication` for details.
`WOCGIAdaptorURL`	string	The URL for the web server including the path to the WebObjects CGI adaptor. See the cgiAdaptorURL method in `WOApplication` for details.
`WOCachingEnabled`	boolean	A Boolean value that determines whether or not component definition caching is enabled—whether or not a component’s `.wod` and `.html` are parsed again. Set to `true` to enable caching; otherwise, `false`. See the isCachingEnabled method for `WOApplication` for details.
`WOContextClassName`	string	The class name of the application’s context class. See the contextClassName method of `WOApplication` for details.
`WODebuggingEnabled`	boolean	A Boolean value that determines whether or not debug logging is enabled. Set to `true` to enable debug logging; otherwise, `false`. If the logging is enabled, the `NSLog()` method debug level is set to at least `DebugLevelInformational` and the group includes `DebugGroupWebObjects`. The default value is `true` in development mode and `false` in deployment mode.
`WODefaultUndoStackLimit`	integer	The default undo stack limit for the application’s sessions. See the defaultUndoStackLimit method of `WOApplication` for details.
`WODirectActionRequestHandler`	string	The class name of the application’s direct action request handler. See the directActionRequestHandlerKey method of `WOApplication` for details.
`WODirectConnectEnabled`	boolean	A Boolean value that determines whether or not direct connect mode is enabled—whether or not a host name and port number can be used to connect from a browser to the application. Set to `true` to enable direct connect; otherwise, `false`. The default value is `true` during development mode and `false` in deployment mode. See the isDirectConnectEnabled method of `WOApplication` for details.
`WODisplayExceptionPages`	boolean	A Boolean value that determines whether or not the generation of `WOExceptionPages` for direct action requests is enabled. Set to `true` to enable exception pages; otherwise, `false`. The default value is `true` in development mode and `false` in deployment mode.
`WOEventLoggingEnabled`	boolean	A Boolean value that determines whether or not event logging in the application server is enabled. Set to `true` to enable event logging; otherwise, `false`. See the WOEvent class reference for details.
`WOFrameworksBaseURL`	string	The URLs of the frameworks to use when generating URLs for web server resources. See the frameworksBaseURL method of `WOApplication` for details.
`WOGenerateWSDL`	boolean	A Boolean value that determines whether or not to allow the generation of WSDL files in a web services application. Set to `true` to generate WSDL files; otherwise, `false` .
`WOHost`	string	The name of the host on which the application is running or, in a multihomed environment, the address of the adaptor the application should use. See the host method of `WOApplication` for details.
`WOIncludeCommentsInResponse`	boolean	A Boolean value that determines whether or not HTML comments are included in the application’s responses. Set to `true` to include the comments; otherwise, `false`. See the includeCommentsInResponses method of `WOApplication` for details.
`WOLifebeatDestinationPort`	integer	The port to which lifebeat signals are sent. The default value is `1085`. See the lifebeatDestinationPort method of `WOApplication` for details.
`WOLifebeatEnabled`	boolean	A Boolean value that determines whether or not the application instance sends lifebeats. Set to `true` to enable lifebeats; otherwise, `false`. The default value is `true`. See the lifebeatEnabled method of `WOApplication` for details.
`WOLifebeatInterval`	integer	The interval (in seconds) between lifebeats. The default value is `30`. See the lifebeatInterval method of `WOApplication` for details.
`WOListenQueueSize`	integer	The size of the application adaptor’s listen queue. See the listenQueueSize method of `WOApplication` for details.
`WOMaxIOBufferSize`	integer	The maximum buffer size used when reading requests. A buffer larger than this value is truncated after the current request has finished processing. The default value is `8,192`.
`WOMaxHeaders`	integer	The maximum number of headers in a single request. The default value is `200`.
`WOMaxSocketIdleTime`	integer	The number of milliseconds for which a socket should be allowed to wait on incoming data. See the maxSocketIdleTime method of `WOApplication` for details.
`WOMissingResourceSearchEnabled`	boolean	A Boolean value that determines whether or not an application’s resource list is refreshed every time a resource cannot be found. Set to `true` to refresh the list; otherwise, `false`. This flag applies only to applications in rapid turnaround mode. When this flag is set to `true`, you can make changes to an application’s resources (such as images) and immediately see the results of those changes in a running application. Doing so incurs overhead, so you may want to set this flag to `false` to improve page-loading speed during development. The default value is `true`.
`WOMonitorEnabled`	boolean	A Boolean value that determines whether or not the application is started by JavaMonitor. Set to `true` to enable JavaMonitor; otherwise, `false`. See the monitorEnabled method of `WOApplication` for details.
`WOOutputPath`	string	A file system path indicating the location of logs. The default value is `/dev/null`. See the outputPath method of `WOApplication` for details.
`WOPort`	integer	The port on which the application’s primary adaptor listens. The default value is `1085`. See the port method of `WOApplication` for details.
`WORecordingPath`	string	A file system path indicating the location of recording files. See the recordingPath method of `WOApplication` for details.
`WOSMTPHost`	string	The name of the mail server used to send messages created by `WOMailDelivery`. See the SMTPHost method of `WOApplication` for details.
`WOSessionStoreClassName`	string	The name of the class used to store sessions. See the sessionStoreClassName method of `WOApplication` for details.
`WOSessionTimeOut`	integer	The number of seconds for which a session may be idle before it times out. The default value `3600`. See the sessionTimeOut method of `WOApplication` for details.
`WOStatisticsPassword`	string	The password that allows access to the application statistics—the password used to access the statistics page of an application instance. See the setPassword method of `WOStatisticsStore` for more details.
`WSAssistantEnabled`	boolean	A Boolean value that determines whether or not the Web Services Assistant in a Direct to Web Services application is launched. Set to `true` to launch the assistant; otherwise, `false`.

Next Previous