Oracle9i Application Server Wireless Edition Configuration Guide Release 1.1 Part Number A86701-01 |
Library | Service | Contents | Index

# 9
Property Files

The Wireless Edition supports system-wide extensibility using property files. Each property file stores runtime parameters and processing information for a Wireless Edition component. The Wireless Edition property files are named with the extension .properties or .xml.

Each section of this document presents a different topic. These sections include:

- Section 9.1, "Overview"

- Section 9.2, "System.Properties"

- Section 9.3, "Notification.properties"

- Section 9.4, "Rmi.properties"

- Section 9.5, "oemevent.properties"

- Section 9.6, "Ftp.properties"

- Section 9.7, "Spatial.Properties"

- Section 9.8, "www-server.properties"

- Section 9.9, "Provisioning.properties"

- Section 9.10, "useragent.properties"

- Section 9.11, "LDAP.properties"

- Section 9.12, "AsynchNotification.properties"

- Section 9.13, "AsynchRequest.properties"

- Section 9.14, "EncodingSets.properties"

- Section 9.15, "LocationMark.properties"

- Section 9.16, "ProxyFirewall.properties"

- Section 9.17, "MailAdapter.properties"

- Section 9.18, "Master.Properties"

- Section 9.19, "positioner.xml"

- Section 9.20, "Geocoders.xml"

- Section 9.21, "Mappers.xml"

- Section 9.22, "Routers.xml"

- Section 9.23, "Strip.properties"

- Section 9.24, "MAgent.properties"

- Section 9.25, "MInstances.properties"

- Section 9.26, "Cookies.properties"

- Important: In this document: WE_HOME is the directory in which Wireless Edition is installed followed by the "panama" sub-directory. For example:
      c:\ias10210\panama (Windows NT)
      /private/ias10210/panama (UNIX)
Replace "WE_HOME" with the fully-qualified directory path. ORACLE_HOME is the directory in which Oracle9i Application Server is installed.

## 9.1 Overview

Property files enable you to plug in new components easily, or extend and configure existing ones. The Wireless Edition includes many property files. The following table lists the property files you can use to configure Wireless Edition.

Note: Verify that the .properties files do not contain duplicate entries. If duplicate entries are present, the entry nearest the end of the file has precedence.

Table 9-1 Wireless Edition Properties Files

Property File | Description
--- | ---
System.Properties | Contains configuration settings for the entire Wireless Edition system.
Notification.properties | Contains email and SMS server configuration properties.
Rmi.properties | Identifies the server name and listening port of the Wireless Edition RMI server.
oemevent.properties | Contains properties for event logging using oemevent.
Ftp.properties | Identifies the listening port, timing characteristics, and character set for the repository FTP server.
Spatial.Properties | Contains the location of properties file specifying spatial providers.
www-server.properties | Contains properties for a runtime probe.
Provisioning.properties | Identifies the common root folder for users' service trees.
useragent.properties | Links logical devices in the Wireless Edition repository to the actual user agent parameter received in an HTTP header. Also specifies a default logical device to use if the device type cannot be determined.
LDAP.properties | Server timing and referral handling properties for LDAP adapter.
AsynchNotification.properties | Outgoing message queue Asynchronous Dequeuer properties.
AsynchRequest.properties | Incoming Asynchronous Request Dequeuer properties.
EncodingSets.properties | Used to convert the encoding set names from IANA names to Java names.
LocationMark.properties | Specifies which attribute of a location mark should be displayed.
ProxyFirewall.properties | Specifies proxy properties for HTTP or FTP protocols.
MailAdapter.properties | Email adapter properties.
Master.Properties | Read by the master instance when the multiple Java Virtual Machine option is enabled.
positioner.xml | Specifies the automatic positioning capability provider.
Geocoders.xml | Specifies the geocoding provider's preference in descending order.
Mappers.xml | Specifies all the possible mapper capability providers preference in descending order.
Routers.xml | Specifies all the routing capability provider's preference in descending order.
Strip.properties | Acquires and converts arbitrary Web content, reads configuration settings from the Strip.properties file. It uses the settings in the file to locate classes that process the markup tags in content. Each processing class implements a strip level for the adapter. To add a strip level, you create the class that implements the strip level and reference it in. This makes the strip level available to the adapter, without requiring you to make changes to the stripper adapter class.
MAgent.properties | Points to an instance's classes and port number.
MInstances.properties | Refers an instance back to the appropriate MAgent.properties file for that instance.
Cookies.properties | Enables the use of cookies and defines the login duration.

## 9.2 System.Properties

The Wireless Edition system configuration file, System.properties, contains parameters and component locators for the entire Wireless Edition system. These settings can be found in System.properties.templ and should be copied to System.properties. To start the Wireless Edition, you must have this file in the class package `oracle.panama.core.admin`. This package must be in the environment CLASSPATH.

This file is in the WE_HOME/server/classes/oracle/panama/core/admin directory.

The System.properties file contains the following parameters:

Table 9-2 Parameters for the System.properties File

