B
Service Configuration Properties

This appendix provides information on the Oracle 9iFS service configuration properties. For information regarding the properties you are required to set, refer to Chapter 5, "Service and Server Configuration". Topics include:

• The Service Configuration Properties

• Oracle9i Database/JDBC

• Service

• Service Data Cache

• Writeable Connection Pool

• Read-Only Connection Pool

• Directory Service

• Session

• Session Object Cache

• Tracing

• NLS

The Service Configuration Properties

The following sections describe each service configuration property, including the default values of each property if omitted from a service configuration object or service configuration file.

Oracle9i Database/JDBC

• IFS.SERVICE.JDBC.Schema
The name of the 9iFS database schema. Required.

• IFS.SERVICE.JDBC.DatabaseUrl
The JDBC database URL of the database instance containing the Oracle 9iFS schema. Refer to Oracle9i JDBC Developer's Guide and Reference for syntax and examples. Required.

• IFS.SERVICE.JDBC.TracingEnabled
Whether JDBC debug information will be printed to the standard output stream. Optional; defaults to false.

• IFS.SERVICE.JDBC.DefaultRowPrefetch
The number of result set rows prefetched from the database by the JDBC driver. Optional; if unspecified or set to 0, a value of 10 rows is used.

Service

• IFS.SERVICE.MaximumConcurrentSessions
The maximum number of sessions that can be concurrently hosted by the service. Unlimited if set to 0. Optional; defaults to 0.

• IFS.SERVICE.CheckForOrphanSessionsPeriod
The period, in seconds, between successive checks for orphan sessions. An orphan session is a session that has ceased to have a session "heartbeat" (automatically generated by healthy sessions). Upon detecting an orphan session, the service disconnects it and releases its resources. A value of 0 disables orphan session detection. Optional; defaults to 60.

• IFS.SERVICE.SessionOperationTimeoutPeriod
The period, in seconds, after which certain Oracle 9iFS API calls are terminated, even if incomplete. If an operation times out in this manner, it is terminated, its transaction is aborted, and an exception is thrown. The session performing the operation remains valid. A value of 0 disables session operation timeouts. Optional; defaults to 300.

• IFS.SERVICE.OrphanSessionTimeoutPeriod
The period, in seconds, after which a session that has ceased to have a session "heartbeat" becomes an orphan session. Upon detecting an orphan session, the service disconnects it and releases its resources. A value of 0 disables orphan session timeouts. Optional; defaults to 600.

• IFS.SERVICE.ServiceKeepAliveEventPeriod
The period, in seconds, between successive service "heartbeats." The Service Watchdog Agent detects services that cease to have a heartbeat, and cleans up information associated with the failed service in the Oracle 9iFS repository. A value of 0 disables the service heartbeat. Optional; defaults to 60.

• IFS.SERVICE.PollForEventsFromOtherServicesPeriod
The period, in seconds, between successive checks by the service for incoming events from other services. A value of 0 disables inter-service event processing. Optional; defaults to 2.

• IFS.SERVICE.TransportEventsToOtherServicesPeriod
The maximum period, in seconds, that the service buffers outgoing events before sending them to other services. A value of 0 disables buffering of outgoing events. Optional; defaults to 2.

Service Data Cache

• IFS.SERVICE.DATACACHE.Size
The absolute maximum size of the service's data cache, in LIBRARYOBJECTs. The service data cache holds the attribute values of recently used LIBRARYOBJECTs. Optional; defaults to 7500.

• IFS.SERVICE.DATACACHE.NormalTrigger
The cache size, in LIBRARYOBJECTs, at which the service data cache schedules a low-priority purge of data that has not been recently used. Optional; defaults to 5000.

• IFS.SERVICE.DATACACHE.UrgentTrigger
The cache size, in LIBRARYOBJECTs, at which the service data cache schedules a high-priority purge of data that has not been recently used. Must be greater than IFS.SERVICE.DATACACHE.NormalTrigger. Optional; defaults to 5500.

• IFS.SERVICE.DATACACHE.EmergencyTrigger
The cache size, in LIBRARYOBJECTs, at which the service data cache performs an immediate purge of data that has not been recently used. Must be greater than IFS.SERVICE.DATACACHE.UrgentTrigger but less than IFS.SERVICE.DATACACHE.Size. Optional; defaults to 6000.

