Oracle Internet File System Setup and Administration Guide Release 1.1 A81197-04 |
|  |  | Index

# B
Secondary Properties

This appendix provides information on the secondary properties in the Oracle iFS service properties files. For information regarding the properties you are required to set, refer to Chapter 1, "Getting Started with Oracle iFS". Topics include:

- Oracle iFS Properties Files: An Overview

- Database Properties

- Directory Service Properties

- Read Only Connection Pool Properties

- Service Data Cache Properties

- Service Properties

- Session Properties

- Tracing Properties

- Writeable Connection Pool Properties

- National Language Support Properties

## Oracle iFS Properties Files: An Overview

This file provides properties you must set and some secondary properties you can modify if you so choose. Oracle Corporation recommends that you retain the default settings for the secondary properties. Use any text editor to set the properties in the Properties file. There are eight types of secondary properties, each described in a separate table.

- Database

- Service

- Service Data Cache

- Writeable Connection Pool

- Read Only Connection Pool

- Directory Service

- Session

- Tracing

## Database Properties

Property | Specifies | Example
--- | --- | ---
    JdbcTracing
| Whether JDBC tracing is enabled; must be either true or false. If true, JDBC trace information is sent to the standard output stream of the Oracle iFS server. Optional, defaults to false. |
    JdbcTracing=false
    DefaultRowPrefetch
| The default number of result set rows prefetched from the database by the JDBC driver. Optional, if unspecified or if set to 0, a value of 10 rows is used. |
    DefaultRowPrefetch=0
    AuroraService
| Reserved. Must be false. |
    AuroraService=false
    Driver
| The name of the JDBC driver. |
    Driver=oracle.jdbc.driver.OracleDriver
    User
| The Oracle iFS database schema. The default is `ifssys`. A different database schema can be created, in which case the user name would be the name created. |
    User=ifssys
    DatabaseUrl
| The JDBC database URL. |
    DatabaseUrl=jdbc:oracle:oci8:@

## Directory Service Properties

Property | Specifies | Example
--- | --- | ---
    CaseSensitiveAuthentication
| Whether user names and passwords are case sensitive. |
    CaseSensitiveAuthentication=false
    CredentialManagers
| The primary names of the credential managers for this service. |
    CredentialManagers=Ifs, Custom
    CredentialManager<primaryname>Accept
    TokenCredential
| Specifies whether the <primaryname> credential manager accepts token credentials. |
    CredentialManagerIfsAcceptTokenCredential=true
    CredentialManager<primaryname>RdbmsUser
    MustExit
| Specifies whether the <`primaryname`> credential manager requires an Oracle iFS user to also be a database user in order to authenticate. |
    CredentialManagerIfsRdbmsUserMustExit=false
    CredentialManager<primaryname>Classname
| The Java class name for the <primaryname> credential manager. |
    CredentialManagerIfsClassname=
    oracle.ifs.server.IfsCredentialManager
    CredentialManager<primaryname>AlternateNames
| The alternate names for the <primaryname> credential manager. |
    CredentialManagerIfsAlternateNames=IFS,
Default
    CredentialManager<primaryname>Accept
    CleartextCredential
| Whether the <primaryname> credential manager accepts clear text credentials. |
    CredentialManagerIfsAcceptCleartext
    Credential=true
    CredentialManager<primaryname>Accept
    ChallengeResponseCredential
| Whether the <primaryname> credential manager accepts challenge/response credentials. |
    CredentialManagerIfsAcceptChallengeRespo
    nseCredential=true
    CredentialManager<primaryname>Accept
    HHPDigestCredential
| Whether the <primaryname> credential manager accepts HTTP Digest credentials (used by WebDAV); optional, defaults to false. |
    CredentialManagerIfsAcceptHttpDigestCred
    ential=true
    CredentialManager<primaryname>Schema
| The name of the credential manager schema; required. |
    CredentialManagerIfsSchemaSchema=
    ifssys$cm

## Read Only Connection Pool Properties

Property | Specifies | Example
--- | --- | ---
    ReadonlyConnectionPoolMinimumSize
| The initial number of connections in the pool. Optional, defaults to 2. |
    ReadonlyConnectionPoolMinimumSize=2
    ReadonlyConnectionPoolTargetSize
| The target maximum number of connections in the pool. Must be greater than or equal to `ReadonlyConnection PoolMinimumSize`. Optional, defaults to 5. |
    ReadonlyConnectionPoolTargetSize=5
    ReadonlyConnectionPoolMaximumSize
| The absolute maximum number of connections in the pool. Must be greater than or equal to ReadonlyConnectionPool TargetSize. Optional, defaults to 10. |
    ReadonlyConnectionPoolMaximumSize=10
    ReadonlyConnectionPoolTargetSizeTimeout