Key | Type | Editable | Description
--- | --- | --- | ---
version | String | N | The Wireless Edition version.
instance.identifier | String | Y | The Wireless Edition server instance identifier. It should be unique among Wireless Edition server instances and should be modified if multiple instances are running. The default is instance1.
locator.boot.check | Boolean | N | If set to true, the Wireless Edition performs a bootstrap check procedure during system boot. The default is true.
participateInCacheSyncronization | Boolean | Y | Determines whether the instance should participate in Cache Synchronization. The default is false.
masterInstance.url | String | Y | The URL for the master instance's registry. The default is //localhost:2007.
enable.http.session.binding | Boolean | Y | Enables binding to HTTP session to allow URL rewriting based on JServ load-balancing. The default is false.
db.connect.string | String | Y | A valid connect string, including user name and password. The precise format depends on the driver you use.
db.driver | String | Y | The JDBC driver that the Wireless Edition uses to access the repository. Possible values are THIN,V7, V8, INTERNAL, and CUSTOM. The default is THIN. If set to CUSTOM, you must also set the db.driver.class parameter.
db.session.min | Integer | Y | The minimum or optimal number of open database sessions. This parameter is used to tune the session pool. It can increase when necessary, but always attempts to return to the specified number of concurrent open database sessions.
db.connect.minConnections | Integer | Y | The minimum number of connections for the connection pool. The default is 5.
db.connect.maxConnections | Integer | Y | The maximum number of connections for the connection pool. The default is 100.
db.connect.incConnections | Integer | Y | The incremental allocation of new connections to the connection pool. The default is 1.
name.separator | Character | N | The separator used in the service path. This cannot be modified after installation. The default is a forward slash: "/".
repository.session.check.interval | Seconds | Y | Time interval for unused connections to be found and released to the connection pool. The default is 1.
passwordEncrypted | Boolean | Y | Declares whether the password in the database connect string is in clear text or encrypted. The default is false.
locatorSystemPasswordEncryptionHook.class | Class Name | Y | If the value of passwordEncrypted is true, this declares which class implements the password encryption hook. The default is oracle.panama.rt.common.SystemPasswordEncryption.
locator.objectcache.class | Class Name | N | The object cache implementation class. The default is oracle.panam.core.util.ObjectCacheHardWeakImpl.
objectcache.check.timetolive | Seconds | Y | The time-to-live, in seconds, of a persistent object. After this time, the Wireless Edition reconstructs the object. The default is 600.
objectcache.check.interval | Seconds | Y | The time required for the cache monitor to check the cache. If set to -1, the Wireless Edition does not invoke the cache monitor and the cache is not cleared. The default is 60.
session.expiration.time | Seconds | Y | The time-to-live attribute of a session. The default is 600.
session.expiration. checkinterval | Seconds | Y | The time required for the session monitor to check an open session. The default is 60.
locator.persistent.class | Class name | N | The locator implementation for persistent objects. The default is oracle.panama.core.PersistentLocatorImpl.
locator.logger.class | Class name | N | The logger implementation. The default is oracle.panama.core.admin.LoggerImpl.
locale.language | String | Y | The language used. This is represented by the ISO code for the representation of names of languages. The default is "en".
locale.country | String | Y | The location. This uses the ISO 3166 country code. The default is "US".
log.level | String list | Y | The log level. This can contain any of the following: error, warning, notify, or transaction. The default is "warning, error, notify".
log.directory | Path | Y | The log file directory.
log.file.name | File name | Y | The log file name pattern. The default is sys_panama.log.
log.file.maxsize | Integer | Y | The maximum number of log records in the same file. The default is 1000.
log.tx.directory | Path | Y | The transaction log file directory. The default is /tmp.
log.tx.file.name | File name | Y | The transaction log file name pattern. The default is tx.panama.log.
log.tx.file.maxsize | Integer | Y | The maximum number of transaction entries in the same file. The default is 1000.
log.tx.file.pattern | Formatted string | Y | The pattern used to write transaction log records. The default is {user id}{user external id}"{service name path}"{cost}.
log.tx.min.cost | Integer | Y | The minimum cost for the services to be logged. The value specified is compared with the service cost. Only services with a cost greater than this value are logged. If an invalid number is specified here, the default value of 0 is used.
log.console | Boolean | Y | Determines whether true log output is written to `stderr`. The default is false.
algorithm.password | Java algorithm name | Y | The hash algorithm for passwords. The default is SHA-1.
locator.external.hook.class | Class name | Y | The default implementation of `UserAuthenticationHook`. The default is oracle.panama.core.PanamaExternalHookDefImpl.
locator.useragent.class | Class name | Y | The default implementation of the device recognition class. The default is oracle.panama.core.xform.UserAgentImpl.
locator.request.daemon .classes | Class name list | Y | The system daemons to start. See System.properties file for options.
locator.request.queue.class | Class name | N | The asynchronous request queue implementation. The default is oracle.panama.core.rdbms.AsynchNotificationQueueImpl.
locator.notification.queue.class | Class name | N | The asynchronous notification queue implementation. The default is oracle.panama.util.NotificationDispatcherImpl.
locator.notification.dispatcher.class | Class name | Y | The default notification engine implementation. Default is oracle.panama.util.NotificationDispatcherImpl.
locator.postprocessor.class | Class name | N | The transformer post-processor implementation. The default is oracle.panama.core.xform.PostProcessor.
locator.provisioning.class | Class name | Y | The default implementation of the provisioning hook. The default is oracle.panama.core.util.ProvisioningHookImpl.
locator.folder.renderer.hook.class | Class Name | Y | The hook for a folder renderer. The default value is oracle.panama.rt.common.FolderRenderer.
locator.home.folder.sorter.hook.class | String | Y | This value is used by the oracle.panama.rt.common.HomeFolderSorter class to sort the services in a user's home folder. The default is USER_SERVICES_FIRST.
locator.service.visibility.hook.class | Class Name | Y | This class declares a hook to show or hide a service when Wireless Edition is started. The default is oracle.panama.rt.common.ServiceVisibility.
locator.location.service.visibility.hook.class | Class Name | Y | This class declares a hook to show or hide the contents of a folder based on its current location. The default is oracle.panama.rt.common.LocationServiceVisibility.
locator.authentication.hook.class | Class Name | Y | Declares the hook for user authentication. The default is oracle.panama.rt.common.Authenticator.
locator.authorization.hook.class | Class Name | Y | Declares the hook for user service authorization. The default is oracle.panama.rt.common.Authorizer.
locator.device.identification.hook.class | Class Name | Y | Declares the hook for identifying a logical device. The default is oracle.panama.rt.hook.DeviceModels.
locator.service.visibility.hook.class | Class Name | Y | Declares the hook to check for the show or hide status when Wireless Edition starts. The default is oracle.panama.rt.common.ServiceVisibility.
locator.session.id.hook.class | Class Name | Y | Declares the hook for generating the session ID. The default is oracle.panama.rt.common.SessionIdGenerator.
locator.listener.registration.hook.class | Class Name | Y | Declares the hook for the event registration listener. The default is oracle.panama.rt.common.ListenerRegistration.
locator.caller.location.hook.class | Class Name | Y | Declares the hook which acquires the user's current location. The default is oracle.panama.rt.common.CallerLocator.
subscriber.id.request.parameter.name | String | Y | Predefined request parameter used to acquire the user's subscriber ID.
locator.subscriber.id.hook.class | Class Name | Y | Declares a hook to acquire a subscriber's ID.
locator.pre.processor.hook.class | Class Name | Y | Declares a hook to be invoked before device transformation.
locator.post.processor.hook.class | Class Name | Y | Declares a hook to be invoked after device transformation.
locator.combined.listener.classes | Class Name | Y | Declares a listener for the request, session and response events.
locator.session.listener.classes | Class Name | Y | Declares a class to implement the SessionListener interface, or oracle.panama.core.admin.SystemLogger to perform database session logging. The properties event.session.begin and event.session.end must be set to 1 to enable them.
locator.request.listener.classes | Class Name | Y | Declares a class to implement the RequestListener interface, or oracle.panama.core.admin.SystemLogger to perform database session logging. The event.request.begin and event.request.end, and event.after.request properties must be set to 1 to enable them
locator.response.listener.classes | Class Name | Y | Declares a class to implement the ResponseListener interface.
event.before.request | Boolean | Y | Declares a request event to be "just received." The default is false, or disabled. Set to true to enable.
event.request.begin | Boolean | Y | Declares a request event to be "begin being processed". The default is false, or disabled. Set to true to enable.
event.request.end | Boolean | Y | Declares a request event to be "request has been completely processed". The default is false, or disabled. Set to true to enable.
event.service.begin | Boolean | Y | Declares a request event to be "before the adapter is invoked". The default is false, or disabled. Set to true to enable.
event.service.end | Boolean | Y | Declares a request event to be "adapter execution complete". The default is false, or disabled. Set to true to enable.
event.transform.begin | Boolean | Y | Declares a request event to be "before the transformation". The default is false, or disabled. Set to true to enable.
event.transform.end | Boolean | Y | Declares a request event to be "transformation complete". The default is false, or disabled. Set to true to enable.
event.request.error | Boolean | Y | Declares a request event to be "error occurs during request processing". The default is false, or disabled. Set to true to enable.
event.after.request | Boolean | Y | Declares a request event to be "request object has been released". The default is false, or disabled. Set to true to enable.
event.response.error | Boolean | Y | Declares a response event to be "error in response object. The default is false, or disabled. Set to true to enable.
event.before.session | Boolean | Y | Declares a session event to be "before session starts". The default is false, or disabled. Set to true to enable.
event.session.begin | Boolean | Y | Declares a session event to be "session has been validated". The default is false, or disabled. Set to true to enable.
event.session.end | Boolean | Y | Declares a session event to be "session has expired (implicitly and explicitly)". The default is false, or disabled. Set to true to enable.
event.after.session | Boolean | Y | Declares a session event to be "session object has been released". The default is false, or disabled. Set to true to enable.
system.java.protocol. handler.pkgs | Class name | Y | The Java class package that provides SSL (Secure Sockets Layer) support. Default is com.sun.net.ssl.internal.www.protocol.
order.services | String | Y | The sorting order for the Wireless Edition services, folders, and bookmarks on the output devices. The default is ORDER_SEQNO_ASC, ORDER_NAME_ASC.
SystemLog.enableServiceLogging | Boolean | Y | Specifies whether Service Logging should be enabled. The default is false.
SystemLog.enableSessionLogging | Boolean | Y | Specifies whether Session Logging should be enabled. The default is false.
SystemLog.logger.maxSize | Integer | Y | Specifies the maximum number of entries that will be buffered before flushing the entries to the database.
SystemLog.logger.wakeupFrequency | Minutes | Y | Specifies the number of minutes after which the logger thread wakes up to flush the entries in the database tables. The default is 10.
SystemLog.db.connect.string | String | Y | This is the JDBC connect string for logging to a second database.
transformer.poolsize | Integer | Y | Specifies the number of XML transformers in the pool. The pool size should be around 1.5 times the number of CPUs. The default is 10.
URLStreamHandlerFactory.clas | Class Name | N | The URL StreamHandlerFactory used to create URLs. The default value is oracle.panama.core.util.URLStreamHandlerFactoryImpl.
folder.subfolder.pagesize | String | Y | The control number of services to be displayed under a folder at any one time.
folder.subfolder.nextlabel | String | Y | The label used to link the next set of folder.subfolder.pagesize services if the folder.subfolder.pagesize property is set.

