Oracle9i
Application Server Wireless Edition Configuration Guide
Release 1.1 Part Number A86701_02 |
|
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:
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. |
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
10-2 Parameters for the System.properties File
Key | Type | Editable | Description |
---|---|---|---|
version |
String |
N |
Wireless Edition version. |
instance.identifier |
String |
Y |
Wireless Edition server instance identifier. Must 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 |
Log level. Can contain any of the following: error, warning, notify, or transaction. The default is "warning, error, notify". |
log.directory |
Path |
Y |
Log file directory. |
log.file.name |
File name |
Y |
Log file name pattern. The default is sys_panama.log. |
log.file.maxsize |
Integer |
Y |
Maximum number of log records in the same file. The default is 1000. |
log.tx.directory |
Path |
Y |
Transaction log file directory. The default is /tmp. |
log.tx.file.name |
File name |
Y |
Transaction log file name pattern. The default is tx.panama.log. |
log.tx.file.maxsize |
Integer |
Y |
Maximum number of transaction entries in the same file. The default is 1000. |
log.tx.file.pattern |
Formatted string |
Y |
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 |
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 if true log output is written to stderr. The default is false. |
algorithm.password |
Java algorithm name |
Y |
Hash algorithm for passwords. The default is SHA-1. |
locator.external.hook.class |
Class name |
Y |
Default implementation of UserAuthenticationHook. The default is oracle.panama.core.PanamaExternalHookDefImpl. |
locator.useragent.class |
Class name |
Y |
Default implementation of the device recognition class. The default is oracle.panama.core.xform.UserAgentImpl. |
locator.request.daemon .classes |
Class name list |
Y |
System daemons to start. See System.properties file for options. |
locator.request.queue.class |
Class name |
N |
Asynchronous request queue implementation. The default is oracle.panama.core.rdbms.AsynchNotificationQueueImpl. |
locator.notification.queue.class |
Class name |
N |
Asynchronous notification queue implementation. The default is oracle.panama.util.NotificationDispatcherImpl. |
locator.notification.dispatcher.class |
Class name |
Y |
Default notification engine implementation. Default is oracle.panama.util.NotificationDispatcherImpl. |
locator.postprocessor.class |
Class name |
N |
Transformer post-processor implementation. The default is oracle.panama.core.xform.PostProcessor. |
locator.provisioning.class |
Class name |
Y |
TDefault implementation of the provisioning hook. The default is oracle.panama.core.util.ProvisioningHookImpl. |
locator.folder.renderer.hook.class |
Class Name |
Y |
Hook for a folder renderer. The default value is oracle.panama.rt.common.FolderRenderer. |
locator.home.folder.sorter.hook.
|
String |
Y |
Value 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 |
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.
|
Class Name |
Y |
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 |
|
Y |
Declares the hook for user service authorization. The default is oracle.panama.rt.common.Authorizer. |
locator.device.identification.hook.
|
|
Y |
Declares the hook for identifying a logical device. The default is oracle.panama.rt.hook.DeviceModels. |
locator.service.visibility.hook.class |
|
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 |
|
Y |
Declares the hook for generating the session ID. The default is oracle.panama.rt.common.SessionIdGenerator. |
locator.listener.registration.hook.
|
|
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.
|
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.
|
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 |
JDBC connect string for logging to a second database. |
|
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 |
URL StreamHandlerFactory used to create URLs. The default value is oracle.panama.core.util.URLStreamHandlerFactoryImpl. |
folder.subfolder.pagesize |
String |
Y |
Control number of services to be displayed under a folder at any one time. |
folder.subfolder.nextlabel |
String |
Y |
Label used to link the next set of folder.subfolder.pagesize services if the folder.subfolder.pagesize property is set. |
This file provides basic configuration for the notification
engine.
This file is in the WE_HOME/server/classes/oracle/panama/core/admin directory.
Table 10-3 Parameters of the Notification.properties File
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 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 10-4 Parameters of the Rmi.properties File
Key | Type | Editable | Description |
---|---|---|---|
rmi.server.port |
Integer |
Y |
TCP port on which the daemon listens. The default is 2008. |
rmi.server.name |
String |
Y |
Name of the RMI server. The default is PanamaServer. |
The implementation is managed by the daemon:
oracle.panama.core.rmi.server.ServerImpl
Asynchronous notification of error information is provided
using the event framework provided by 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 10-5 Parameters of the oemevents.properties File
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. |
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:
This file is in the WE_HOME/server/classes/oracle/panama/core/admin
directory.
The Ftp.properties file has the following parameters:
Table 10-6 Parameters of the Ftp.properties File
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 Wireless Edition to render geocoding services from a third-party provider:
The probe is a daemon that displays runtime information about:
The probe performs simple runtime management including:
By default, 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:
This file is in the WE_HOME/server/classes/oracle/panama/core/probe
directory.
The www-server.properties file has the following parameters:
Table 10-8 Parameters of the www-server.properties File
The following daemon manages the implementation:
oracle.panama.core.probe.WebServer
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 10-9 Parameters of the Provisoning.properties File
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 10-10 Parameters of the UserAgents.properties File
This property file is read by the LDAP adapter. It is in the WE_HOME/server/classes/oracle/panama/adapter/ldap directory.
Table 10-11 Parameters of the LDAP.properties File
This is the property file read by the asynchronous notification Dequeuer. It is in the WE_HOME/server/classes/oracle/panama/core/admin directory.
Table 10-12 Parameters of the AsynchNotification.properties File
This is the property file read by the asynchronous request Dequeuer. It is in the WE_HOME/server/classes/oracle/panama/core/admin directory.
Table 10-13 Parameters of the AsynchRequest.properties File
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 10-14 Parameters of the EncodingSets.properties File
Key | Description |
---|---|
[ID].iananame |
IANA name for the encoding set. |
[ID].javaname |
Corresponding Java name for the encoding set. |
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
is 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 10-15 Parameters of the LocationMark.properties File
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 10-16 Parameters of the ProxyFirewall.properties File
This is the properties file for the email adapter. It is in the WE_HOME/server/classes/oracle/panama/adapter/mail directory.
Table 10-17 Parameters of the MailAdapter.properties File
This property file is read by the master instance when the Multiple Virtual Machine option is used. It is in the WE_HOME/server/classes/oracle/panama/master directory.
Table 10-18 Parameters of the Master.properties File
This XML file specifies the automatic positioning capability provider. It is in the WE_HOME/server/classes/oracle/panama/mp directory.
Table 10-19 Parameters of the positioner.xml File
Key | Description |
---|---|
ProviderName |
Provider name. |
ProviderImpl |
Class that implements the provider. |
the rest |
Additional arguments read by the provider. |
This XML file specifies the geocoding provider's preference in descending order. It is in the WE_HOME/server/classes/oracle/panama/spatial/geocoder directory.
Table 10-20 Parameters of the Geocoders.xml File
Key | Description |
---|---|
ProviderName |
Provider name. |
ProviderImpl |
Class that implements the provider. |
the rest |
Additional arguments read by the provider. |
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. It is in the WE_HOME/server/classes/oracle/panama/spatial/mapper directory.
Table 10-21 Parameters of the mappers.xml File
Key | Description |
---|---|
ProviderName |
Provider name. |
ProviderImpl |
Class that implements the provider. |
the rest |
Additional arguments read by the provider. |
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. It is in the WE_HOME/server/classes/oracle/panama/spatial/region directory.
Table 10-22 Parameters of the routers.xml File
Key | Description |
---|---|
ProviderName |
Provider name. |
ProviderImpl |
Class that implements the provider. |
the rest |
Additional arguments read by the provider. |
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. It in the WE_HOME/server/classes/oracle/panama/adapter/stripper directory.
Table 10-23 Parameters of the Strip.properties File
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 10-24 Strip Processing Classes
Level | Description | Implementing Class |
---|---|---|
0 |
Retains all tags in the content. |
Strip0 |
1 |
Strips all tags from the content. |
Strip1 |
# 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 "⌖" entities => String # Does not recurse - e.g. ⌖ 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 = -
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 10-25 Parameters of the MAgent.properties File
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
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 10-26 Parameters of the Cookies.properties File
|
Copyright © 2001 Oracle Corporation. All Rights Reserved. |
|