Skip Headers

Oracle Files Administration Guide
9.0.3

Part Number A97358-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Feedback

Go to previous page
Previous
Go to next page
Next
View PDF

B
Service Configuration Reference

An Oracle Files service comprises a Java runtime environment for the protocol servers and agents that it supports. A service also manages connections to the database through JDBC. There are three default service configuration objects you can use to create new services on nodes:

The differences among the three configuration templates is in the number of connections and sessions supported.

Table B-1 IFS.SERVICE.* Properties
Property Description and Usage Note Default Required?

IFS.SERVICE.DefaultCharacterSet

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).

Character set of the database instance

ISO-8859-1

No

IFS.SERVICE.DefaultLanguage

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).

Based on configuration.

No

IFS.SERVICE.MaximumConcurrentSessions

Maximum number of sessions the service can support concurrently. Default of 0 means unlimited.

0

No

IFS.SERVICE.
MaximumConcurrentSessionsPerUser

Maximum number of sessions per user the service can support. Default of 0 means unlimited. If set to other than 0 and maximum is exceeded, service throws IFS-20132 error.

0

No

IFS.SERVICE.
CheckForOrphanSessionsPeriod

Number of seconds between which the service checks for orphan sessions. (Active sessions generate heartbeats. An orphan session is one that no longer generates session heartbeats. When the service detects an orphan session, it disconnects the session and releases the session's resources.) Default is 60 seconds between heartbeats. Set to 0 to disable the checking.

60

No

IFS.SERVICE.
SessionOperationTimeoutPeriod

Number of seconds after which certain Oracle Files 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. Set to 0 to disable session operation timeout period.

300

No

IFS.SERVICE.
OrphanSessionTimeoutPeriod

Number of seconds after which a session that no longer generates a heartbeat becomes an orphan. Set to 0 to disable orphan session timeout period.

600

No

IFS.SERVICE.
ServiceKeepAliveEventPeriod

Seconds between 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 Files repository.

Set to 0 to disable heartbeat.

60

No

IFS.SERVICE.
PollForEventsFromOtherServicesPeriod

Seconds between checks for incoming events from other services. Set to 0 to disable inter-service event polling.

2

No

IFS.SERVICE.
TransportEventsToOtherServicesPeriod

Length of time (seconds) for which outgoing events are buffered before sending. Set to 0 to disable outgonig event buffer.

2

No

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.

7500 - Small

30000 - Medium

75000 - Large

No

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.

5000 - Small

20000 - Medium

50000 - Large

No

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.

5500 - Small

22000 - Medium

55000 - Large

No

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.Urgent
Trigger but less than IFS.SERVICE.DATACACHE.Size.

6000 - Small

24000 - Medium

60000 - Large

No

IFS.SERVICE.DATACACHE.PurgeTarget

The target cache size, in LIBRARYOBJECTs, upon completion of a purge cycle. Must be less than IFS.SERVICE.DATACACHE.Normal
Trigger.

4000 - Small

16000 - Medium

40000 - Large

No

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.

750 - Small

3000 - Medium

7500 - Large

No

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.

500 - Small

2000 - Medium

5000 - Large

No

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.Normal
Trigger.

550 - Small

2200 - Medium

5500 - Large

No

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.Urgent
Trigger but less than IFS.SERVICE.ACLCACHE.Size.

600 - Small

2400 - Medium

6000 - Large

No

IFS.SERVICE.ACLCACHE.PurgeTarget

The target cache size, in LIBRARYOBJECTs, upon completion of a purge cycle. Must be less than IFS.SERVICE.ACLCACHE.Normal
Trigger.

400 - Small

1600 - Medium

4000 - Large

No

IFS.SERVICE.CONNECTIONPOOL.
WRITEABLE.MinimumSize

The initial number of database connections in the writeable connection pool.

2 - Small

4 - Medium

6 - Large

No

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.

10 - Small

20 - Medium

30 - Large

No

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.

20 - Small

40 - Medium

60 - Large

No

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.

1000

No

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.

10000

No

IFS.SERVICE.CONNECTIONPOOL.
READONLY.MinimumSize

The initial number of database connections in the read-only connection pool.

2 - Small

4 - Medium

6 - Large

No

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.

10 - Small

20 - Medium

30 - Large

No

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.

20 - Small

40 - Medium

60 - Large

No

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.

1000

No

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.

10000

No

IFS.SERVICE.CaseSensitiveAuthentication

Whether, in performing authentication, user names and passwords are case sensitive.

false

No

IFS.SERVICE.CREDENTIALMANAGER.Names

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

Based on configuration

Yes

IFS.SERVICE.CREDENTIALMANAGER.Ifs.
Classname

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

Based on configuration

Yes

IFS.SERVICE.CREDENTIALMANAGER.Ifs.
RdbmsUserMustExist

Whether, to authenticate using the default Oracle Files credential manager, a user must also be a database user in the database instance used by Oracle Files.

false

No

IFS.SERVICE.CREDENTIALMANAGER.Ifs.
AcceptCleartextCredential

Whether the default Oracle Files credential manager allows authentication by clear-text username and password.

false

No

IFS.SERVICE.CREDENTIALMANAGER.Ifs.
AcceptChallengeResponseCredential

Whether the default Oracle Files credential manager allows SMB challenge/response authentication.

false

No

IFS.SERVICE.CREDENTIALMANAGER.Ifs.
AcceptHttpDigestCredential

Whether the default Oracle Files credential manager allows HTTP 1.1 Message Digest challenge/response authentication.

false

No

IFS.SERVICE.CREDENTIALMANAGER.Ifs.
AcceptTokenCredential

Whether the default Oracle Files credential manager allows authentication using token credentials.

false

No

IFS.SERVICE.CREDENTIALMANAGER.
CredentialNameTokenizer

The fully qualified classname of the CredentialNameTokenizer.

oracle.ifs.common.IfsCredentialNameTokenizer

No

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.

false

No

IFS.SERVICE.CREDENTIALMANAGER.Oid.
SupportsDeleteUser

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

false

No

IFS.SERVICE.CREDENTIALMANAGER.Oid.
SupportsSetPassword

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

false

No

IFS.SERVICE.CREDENTIALMANAGER.Oid.
SupportsListUsers

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

false

No

IFS.SERVICE.CREDENTIALMANAGER.Oid.
AcceptCleartextCredential

Whether the CredentialManager allows authentication by Cleartext username and password.

false

No

IFS.SERVICE.CREDENTIALMANAGER.Oid.
AcceptChallengeResponseCredential

Whether the CredentialManager allows SMB challenge/response authentication.

false

No

IFS.SERVICE.CREDENTIALMANAGER.Oid.
AcceptHttpDigestCredential

Whether the CredentialManager allows HTTP 1.1 Message Digest challenge/response authentication.

false

No

IFS.SERVICE.CREDENTIALMANAGER.Oid.
AcceptTokenCredential

Whether the CredentialManager allows authentication using token credentials.

false

No

IFS.SERVICE.CREDENTIALMANAGER.Oid.
Subscribers

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

IFS.SERVICE.CREDENTIALMANAGER.Oid.IfsPasswordApplications

The names of the applications that authenticate using users' Oracle Files-specific passwords instead of their SSO passwords. The application names are those specified in the ConnectOptions argument in creating an Oracle Files session.

null. (Comma-delimited for configuration on Oracle Files.)

No

IFS.SERVICE.JDBC.Schema

Oracle Files database schema name. DEPRECATED.

none

No

IFS.SERVICE.JDBC.DatabaseUrl

URL of the database instance containing the Oracle Files schema JDBC connect string. See the Oracle9i JDBC Developer's Guide and Reference for syntax and examples.

<" ">

Yes

IFS.SERVICE.JDBC.DriverType

Specifies ????

oci8

IFS.SERVICE.JDBC.TracingEnabled

Prints JDBC debugging information to the standard output.

false

No

IFS.SERVICE.JDBC.DefaultRowPrefetch

Number of result set rows prefetched. If set to null or 0, prefetches 10 rows.

0

No

IFS.SERVICE.SESSION.TransactionStackSize

The maximum number of nested transactions by the session.

100

No

IFS.SERVICE.SESSION.EventPoller

The event poller used by a session to generate the session's "heartbeat." Must be either oracle.ifs.beans.LibrarySessionEvent
PollerThreadPerProcess (recommended) or oracle.ifs.beans.LibrarySessionEvent
PollerThreadPerSession.

oracle.ifs.beans.
LibrarySessionEvent
PollerThreadPerSession.

No

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.

2500

No

IFS.SERVICE.SESSION.DefaultSearchTimeout
Period

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.

60

No

IFS.SERVICE.SESSION.FOLDERPATHCACHE.Enabled

Whether the session caches the resolution of folder paths.

true

No

IFS.SERVICE.SESSION.FOLDERPATHCACHE.Size

The absolute maximum size of the session's folder path cache, in cached folder paths.

150

No

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.

100

No

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.FOLDER
PATHCACHE.NormalTrigger and less than IFS.SERVICE.SESSION.FOLDER
PATHCACHE.Size.

110

No

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.FOLDER
PATHCACHE.NormalTrigger.

80

No

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.

false

No

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.SERVER
OBJECTCACHE.IsUnbounded is false, this value is ignored and implicitly equal to IFS.SERVICE.SESSION.SERVER
OBJECTCACHE.Size.

750

No

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.SERVER
OBJECTCACHE.IsUnbounded is true.

750

No

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.SERVER
OBJECTCACHE.IsUnbounded is true.

500

No

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.SERVER
OBJECTCACHE.IsUnbounded is true. Must be greater than IFS.SERVICE.SESSION.SERVER
OBJECTCACHE.NormalTrigger.

550

No

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.SERVER
OBJECTCACHE.IsUnbounded is true. Must be greater than IFS.SERVICE.SESSION.SERVER
OBJECTCACHE.UrgentTrigger but less than IFS.SERVICE.SESSION.SERVER
OBJECTCACHE.Size.

600

No

IFS.SERVICE.SESSION.SERVEROBJECTCACHE.PurgeTarget

The target cache size, in LIBRARYOBJECTs, upon completion of a purge cycle. Ignored if IFS.SERVICE.SESSION.SERVER
OBJECTCACHE.IsUnbounded is true. Must be less than SERVICE.SESSION.SERVEROBJECT
CACHE.NormalTrigger.

400

No

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.

50

No

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).

TRACETYPE_NONE

No

IFS.SERVICE.TRACING.ServerSessionTrace
Type

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).

TRACETYPE_NONE

No

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).

TRACETYPE_NONE

No

IFS.SERVICE.TRACING.TraceLevelChanneln

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.TraceLevelChannel10

5

IFS.SERVICE.TRACING.TraceLevelChannel11

9

IFS.SERVICE.TRACING.DefaultTraceLevel

Default tracing verbosity for all trace channels. See oracle.ifs.common.TraceLogger Javadoc for a list trace levels.

IFS.SERVICE.DefaultCharacterSet

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).

Character set of the database instance

No

IFS.SERVICE.DefaultLanguage

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).

null ("unspecified")

No