## 9.3 Notification.properties

This file provides basic configuration for the notification engine.

This file is in the WE_HOME/server/classes/oracle/panama/core/admin directory.

Table 9-3 Parameters of the Notification.properties File

Key | Type | Editable | Description
--- | --- | --- | ---
dispatcher.logical.device.email.name | String | N | The repository name of the logical device for email. The default is EMAIL.
dispatcher.logical.device.sms.name | String | N | The repository name of the logical device for short messaging service (SMS). The default is SMS.
sms.account.id | Number | Y | The Wireless Edition System Account ID, if any, for the SMS-C.
sms.account.password | String | Y | The password for the sms.account.id
sms.server.name | String | Y | The name of the host where SMS-C is running.
sms.server.port | Integer | Y | The port number on which the SMS-C is listening.
sms.driver.class | String | Y | Use oracle.panama.util.sms.SmsUCPDriver for UCP protocol. Use oracle.panama.util.sms.SmsSMPPDriver for SMPP protocol. The default is the UCP protocol.
sms.ucptype | String | Y | Specify the UCP command set type. The default is 01. For 51 operations sent, use 51.
sms.message.maxchunks | Number | Y | The max number of SMS chunks per message. The default is 3.
sms.message.maxsize | Number | Y | The maximum number of bytes per message. The default is 160.
sms.smpp.system.id | String | Y | The system account identification for the Short Message Peer to Peer protocol (SMPP) SMS-C.
sms.smpp.system.password | String | Y | The password for the sms.smpp.system.id account.
sms.smpp.system.type | String | Y | The SMPP system type.
mail.server.name | String | Y | The Send Mail Transport Protocol (SMTP) server host name if email is used as the means of notification.
mail.domain | String | Y | This property is optional. The mail domain name used if required by the SMTP server.
mail.from | String | Y | This property is mandatory. The "From" mail address.
mail.organization | String | Y | This property is optional. The organization.
mail.subject | String | Y | This property is mandatory. The mail subject.
mail.content.transfer.encoding | String | Y | This property is mandatory. The Content-Transfer-Encoding.