• IFS.SERVICE.DATACACHE.PurgeTarget
The target cache size, in LIBRARYOBJECTs, upon completion of a purge cycle. Must be less than IFS.SERVICE.DATACACHE.NormalTrigger. Optional; defaults to 4000.

Service ACL Cache

• IFS.SERVICE.ACLCACHE.Size
The absolute maximum size of the service's ACL cache, in LIBRARYOBJECTs. The service ACL cache holds the attribute values of recently used LIBRARYOBJECTs. Optional; defaults to 750.

• IFS.SERVICE.ACLCACHE.NormalTrigger
The cache size, in LIBRARYOBJECTs, at which the service ACL cache schedules a low-priority purge of data that has not been recently used. Optional; defaults to 500.

• IFS.SERVICE.ACLCACHE.UrgentTrigger
The cache size, in LIBRARYOBJECTs, at which the service ACL cache schedules a high-priority purge of data that has not been recently used. Must be greater than IFS.SERVICE.DATACACHE.NormalTrigger. Optional; defaults to 550.

• IFS.SERVICE.ACLCACHE.EmergencyTrigger
The cache size, in LIBRARYOBJECTs, at which the service ACL cache performs an immediate purge of data that has not been recently used. Must be greater than IFS.SERVICE.DACLCACHE.UrgentTrigger but less than IFS.SERVICE.ACLCACHE.Size. Optional; defaults to 600.

• IFS.SERVICE.ACLCACHE.PurgeTarget
The target cache size, in LIBRARYOBJECTs, upon completion of a purge cycle. Must be less than IFS.SERVICE.ACLCACHE.NormalTrigger. Optional; defaults to 400.

Writeable Connection Pool

• IFS.SERVICE.CONNECTIONPOOL.WRITEABLE.MinimumSize
The initial number of database connections in the writeable connection pool. Optional; defaults to 2.

• IFS.SERVICE.CONNECTIONPOOL.WRITEABLE.TargetSize
The target maximum number of database connections in the writeable connection pool. Must be greater than or equal to IFS.SERVICE.CONNECTIONPOOL.WRITEABLE.MinimumSize. Optional; defaults to 5.

• IFS.SERVICE.CONNECTIONPOOL.WRITEABLE.MaximumSize
The absolute maximum number of database connections in the writeable connection pool. Must be greater than or equal to IFS.SERVICE.CONNECTIONPOOL.WRITEABLE.TargetSize. Optional; defaults to 10.

• IFS.SERVICE.CONNECTIONPOOL.WRITEABLE.TargetSizeTimeout
The maximum period, in milliseconds, that the service will postpone a connection allocation request when there are no unallocated connections, if the current size of the writeable connection pool is greater than or equal to its target size but less than the maximum size. If a database connection does not become available within this period, a new connection will be created. Optional; defaults to 1000.

• IFS.SERVICE.CONNECTIONPOOL.WRITEABLE.MaximumSizeTimeout
The maximum period, in milliseconds, that a service will postpone a connection allocation request when there are no unallocated connections, if the current size of the writeable connection pool is equal to its maximum size. If a database connection does not become available within this period, the allocation request will fail and an exception will be thrown. Optional; defaults to 10000.

Read-Only Connection Pool

• IFS.SERVICE.CONNECTIONPOOL.READONLY.MinimumSize
The initial number of database connections in the read-only connection pool. Optional; defaults to 2.

• IFS.SERVICE.CONNECTIONPOOL.READONLY.TargetSize
The target maximum number of database connections in the read-only connection pool. Must be greater than or equal to IFS.SERVICE.CONNECTIONPOOL.READONLY.MinimumSize. Optional; defaults to 5.

• IFS.SERVICE.CONNECTIONPOOL.READONLY.MaximumSize
The absolute maximum number of database connections in the read-only connection pool. Must be greater than or equal to IFS.SERVICE.CONNECTIONPOOL.READONLY.TargetSize. Optional; defaults to 10.

• IFS.SERVICE.CONNECTIONPOOL.READONLY.TargetSizeTimeout
The maximum period, in milliseconds, that the service will postpone a connection allocation request when there are no unallocated connections, if the current size of the read-only connection pool is greater than or equal to its target size but less than the maximum size. If a database connection does not become available within this period, a new connection will be created. Optional; defaults to 1000.