| The maximum period, in milliseconds, that the Oracle iFS server will postpone a session's request for a connection if there are no unallocated connections in the pool and the current pool size is less than the target pool size. Optional, defaults to 1000. |
    ReadonlyConnectionPoolTargetSizeTime
    out=1000
    ReadonlyConnectionPoolMaximumSizeTimeout
| The maximum period, in milliseconds, that the Oracle iFS server will postpone a session's request for a connection if there are no unallocated connections in the pool and the current pool size equals or exceeds the target pool size. Optional, defaults to 10000. |
    ReadonlyConnectionPoolMaximumSizeTim
    eout=10000

## Service Data Cache Properties

Property | Specifies | Example
--- | --- | ---
    ServiceDataCacheSize
| The size of the service data cache. This value specifies the initial size of the Service Data cache, which caches the data for library objects. Optional, defaults to 7500. |
    ServiceDataCacheSize=7500
    ServiceDataCacheNormalTrigger
| The cache size at which the service data cache schedules a low-priority purge of data that has not been recently used. Should be less than ServiceDataCacheSize. Optional, defaults to 5000. |
    ServiceDataCacheNormalTrigger=5000
    ServiceDataCacheUrgentTrigger
| The cache size at which the service data cache schedules a high-priority purge of data that has not been recently used. Should be greater than ServiceDataCacheNormalTrigger but not exceed ServiceDataCacheSize. Optional, defaults to 5500. |
    ServiceDataCacheUrgentTrigger=5500
    ServiceDataCacheEmergencyTrigger
| The cache size at which the service data cache begins an immediate purge of data that has not been recently used. This value sets an absolute maximum cache size and should be greater than `ServiceDataCacheUrgent Trigger`. Optional, defaults to 6000. |
    ServiceDataCacheEmergencyTrigger=6000
    ServiceDataCachePurgeTarget
| The target cache size upon completion of a cache purge. Should be less than ServiceDataCacheNormalTrigger. Optional, defaults to 4000. |
    ServiceDataCachePurgeTarget=4000

## Service Properties

Property | Specifies | Example
--- | --- | ---
    SessionTimeoutPeriod
| The period of inactivity, in seconds, after which a session is considered idle. Optional, defaults to 600 seconds. |
    SessionTimeoutPeriod=600
    CheckForIdleSessionsPeriod
| The period, in seconds, between successive checks by the Oracle iFS server for idle sessions. A value of 0 disables checking for idle sessions. Optional; defaults to 60 seconds. |
    CheckForIdleSessionsPeriod=60
    PollForEventsFromOtherServicesPeriod
| The period, in seconds, between successive checks by an Oracle iFS server process for events from other Oracle iFS server processes. Specifying 0 disables inter-process event processing. Optional, defaults to 2 seconds. |
    PollForEventsFromOtherServicesPeriod=2
    TransportEventsToOtherServicesPeriod
| The maximum period, in seconds, that outgoing events are buffered by the originating Oracle iFS server process before being made available to other Oracle iFS server processes. Specifying 0 disables outgoing event buffering. Optional, defaults to 2 seconds. |
    TransportEventsToOtherServices
    Period=2
    ServiceKeepAliveEventPeriod
| The period, in seconds, between succesive service keep-alive events for a `S_LibraryService`. Defaults to 60 seconds; if 0, service keep-alive events are disabled. |
    ServiceKeepAliveEventPeriod=60

## Session Properties

Property | Specifies | Example
--- | --- | ---
    SessionObjectCacheSize
| Target size of the session object cache in the client process. Optional; defaults to 20000. |
    SessionObjectCacheSize=20000
    SSessionObjectCacheSize
| Target size of the session object cache in the server process. Optional; defaults to 20000. |
    SSessionObjectCacheSize=20000
    TransactionStackSize
| Maximum number of concurrent nested transactions per session. Optional, defaults to 100 |
    TransactionStackSize=100
    EventPollerPeriod
| Period, in milliseconds, between successive event heartbeats. Optional, defaults to 2500 milliseconds. |
    EventPollerPeriod=2500
    FolderPathCacheEnabled
| Indicates whether Oracle iFS caches the resolution of folder path strings. Optional, defaults to `true`. |
    FolderPathCacheEnabled=true
    FolderPathCacheSize
| How many resolved folder paths are cached when folder path caching is enabled. Should be 150% of FolderPathCacheNormal Trigger. Optional, defaults to `150`. |
    FolderPathCacheSize=150
    FolderPathCacheNormalTrigger
| The folder path cache size at which a low-priority purge is scheduled. Optional, defaults to `100`. |
    FolderPathCacheNormalTrigger=100
    FolderPathCacheUrgentTrigger
| The folder path cache size at which a high-priority purge is scheduled. Should be 110% of FolderPathCacheNormal Trigger. Optional, defaults to `110`. |
    FolderPathCacheUrgentTrigger=110
    FolderPathCachePurgeTarget