## 9.4 Rmi.properties

You can manage objects in the Wireless Edition repository from a remote client using the RMI (Remote Method Invocation) server. The RMI server is a daemon that enables you to access and manipulate Wireless Edition objects using an RMI interface. Currently, the Wireless Edition automatically generates the RMI component from the interface definitions using introspection of the compiled Java interfaces. See `oracle.panama.core.util.GenerateRMI` for more information.

An RMI session is stateless and each update call is always completed with a commit or rollback. For this reason, you can manage all persistent objects from a remote client. Management actions take immediate effect when the RMI server works at the object level of the system. To connect to an RMI daemon, you must provide a valid administrator user name and password.

This file is in the WE_HOME/server/classes/oracle/panama/core/admin directory.

The Rmi.properties file has the following parameters:

Table 9-4 Parameters of the Rmi.properties File

Key | Type | Editable | Description
--- | --- | --- | ---
rmi.server.port | Integer | Y | The TCP port on which the daemon listens. The default is 2008.
rmi.server.name | String | Y | The name of the RMI server. The default is PanamaServer.

The implementation is managed by the daemon:

    oracle.panama.core.rmi.server.ServerImpl

## 9.5 oemevent.properties

Asynchronous notification of error information is provided using the event framework provided by the Oracle Enterprise Manager. In case of an error, the Wireless Edition server generates an Oracle Enterprise Manager event at the node where the error occurred providing all the necessary details for the fault diagnosis.