• IFS.SERVICE.CONNECTIONPOOL.READONLY.MaximumSizeTimeout
The maximum period, in milliseconds, that a service will postpone a connection allocation request when there are no unallocated connections, if the current size of the read-only connection pool is equal to its maximum size. If a database connection does not become available within this period, the allocation request will fail and an exception will be thrown. Optional; defaults to 10000.

Directory Service

• IFS.SERVICE.CaseSensitiveAuthentication

  Whether, in performing authentication, user names and passwords are case sensitive. Optional; defaults to true.

• IFS.SERVICE.CREDENTIALMANAGER.Names

  The names of the credential managers used by this service. (Comma-delimited for service configuration files.) Required.

Oracle 9iFS Credential Manager

• IFS.SERVICE.CREDENTIALMANAGER.Ifs.Classname

  The fully qualified Java classname of the default Oracle 9iFS credential manager. Required.

• IFS.SERVICE.CREDENTIALMANAGER.Ifs.Schema

  The credential manager schema name for the default Oracle 9iFS credential manager. Required.

• IFS.SERVICE.CREDENTIALMANAGER.Ifs.RdbmsUserMustExist

  Whether, to authenticate using the default Oracle 9iFS credential manager, a user must also be a database user in the database instance used by Oracle 9iFS. Optional; defaults to false.

• IFS.SERVICE.CREDENTIALMANAGER.Ifs.AcceptCleartextCredential

  Whether the default Oracle 9iFS credential manager allows authentication by clear-text username and password. Optional; defaults to false.

• IFS.SERVICE.CREDENTIALMANAGER.Ifs.AcceptChallengeResponse
Credential

  Whether the default Oracle 9iFS credential manager allows SMB challenge/response authentication. Optional; defaults to false.

• IFS.SERVICE.CREDENTIALMANAGER.Ifs.AcceptHttpDigestCredential

  Whether the default Oracle 9iFS credential manager allows HTTP 1.1 Message Digest challenge/response authentication. Optional; defaults to false.

• IFS.SERVICE.CREDENTIALMANAGER.Ifs.AcceptTokenCredential

  Whether the default Oracle 9iFS credential manager allows authentication using token credentials. Optional; defaults to false.

• IFS.SERVICE.CREDENTIALMANAGER.CredentialNameTokenizer

  The fully qualified classname of the CredentialNameTokenizer. Optional; defaults to oracle.ifs.common.IfsCredentialNameTokenizer.

Oracle Internet Directory Credential Manager

• IFS.SERVICE.CREDENTIALMANAGER.Oid.OidUrl

  The LDAP URL of the Oracle Internet Directory instance. Required. Name is the administrator-specified name of the Oracle Internet Directory credential manager, which defaults to Oid.

• IFS.SERVICE.CREDENTIALMANAGER.Oid.Ssl

  Whether the Oracle Internet Directory connection uses SSL security. Optional. Defaults to false.

• IFS.SERVICE.CREDENTIALMANAGER.Oid.OidRootOracleContext

  The distinguished name of the Root Oracle Context. Required.

• IFS.SERVICE.CREDENTIALMANAGER.Oid.OidApplicationEntityName

  The name of the application entity used by the CredentialManager to connect to Oracle Internet Directory. Required.

• IFS.SERVICE.CREDENTIALMANAGER.Oid.SupportsCreateUser

  Whether the CredentialManager allows creation of minimally defined Oracle Internet Directory users through its createUser API. Optional; defaults to false.

• IFS.SERVICE.CREDENTIALMANAGER.Oid.SupportsDeleteUser

  Whether the CredentialManager allows Oracle Internet Directory users to be deleted through its deleteUser API. Optional; defaults to false.

• IFS.SERVICE.CREDENTIALMANAGER.Oid.SupportsSetPassword

  Whether the CredentialManager allows the SSO password of Oracle Internet Directory users to be set through its setPassword API. Optional; defaults to false.

• IFS.SERVICE.CREDENTIALMANAGER.Oid.SupportsListUsers

  Whether the CredentialManager allows a list of Oracle Internet Directory users to be generated through its listUser API. Optional; defaults to false.

• IFS.SERVICE.CREDENTIALMANAGER.Oid.AcceptCleartextCredential

  Whether the CredentialManager allows authentication by cleartext username and password. Optional; defaults to false.

• IFS.SERVICE.CREDENTIALMANAGER.Oid.AcceptChallengeResponse
Credential

  Whether the CredentialManager allows SMB challenge/response authentication. Optional; defaults to false.