| Target folder path cache size upon completion of a purge. Should be 80% of FolderPathCacheNormal Trigger. Optional, defaults to `80`. |
    FolderPathCachePurgeTarget=80

## Tracing Properties

Property | Specifies | Example
--- | --- | ---
    TraceLoggerChannelCount
| Number of trace logger channels. Oracle iFS reserves channels 0 to `TraceLogger.LAST_RESERVED_CHANNEL` for internal use. Optional, defaults to 20. |
    TraceLoggerChannelCount=20
    SSessionTraceLoggerTraceType
| The destination of trace data generated by a session in the client process. Optional, defaults to `TRACETYPE_NONE`. |
    SSessionTraceLoggerTraceType=TRACETYPE_
    NONE
    SSessionTraceLoggerTraceType
| The destination of trace data generated by the session in the server process. Optional, defaults to `TRACETYPE_NONE`. |
    SSessionTraceLoggerTraceType=TRACETYPE_
    LOCAL
    ServiceTraceLoggerTraceType
| The destination of trace data generated by the Oracle iFS server. Optional, defaults to `TRACETYPE_NONE`. |
    ServiceTraceLoggerTraceType=TRACETYPE_BOTH
    TraceLoggerLevelChanneln
| The tracing verbosity for trace channel. Optional, no defaults. |
    TraceLoggerLevelChannel10=5
to enable detailed tracing for method invocation
    TraceLoggerLevelChannel6=0
to disable tracing for events
    TraceLoggerLevelAllChannels
| The tracing verbosity for all trace channels. Optional, no defaults. |
    TraceLoggerLevelAllChannels=10

## Writeable Connection Pool Properties

Property | Specifies | Example
--- | --- | ---
    WriteableConnectionPoolMinimumSize
| The initial number of connections in the pool. Optional, defaults to 2. |
    WriteableConnectionPoolMinimumSize=2
    WriteableConnectionPoolTargetSize
| The target maximum number of connections in the pool. Must be greater than or equal to `WriteableConnectionPoolMinimumSize`. Optional, defaults to 5. |
    WriteableConnectionPoolTargetSize=5
    WriteableConnectionPoolMaximumSize
| The absolute maximum number of connections in the pool. Must be greater than or equal to WriteableConnectionPoolTargetSize. Optional, defaults to 10. |
    WriteableConnectionPoolMaximumSize=10
    WriteableConnectionPoolTargetSizeTimeout
| The maximum period, in milliseconds, that the Oracle iFS server will postpone a session's request for a connection if there are no unallocated connections in the pool and the current pool size is less than the target pool size. Optional, defaults to 1000. |
    WriteableConnectionPoolTargetSizeTimeout
    =1000
    WriteableConnectionPoolMaximumSizeTimeout
| The maximum period, in milliseconds, that the Oracle iFS server will postpone a session's request for a connection if there are no unallocated connections in the pool and the current pool size equals or exceeds the target pool size. Optional, defaults to 10000. |
    WriteableConnectionPoolMaximumSizeTimeout
    =10000

## National Language Support Properties

Property | Specifies | Example
--- | --- | ---
    DefaultCharacterSet
| The character set can be set to any valid IANA character set name. The LibrarySession's character set will be obtained from this parameter as a default. If this parameter is not set, the database character set will be used. The LibrarySession's character set can be explicitly set through the API, FTP, CUP, and the Web. FTP uses the character set to determine the character encoding to use for the client connections. The repository uses the character set as a default for the CharacterSet attribute of documents inserted into the repository with a null attribute value. |
    DefaultCharacterSet = UTF-8
    DefaultLanguage
| The language can be set in any valid Oracle language name. The LibrarySession's language will be obtained from this parameter as a default. If the language cannot be guessed from the character set, the repository uses the language as a secondary default for the Language attribute of documents inserted into the repository with a null attribute value. |
    DefaultLanguage=English

The NLS parameters in the following table are involved in creating a Java Locale object. The LibrarySession contains a default Locale object. The values for this object are obtained from these 3 parameters in the properties file. If these are not set, the default Locale from the JVM is used.

Property | Specifies | Example
--- | --- | ---
    DefaultLocaleLanguage
| The first argument to a Java Locale constructor is a valid ISO Language Code. These codes are the lower-case two-letter codes as defined by ISO-639. |
    DefaultLocaleLanguage=en
    DefaultLocaleCountry
| The second argument to a Java Locale constructor is a valid ISO Country Code. These codes are the upper-case two-letter codes as defined by ISO-3166. |
    DefaultLocaleCountry=US
    DefaultLocaleVariant
| The Variant codes are vendor and browser specific. It is the third argument when constructing a Java Locale object. This is most often left blank. |
    DefaultLocaleVariant = WIN

| Copyright © 2000 Oracle Corporation. All Rights Reserved. |
|  |  | Index