Note: An OEM agent must be running on the node where oemevent is invoked. The event must be defined as an unsolicited event and the node must be added as a monitored destination.

This file is in the WE_HOME/server/classes/oracle/panama/core/admin directory.

The oemevent.properties file has the following parameters

Table 9-5 Parameters of the oemevents.properties File

Key | Type | Editable | Description
--- | --- | --- | ---
oemevent.path | string | Y | The complete path name for the oemevent executable.
oemevent.event. name | string | Y | The unsolicited event name as defined in the console.
oemevent.object. name | string | Y | The object name specified in the event definition.
oemevent.event level | String | Y | The event level specified in the event definition. The level should be defined as "2" and specified as "alert".

Note: You must be connected to the spatial database to use the spatial adapters. In addition, data stored in the spatial database (images and geometry) must be purchased from a third-party provider.

## 9.6 Ftp.properties

The FTP server is a daemon that publishes the repository as an FTP file system. The repository folder is represented as an FTP directory, and repository objects are represented as FTP files. The FTP server makes it possible to upload and download users, services, and other repository objects as XML documents.

FTP support allows you to:

- Authenticate users (only administrators can use this utility).

- List directories and files.

- Download XML-enabled persistent objects.

- Upload XML-enabled persistent objects.

- Create subdirectories (service tree folders only).

- Delete directories (service tree folders only).

- Delete any object.

- Rename directories and files.

Note: When uploading new objects, you do not need to assign values to the unique name or `objectid_` attributes. The upload feature uses "update or create" logic. If either the unique name or `objectid_` attribute is set to the same value as an existing object, then the existing object is updated. The unique name of a service is the `url` attribute. For all other objects, the unique name is the `name` attribute.

This file is in the WE_HOME/server/classes/oracle/panama/core/admin directory.

The Ftp.properties file has the following parameter:

Table 9-6 Parameters of the Ftp.properties File

Key | Type | Editable | Description
--- | --- | --- | ---
ftp.server.port | Integer | Y | The TCP listening port. The default is 9100.
ftp.connection.timeout | Seconds | Y | The client connection timeout in seconds, a value of 0 is equal to "no timeout." The default is 30.
ftp.charset | String | Y | Character set used to send "Object" names, it must be a valid Java character set. The default is ISO8859_1.

## 9.7 Spatial.Properties

You must modify the .xml files to get third-party provider information. If you wish to provide your own spatial data, you must add yourself as a provider to the .xml file.

To enable the Wireless Edition to render geocoding services from a third-party provider:

1. In the WE_HOME/server/classes/oracle/panama/spatial directory, rename spatial.properties.tmpl to spatial.properties.

2. Modify spatial.properties to indicate the file to be used for geocoding, routing, ypcategory, ypproviders, mapping, and positioner xml properties.

Table 9-7 Parameters of the spatial.properties File

Key | Type | Editable | Description
--- | --- | --- | ---
file.providers.config.xml.geocoding | String | Y | The XML file for the geocoding.
file.providers.config.xml.routing | String | Y | The XML file for the routing.
file.providers.config.xml.ypcategory | String | Y | The XML file for the yp category mapping.
file.providers.config.xml.ypproviders | String | Y | The XML file for the yp providers.
file.providers.config.xml.mapping | String | Y | The XML file for the mapper providers.
file.xml.positioner | String | Y | The XML file for the automatic positioning provider.

## 9.8 www-server.properties

The probe is a daemon that displays runtime information about:

- Log files

- Active objects

- Active sessions

- Active threads

The probe performs simple runtime management including:

- Shutting down an active object instance.

- Refreshing persistent attributes on an active object.

- Setting the global debug flag to on or off.

- Reloading properties for device recognition when adding a new device to a running system.

By default, the Wireless Edition installation process installs and initiates the probe runtime monitor with the listening port 8090. To access the probe, from a browser enter the following URL:

http://host_name:8090

This file is in the WE_HOME/server/classes/oracle/panama/core/probe directory.

The www-server.properties file has the following parameters:

Table 9-8 Parameters of the www-server.properties File

Key | Type | Editable | Description
--- | --- | --- | ---
port | Integer | Y | The TCP listening port.
root | Path | Y | The root directory for log files.
timeout | Milliseconds | Y | Timeout for a request TCP socket.
workers | Integer | Y | The number of working request threads to start up.
trusted | IP List | Y | A list of "trusted" IP addresses. Each IP address must be separated with a semi-colon, ";". The asterisk, "*"' wildcard may be used. An empty statement grants trusted status to all.

The following daemon manages the implementation:

`oracle.panama.core.probe.WebServer`

## 9.9 Provisioning.properties

This property file is used by the Provisioning adapter and the Personalization Portal.

This file is in the WE_HOME/server/classes/oracle/panama/core/admin directory.