• IFS.SERVICE.CREDENTIALMANAGER.Oid.AcceptHttpDigestCredential

  Whether the CredentialManager allows HTTP 1.1 Message Digest challenge/response authentication. Optional; defaults to false.

• IFS.SERVICE.CREDENTIALMANAGER.Oid.AcceptTokenCredential

  Whether the CredentialManager allows authentication using token credentials. Optional; defaults to false.

• IFS.SERVICE.CREDENTIALMANAGER.Oid.Subscribers

  The names of the Oracle Internet subscribers that are enabled for use with Oracle 9iFS. Required. (Comma-delimited for Service configuration files.)

• IFS.SERVICE.CREDENTIALMANAGER.Oid.IfsPasswordApplications

  The names of the applications that authenticate using users' Oracle 9iFS-specific passwords instead of their SSO passwords. The application names are those specified in the ConnectOptions argument in creating an Oracle 9iFS session. Optional; defaults to null. (Comma-delimited for Service configuration files.)

Session

• IFS.SERVICE.SESSION.TransactionStackSize
The maximum number of nested transactions by the session. Optional; defaults to 100.

• IFS.SERVICE.SESSION.EventPoller
The event poller used by a session to generate the session's "heartbeat." Must be either oracle.ifs.beans.LibrarySessionEventPollerThreadPerProcess (recommended) or oracle.ifs.beans.LibrarySessionEventPollerThreadPerSession. Optional; defaults to oracle.ifs.beans.LibrarySessionEventPollerThreadPerSession.

• IFS.SERVICE.SESSION.EventPollerPeriod
The period, in milliseconds, of the session's "heartbeat." In addition to indicating the session's health to the service, the heartbeat allows an idle session to process events generated by other sessions or services. Optional; defaults to 2500.

• IFS.SERVICE.SESSION.DefaultSearchTimeoutPeriod
The period, in seconds, after which a search API call is terminated, even if incomplete. If a search times out in this manner, it is terminated and an exception is thrown. The session performing the search remains valid. A value of 0 disables search timeouts. Optional; defaults to 60.

• IFS.SERVICE.SESSION.FOLDERPATHCACHE.Enabled
Whether the session caches the resolution of folder paths. Optional; defaults to true.

• IFS.SERVICE.SESSION.FOLDERPATHCACHE.Size
The absolute maximum size of the session's folder path cache, in cached folder paths. Optional; defaults to 150.

• IFS.SERVICE.SESSION.FOLDERPATHCACHE.NormalTrigger
The cache size, in folder paths, at which the session's folder path cache schedules a low-priority purge of data that has not been recently used. Optional; defaults to 100.

• IFS.SERVICE.SESSION.FOLDERPATHCACHE.UrgentTrigger
The cache size, in folder paths, at which the session's folder path cache schedules a high-priority purge of data that has not been recently used. Must be greater than IFS.SERVICE.SESSION.FOLDERPATHCACHE.NormalTrigger and less than IFS.SERVICE.SESSION.FOLDERPATHCACHE.Size. Optional; defaults to 110.

• IFS.SERVICE.SESSION.FOLDERPATHCACHE.PurgeTarget
The target cache size, in folder paths, upon completion of a purge cycle. Must be less than IFS.SERVICE.SESSION.FOLDERPATHCACHE.NormalTrigger. Optional; defaults to 80.

Session Object Cache

• IFS.SERVICE.SESSION.SERVEROBJECTCACHE.IsUnbounded
Whether the session object caches are unbounded in size. The session object caches hold references to LIBRARYOBJECTs discovered by the session. For Java 1.1, the session object caches are always unbounded, regardless of this value. Optional; defaults to false.

• IFS.SERVICE.SESSION.BEANSOBJECTCACHE.Size
The target maximum size of the "bean-side" session object cache, in LIBRARYOBJECTs. The bean-side session object cache holds instances of oracle.ifs.beans.LibraryObject. If IFS.SERVICE.SESSION.SERVEROBJECTCACHE.IsUnbounded is false, this value is ignored and implicitly equal to IFS.SERVICE.SESSION.SERVEROBJECTCACHE.Size. Optional; defaults to 750.

• IFS.SERVICE.SESSION.SERVEROBJECTCACHE.Size
The absolute maximum size of the "server-side" session object cache, in LIBRARYOBJECTs. The server-side session object cache holds instances of oracle.ifs.server.S_LibraryObject. Not enforced if IFS.SERVICE.SESSION.SERVEROBJECTCACHE.IsUnbounded is true. Optional; defaults to 750.