Table 9-9 Parameters of the Provisoning.properties File

Key | Type | Editable | Description
--- | --- | --- | ---
common.root | Folder Name | Y | The common root folder for the user's home folders. A new subfolder is created for every new user. The default is /Users Home.
common.root.owner | String | Y | The owner of the subfolder for users. Subfolders must have an owner which should have administrator privileges. The default is Administrator.
common.group.list | String | Y | The list of groups the new user should belong to, for example <group_name, group_name,. . . > If a group does not exist, it is created automatically.
label.create_user label.user_exist label.user_created label.search_user label.view_user label.edit_user label.change_user label.user_changed label.remove_user label.user_removed label.attribute label.value label.error | String | Y | Text label for the Provisioning adapter, for use in localization.

## 9.10 useragent.properties

This property file lists the mapping from the HTTP user agent to the Wireless Edition logical device.

This file is in the WE_HOME/server/classes/oracle/panama/core/admin directory.

Table 9-10 Parameters of the UserAgents.properties File

Key | Type | Editable | Description
--- | --- | --- | ---
default.logicaldevice | Device | Y | The default logical device if no mapping is found. The default is WML11.
[ID].useragent | String | Y | The UserAgent starting string from HTTPRequest.
[ID].logicaldevice | String | Y | The logical device name to be used.

## 9.11 LDAP.properties

This property file is read by the LDAP adapter.

This file is in the WE_HOME/server/classes/oracle/panama/adapter/ldap directory.

Table 9-11 Parameters of the LDAP.properties File

Key | Type | Editable | Description
--- | --- | --- | ---
auto_referral | Boolean | Y | Sets Wireless Edition to use automatic referral. The default value is true, or enabled. Set to false to disable.
max_search_time | Integer | Y | The maximum allowed search time in milliseconds. The default is 100.
max_result_count | Integer | Y | The maximum results from a search. The default is 1000.

## 9.12 AsynchNotification.properties

This is the property file read by the asynchronous notification Dequeuer. The file is in the WE_HOME/server/classes/oracle/panama/core/admin directory.

Table 9-12 Parameters of the AsynchNotification.properties File

Key | Type | Editable | Description
--- | --- | --- | ---
worker.classname | Class Name | N | The implementation class for the asynchronous notification Dequeuer. The default is oracle.panama.core.parm.asynch.AsynchNotificationImpl.
init.pool.size | Integer | Y | Thread pool size at startup. The default is 1.
minimum.pool.size | Integer | Y | Minimum thread pool size. The default is 1.
server.listen.port | Integer | Y | The asynchronous notification Dequeuer management server listening port. The default is 55000.
server.listen.host | Host Name | Y | The host which is running notification Dequeuer management. The default is localhost.

## 9.13 AsynchRequest.properties

This is the property file read by the asynchronous request Dequeuer.

This file is in the WE_HOME/server/classes/oracle/panama/core/admin directory.

Table 9-13 Parameters of the AsynchRequest.properties File

Key | Type | Editable | Description
--- | --- | --- | ---
worker.classname | Class Name | N | The class implements the asynchronous request Dequeuer.
init.pool.size | Integer | Y | Thread pool size at startup. The default is 1.
minimum.pool.size | Integer | Y | Minimum thread pool size. The default is 1.
server.listen.port | Integer | Y | The asynchronous notification Dequeuer management server listening port. The default is 55000.
server.listen.host | Host Name | Y | The host which is running notification Dequeuer management. The default is localhost.

## 9.14 EncodingSets.properties

This file is used for converting the encoding set names from IANA names to Java names. The order of the entries is not important, but the entries must be unique. If the IANA name and the Java name are identical, no new entry is necessary.

This file is in the WE_HOME/server/classes/oracle/panama/core/admin directory.

The IANA standard is available on the Information Sciences Institute web site. The Java encoding set names are published on the Javasoft web site.

Table 9-14 Parameters of the EncodingSets.properties File

Key | Description
--- | ---
[ID].iananame | The IANA name for the encoding set.
[ID].javaname | The corresponding Java name for the encoding set.

## 9.15 LocationMark.properties

The LocationMark.properties file specifies which attribute of a location mark should be displayed. If you have a specific property file for the location you are in it is used in place of the default LocationMark.properties file. For example, the properties file for locations described in US English would be LocationMark_en_US.properties. Attributes which are set to true are displayed in the Personalization Portal, and on mobile devices connected to the Personalization Portal for personalization.

This file is in the WE_HOME/server/classes/oracle/panama/core/admin directory.

Table 9-15 Parameters of the LocationMark.properties File

Key | Type | Editable | Description
--- | --- | --- | ---
display.Name | String | Y | The name of the location mark.
display.Label | String | Y | The label of the location mark.
display.Description | String | Y | The description of the location mark.
display.CompanyName | String | Y | The company name for the location mark.
display.AddressLine1 | String | Y | The first address line of the location mark.
display.AddressLine2 | String | Y | The second address line of the location mark.
display.AddressLastLine | String | Y | The last address line of the location mark.
display.Block | String | Y | The block of the location mark.
display.City | String | Y | The city of the location mark.
display.County | String | Y | The county of the location mark.
display.State | String | Y | The state of the location mark.
display.Country | String | Y | The country of the location mark.
display.PostalCodeExt | String | Y | The postal extension code of the location mark.
display.PostalCostCode | String | Y | The postal code of the location mark.