• IFS.SERVICE.SESSION.SERVEROBJECTCACHE.NormalTrigger
The cache size, in LIBRARYOBJECTs, at which the session data caches schedule a low-priority purge of data that has not been recently used. Ignored if IFS.SERVICE.SESSION.SERVEROBJECTCACHE.IsUnbounded is true. Optional; defaults to 500.

• IFS.SERVICE.SESSION.SERVEROBJECTCACHE.UrgentTrigger
The cache size, in LIBRARYOBJECTs, at which the session data caches schedule a high-priority purge of data that has not been recently used. Ignored if IFS.SERVICE.SESSION.SERVEROBJECTCACHE.IsUnbounded is true. Must be greater than IFS.SERVICE.SESSION.SERVEROBJECTCACHE.NormalTrigger. Optional; defaults to 550.

• IFS.SERVICE.SESSION.SERVEROBJECTCACHE.EmergencyTrigger
The cache size, in LIBRARYOBJECTs, at which the session data caches perform an immediate purge of data that has not been recently used. Ignored if IFS.SERVICE.SESSION.SERVEROBJECTCACHE.IsUnbounded is true. Must be greater than IFS.SERVICE.SESSION.SERVEROBJECTCACHE.UrgentTrigger but less than IFS.SERVICE.SESSION.SERVEROBJECTCACHE.Size. Optional; defaults to 600.

• IFS.SERVICE.SESSION.SERVEROBJECTCACHE.PurgeTarget
The target cache size, in LIBRARYOBJECTs, upon completion of a purge cycle. Ignored if IFS.SERVICE.SESSION.SERVEROBJECTCACHE.IsUnbounded is true. Must be less than SERVICE.SESSION.SERVEROBJECTCACHE.NormalTrigger. Optional; defaults to 400.

Tracing

• IFS.SERVICE.TRACING.ChannelCount
The number of trace logger channels. Oracle reserves channels 0 to TraceLogger.LAST_RESERVED_CHANNEL. Refer to the Javadoc for class oracle.ifs.common.TraceLogger for a list of Oracle-defined channels. Optional; defaults to 50.

• IFS.SERVICE.TRACING.ServiceTraceType
The destination of trace data generated by a service. Must be TRACETYPE_NONE (disabled) or TRACETYPE_LOCAL (writes to a file on the local file system). Optional; defaults to TRACETYPE_NONE.

• IFS.SERVICE.TRACING.ServerSessionTraceType
The destination of trace data generated by a server-side session. Must be TRACETYPE_NONE (disabled), TRACETYPE_LOCAL (writes to a file on the local file system), TRACETYPE_REMOTE (routes to the service's trace logger), or TRACETYPE_BOTH (writes to a file on the local file system and routes to the service's trace logger). Optional; defaults to TRACETYPE_NONE.

• IFS.SERVICE.TRACING.BeansSessionTraceType
The destination of trace data generated by a bean-side session. Must be TRACETYPE_NONE (disabled), TRACETYPE_LOCAL (writes to a file on the local file system), TRACETYPE_REMOTE (routes to the server-side session's trace logger), or TRACETYPE_BOTH (writes to a file on the local file system and routes to the server-side session's trace logger). Optional; defaults to TRACETYPE_NONE.

• IFS.SERVICE.TRACING.TraceLevelChanneln
The tracing verbosity for trace channel n. Refer to the Javadoc for class oracle.ifs.common.TraceLogger for a list Oracle-defined trace levels.

• IFS.SERVICE.TRACING.DefaultTraceLevel
The default tracing verbosity for all trace channels. Refer to the Javadoc for class oracle.ifs.common.TraceLogger for a list Oracle-defined trace levels.

NLS

• IFS.SERVICE.DefaultCharacterSet
The default character set, in IANA format, for sessions hosted by this service. Can be overridden on a per-session basis. Provides the default character set for text documents created by the session (if not explicitly specified in creating a document). Optional; defaults to the character set of the database instance.

• IFS.SERVICE.DefaultLanguage
The default language, as an Oracle language name, for sessions hosted by this service. Can be overridden on a per-session basis. Provides the default language for text documents created by the session (if not explicitly specified in creating a document and if the language cannot be determined from the document's character set). Also provides the default language for content-based searches (if not explicitly specified in performing the search). Optional; defaults to null ("unspecified").