## 9.16 ProxyFirewall.properties

This property file specifies the proxy properties used by Wireless Edition when HTTP or FTP protocols are required. If no proxy server is in use, no modifications are necessary.

Table 9-16 Parameters of the ProxyFirewall.properties File

Key | Type | Editable | Description
--- | --- | --- | ---
http.use.proxy | Boolean | Y | Declares the use of an HTTP proxy server. If this is false then proxyhost and proxy.port settings are ignored. The default is false.
http.proxy.host | Host Name | Y | The proxy host name. The default is localhost.
http.proxy.port | Port Number | Y | The proxy server port number. The default is 80.
http.non.proxy.host | String | Y | Lists hosts that should not use a proxy server. Each host name is separated by the pipe character, "|". The default is localhost|127.0.0.1.
ftp.use.proxy | Boolean | Y | Declares the use of an FTP proxy server. If the is false then ftp.proxy.host and ftp.proxy.port settings are ignored. The default is false.
ftp.proxy.host | Host Name | Y | The FTP proxy host name. The default is localhost.
ftp.proxy.port | Port Number | Y | The FTP proxy server port number. The default is 80.
authentication.set | Boolean | Y | Declares whether the proxy server requires authentication. The default is false.
authentication.username | String | Y | The user name if authentication is required.
authentication.password | String | Y | The password if authentication is required.

## 9.17 MailAdapter.properties

This is the properties file for the email adapter.

This file is in the WE_HOME/server/classes/oracle/panama/adapter/mail directory.

Table 9-17 Parameters of the MailAdapter.properties File

Key | Type | Editable | Description
--- | --- | --- | ---
JavaMail.USER_DISPLAY_NUM | Integer | Y | The number of message headings displayed at one time under a message folder. The default is 6.
JavaMail.EMAIL_CONTENT_NUM | Integer | Y | The number of characters displayed for a long message. The default is 100.

## 9.18 Master.Properties

This property file is read by the master instance when the Multiple Virtual Machine option is used.

This file is in the WE_HOME/server/classes/oracle/panama/master directory.

Table 9-18 Parameters of the Master.properties File

Key | Type | Editable | Description
--- | --- | --- | ---
rmi.registry.port | Integer | Y | The master instance RMI registry port. The default is 2007.
db.connect.string | String | Y | The database connect string.
db.driver | JDBC Driver | Y | Specifies which of the following type of JDBC driver will be used, THIN, V7, or V8. Default is THIN.
rmiThreadPool.minThreads | Integer | Y | The minimum number of threads in the RMI thread pool. The default is 10.
rmiThreadPool.minThreads | Integer | Y | The maximum number of threads in the RMI thread pool. The default is 20.
rmiThreadPool.idleTimeout | Integer | Y | The idle timeout, in minutes, for the thread. The default is 10.
remoteObjects.length | Integer | Y | The default is 1.
remote.Object1.name | String | N | The default is CacheSynchServer.
remoteObject1.implementation | String | N | The default is oracle.panama.master.CacheSyncServer.
ptginstances.length | Integer | Y | The number of instances that will participate in the multiple Java Virtual Machine synchronization.
ptginstance[n]rmi.host | String | Y | The host name from which the nth instance is being run.
ptginstance[n]rmi.port | Integer | Y | The port number from which the nth instance is listening.
ptginstance[n]rmi.objectName | String | N | The default value is CacheSynchClient.

## 9.19 positioner.xml

This XML file specifies the automatic positioning capability provider.

This file is in the WE_HOME/server/classes/oracle/panama/mp directory.

Table 9-19 Parameters of the positioner.xml File

Key | Description
--- | ---
ProviderName | The provider name.
ProviderImpl | The class that implements the provider.
the rest | Any additional arguments read by the provider.

## 9.20 Geocoders.xml

This XML file specifies the geocoding provider's preference in descending order.

This file is in the WE_HOME/server/classes/oracle/panama/spatial/geocoder directory.

Table 9-20 Parameters of the Geocoders.xml File

Key | Description
--- | ---
ProviderName | The provider name.
ProviderImpl | The class that implements the provider.
the rest | Any additional arguments read by the provider.

## 9.21 Mappers.xml

This XML file specifies all the possible mapper capability providers. The sequence in the XML file determines the mapper provider's preference in descending order.

This file is in the WE_HOME/server/classes/oracle/panama/spatial/mapper directory.

Table 9-21 Parameters of the mappers.xml File

Key | Description
--- | ---
ProviderName | The provider name.
ProviderImpl | The class that implements the provider.
the rest | Any additional arguments read by the provider.

## 9.22 Routers.xml

This XML file specifies all the possible routing capability providers. The sequence in the XML file determines the routing provider's preference in descending order.

This file is in the WE_HOME/server/classes/oracle/panama/spatial/region directory.

Table 9-22 Parameters of the routers.xml File

Key | Description
--- | ---
ProviderName | The provider name.
ProviderImpl | The class that implements the provider.
the rest | Any additional arguments read by the provider.

## 9.23 Strip.properties

The Strip.properties file notifies the stripper adapter of proxy settings and strip levels. This properties file also defines classes which provide the stripper adapter with a translation table to convert a target entity into an appropriate string.

This file is in the WE_HOME/server/classes/oracle/panama/adapter/stripper directory.

Table 9-23 Parameters of the Strip.properties File

Key | Type | Editable | Description
--- | --- | --- | ---
stripper.useProxy | Boolean | Y | Enables the use of a proxy server. The default is true.
stripper.proxyServe | Host Name | Y | The name of the proxy server. The default is proxy.domain.com.
stripper.proxyPort | Integer | Y | The port number of the proxy server. The default is 80.
stripper.noProxySuffixes | Host Name | Y | The name of any proxy suffix to be specified. The default is domain.com.

After retrieving content, the stripper adapter calls a Java class to process the markup tags in the content. The stripper adapter locates the processing classes, or strip levels, that are available to it in the Strip.properties file.

Table 9-24 Strip Processing Classes

Level | Description | Implementing Class
--- | --- | ---
0 | Retains all tags in the content. | Strip0
1 | Strips all tags from the content. | Strip1

##### Example

    # Classes used for stripping
    # Strip nothing
    stripper.strip0 = oracle.panama.adapter.stripper.Strip0

    # Strip everything
    stripper.strip1 = oracle.panama.adapter.stripper.Strip1

    # Translation table for translating "&target;" entities => String
    # Does not recurse - e.g. &amp;target; will not work
    oracle.panama.adapter.stripper.Strip1.useTranslationTable = true
    oracle.panama.adapter.stripper.Strip1.targets = auml Auml aring Aring
    ouml Ouml amp Amp nbsp euml Euml #150
    oracle.panama.adapter.stripper.Strip1.targets.auml = ä
    oracle.panama.adapter.stripper.Strip1.targets.Auml = Ä
    oracle.panama.adapter.stripper.Strip1.targets.aring = å
    oracle.panama.adapter.stripper.Strip1.targets.Aring = Å
    oracle.panama.adapter.stripper.Strip1.targets.ouml = ö
    oracle.panama.adapter.stripper.Strip1.targets.Ouml = Ö
    oracle.panama.adapter.stripper.Strip1.targets.amp = &
    oracle.panama.adapter.stripper.Strip1.targets.Amp = &
    oracle.panama.adapter.stripper.Strip1.targets.AMP = &
    oracle.panama.adapter.stripper.Strip1.targets.nbsp = -
    oracle.panama.adapter.stripper.Strip1.targets.euml = ë
    oracle.panama.adapter.stripper.Strip1.targets.Euml = Ë
    oracle.panama.adapter.stripper.Strip1.targets.#150 = -

## 9.24 MAgent.properties

The Magent.properties file on both the client and server side points to an instance's classes and port. Users can have any number of instances but each instance's information is stored in a separate property file.

This file is in the WE_HOME/server/classes/oracle/panama/config directory.

Table 9-25 Parameters of the MAgent.properties File

Key | Type | Editable |
--- | --- | --- | ---
magent.server.host | Host Name | Y | This is the server host name.
magent.server.port | Integer | Y | This is the service port number. This port number should match the port number used by the RMI Server listed in RMI.properties. The default is 2080.
magent.server.name | String | Y | The service name. The default is Magent.

## 9.25 MInstances.properties

Every database instance needs an <instance name > = <property file name> entry added to the MInstances.properties.

This file is in the WE_HOME/server/classes/oracle/panama/config directory.

The RMI client uses this information to talk to the corresponding server. Each instance is monitored using a Magent.properties file which contains the Wireless Edition server host name, port, and service name. In the case of multiple instances, these are identified by these values. The Minstances.properties file should point the instance name to the corresponding Magent.properties file. For example, for two instances:

    PTG1=oracle.panama.magent.config.Magent1
    PTG2=oracle.panama.magent.config.Magent2

## 9.26 Cookies.properties

This property file enables Wireless Edition to use cookies and sets the duration of the login session.

This file is in the WE_HOME/server/classes/oracle/panama/core/admin directory.

Table 9-26 Parameters of the Cookies.properties File

Key | Type | Editable | Description
--- | --- | --- | ---
cookie.use.userinfo | Boolean | Y | When true, this parameter instructs the system to use cookies when talking to clients that have cookie support. The default is true.
cookie.userinfo.maxage | Integer | Y | Duration of a session, in seconds, in which the user is not required to re-enter a user name or password. The default is 86400.

| Copyright © 2001 Oracle Corporation. All Rights Reserved. |
Library | Service | Contents | Index