ルート・スキーマ : デフォルト・ファイル・ストア
型: object
ソースの表示
- blockSize(optional): integer(int32)
最小値: -1
最大値: 8192
デフォルト値: -1
ファイルのアドレス指定可能な最小ブロック(バイト)。ネイティブwlfileio
ドライバが使用でき、ブロック・サイズがユーザーによって構成されていないとき、ストアはバッファされていない(直接) I/OとしてOS指定の最小値(範囲[512, 8192]内にある場合)を選択します。
一度ファイル・ストアがファイルを作成すると、そのファイル・ストアのブロック・サイズは変更されません。ブロック・サイズの変更は新しいファイル・ストアまたは現在のファイルが削除されたときにのみ有効です。Oracle WebLogic Serverのパフォーマンスのチューニングの永続ストアのチューニングを参照してください。
- cacheDirectory(optional): string
デフォルト値: oracle.doceng.json.BetterJsonNull@47484423
「直接書込み - キャッシュあり」
のキャッシュ・ディレクトリの場所。他のポリシーでは無視されます。
「直接書込み - キャッシュあり」
がSynchronousWritePolicy
として指定されると、プライマリ・ファイルに加えてキャッシュ・ファイルが作成されます(プライマリ・ファイルの場所はディレクトリを参照してください)。キャッシュ・ディレクトリの場所が指定されると、キャッシュ・ファイルのパスはCacheDirectory/WLStoreCache/StoreNameFileNum.DAT.cache
になります。絶対パスを使用することをお薦めしますが、ディレクトリの場所が相対パスの場合、WebLogic Serverインスタンスのホーム・ディレクトリを基準とした相対的な場所にCacheDirectory
が作成されます。""またはNull
が指定されると、CacheDirectory
はjava.io.tmpdir
Javaシステム・プロパティによって現在のオペレーティング・システムのtemp
ディレクトリ(JDKのデフォルト: UNIXの場合は/tmp
、Windowsの場合は%TEMP%
)に配置され、TempDirectory/WLStoreCache/DomainNameunique-idStoreNameFileNum.DAT.cache
になります。java.io.tmpdir
の値はオペレーティング・システムおよび構成によって異なり、-Djava.io.tmpdir=My_path
をJVMコマンド・ラインに渡すことでオーバーライドできます。
考慮事項:
セキュリティ: 特にプライマリ・ディレクトリにカスタム構成されたユーザー・アクセス制限がある場合、キャッシュ・ディレクトリへのアクセスを制限するために、特定のディレクトリの許可を設定する場合があります。WebLogicのセキュリティの完全なガイドは、Oracle WebLogic Serverのプロダクション環境の保護を参照してください。
追加のディスク領域の使用: キャッシュ・ファイルは、ミラー化するプライマリ・ストア・ファイルと同じ量のディスク領域を消費します。プライマリ・ストア・ファイルの場所は、ディレクトリを参照してください。
パフォーマンス: 最適なパフォーマンスのためには、キャッシュ・ディレクトリをNAS/SAN (リモート)ストレージよりも、オペレーティング・システムのtemp
ディレクトリなどのローカル・ストレージに配置する必要があります。相対パスはドメインのインストールを基準として配置されるため、通常はリモート・ストレージに配置されます。ストアが実行されていないときにキャッシュ・ディレクトリを削除すると安全ですが、次回ストアを起動するときに時間がかかる場合があります。
破損の防止とファイル・ロック: 2つの同じ名前のストアが同じプライマリ・ディレクトリまたはキャッシュ・ディレクトリを共有しないようにしてください。このような競合を検出し、ストアの起動を失敗させて破損を防止するように設計されたストアのファイル・ロック・チェック機能がありますが、正確性を確認するためにファイル・ロック機能に依存することはお薦めしません。「ファイル・ロックの有効化」を参照してください。
起動の回復: キャッシュ・ファイルはファイル・ストアの起動と回復プロセスの速度を上げるために再利用されます。ただし、現在の起動の前にストアのホストWebLogic Serverインスタンスが正常に停止した場合のみです。たとえば、kill -9
の後、OSまたはJVMのクラッシュの後、またはストア管理の圧縮処理など、プライマリ・ファイルがオフラインで変更された後は、キャッシュ・ファイルは再利用されず、完全に再作成されます。キャッシュ・ファイルが再作成されると、警告
ログ・メッセージ280102が生成されます。
フェイルオーバーと移行の回復: ファイル・ストアはキャッシュ・ディレクトリを使用しないで安全にデータを回復します。このため、キャッシュ・ディレクトリをコピーしたり、フェイルオーバーまたは移行後にアクセス可能にしたり、同様にNAS/SANストレージに配置したりする必要もありません。新しいホスト・システムにキャッシュを再作成する必要があることを示す警告
ログ・メッセージ280102は無視できます。
キャッシュ・ファイルのクリーン・アップ: 使用していないキャッシュ・ファイルがディスク領域を消費することを防ぐため、テスト環境および開発者環境では定期的にキャッシュ・ファイルを削除する必要があります。
制約
- directory(optional): string
デフォルト値: oracle.doceng.json.BetterJsonNull@1e5d7fb0
ファイル・ストアがデータ・ファイルを保持するファイル・システム・ディレクトリのパス名。
ファイル・ストアに移行可能なターゲットを指定する場合、ストア・ディレクトリは、移行可能なターゲットのすべての候補サーバー・メンバーからアクセスできる必要があります。
最高レベルの可用性を実現するには、SAN(ストレージ領域ネットワーク)またはその他の信頼性のある共有ストレージを使用してください。
NFSマウントの使用は推奨されませんが、サポートされています。デフォルトでは、ほとんどのNFSマウントによるトランザクションは安全ではありません。トランザクションの正確性を確保するには、NFSベンダーのドキュメントを使用して同期書き込みリクエストを受け付けるように構成する必要があります。
「直接書込み - キャッシュあり」
のSynchronousWritePolicy
については、「キャッシュ・ディレクトリ」を参照してください。
ディレクトリがMicrosoft Windowsによってホストされている場合、追加のO/Sのチューニングが必要な場合があります。詳細は、同期書込みポリシーを参照してください。
制約
- dynamicallyCreated(optional): boolean
読取り専用: true
デフォルト値: false
MBeanが動的に作成されたか、config.xmlに対して永続化されているかが返されます
- fileLockingEnabled(optional): boolean
デフォルト値: true
OSのファイル・ロックが使用されているかどうかを判断します。
ファイル・ロック保護が有効なとき、別のストア・インスタンスがすでにストア・ファイルを開いていると、ストアの起動に失敗します。複数のストア・インスタンスが同じファイルを開くことを防ぐ手順が揃っていないかぎり、この設定を無効にしないでください。ファイル・ロックは必須ではありませんが、同じディレクトリで2つの同名のファイル・ストア・インスタンスが動作したときに発生する破損を防ぐのに役立ちます。この設定は、プライマリ・ファイルおよびキャッシュ・ファイルの両方に適用されます。
- id(optional): integer(int64)
- initialSize(optional): integer(int64)
最小値: 0
デフォルト値: 0
ファイルの初期サイズ(バイト)。
ファイル・ストアの起動時に、InitialSize
を事前割当て済のファイル領域に設定します。InitialSize
がMaxFileSize
を超える場合、ストアは複数のファイルを作成します(ファイルの数 = InitialSize
/MaxFileSize
の切上げ)。
新しい書込みリクエストのための領域が十分にない場合、ファイル・ストアは自動的に削除された記録の領域を再利用し、自動的にファイルを拡張します。
ファイルの拡張は、まれな状況で一時的な待機時間が長く続く可能性があるため、InitialSize
を使用して実行時のファイルの拡張を制限または防止します。
初期サイズの変更は、新しいファイル・ストアに対してのみ、または現在のファイルが削除された後に再起動した場合のみ有効です。
「最大ファイル・サイズ」を参照してください。
- ioBufferSize(optional): integer(int32)
最小値: -1
最大値: 67108864
デフォルト値: -1
I/Oバッファのサイズ(バイト単位)で、自動的に最も近い2のべき乗に切り捨てられます。
「直接書込み - キャッシュあり」
ポリシーでネイティブwlfileio
ドライバが使用できるときは、IOBufferSize
はシステム・コールに渡されるキャッシュ・ビューの最大容量を表します。この部分は、off-heap (ネイティブ)メモリーまたはJavaヒープ・メモリーを消費しません。
「直接書込み」
ポリシーおよび「キャッシュ・フラッシュ」
ポリシーでは、IOBufferSize
はoff-heap (ネイティブ)メモリーを消費するストア・バッファごとのサイズを表します。実行時に1つのバッファが割り当てられますが、起動の回復時に複数のバッファが一時的に作成される場合があります。
ネイティブwlfileio
ドライバを使用できない場合、この設定は(「無効」
を含む)すべてのポリシーのoff-heap (ネイティブ)メモリーに適用されます。
最適な実行時パフォーマンスのために、IOBufferSize
を最大書込み(同時に更新される複数のリクエストが1つの書込みとして組み合される可能性があります)よりも大きな値に設定することをお薦めします
大きなストアでの起動回復時間の最適なパフォーマンスのために、IOBufferSize
を2 MB以上に設定することをお薦めします。
実際に割り当てられているoff-heap(ネイティブ)メモリーを調べるには、AllocatedIOBufferBytesを参照してください。これは、「直接書込み」
ポリシーおよび「キャッシュ・フラッシュ」
ポリシーのIOBufferSize
の倍数か、ゼロになります。
- maxFileSize(optional): integer(int64)
最小値: 1048576
最大値: 2139095040
デフォルト値: 1342177280
各データ・ファイルの最大ファイル・サイズ(バイト)。
MaxFileSize
値は特定のサイズのストアを格納するために必要なファイルの数に影響します(ファイルの数=ストアのサイズ/切り上げられたMaxFileSize)。
新しい記録のための領域が十分にない場合、ファイル・ストアは自動的に記録の削除によって開放された領域を再利用し、自動的に個々のファイルをMaxFileSize
まで拡張します。既存のファイルに新しい記録のための領域が残っていない場合、ストアは追加ファイルを作成します。
各ファイルにウィンドウ・バッファおよびファイル・ハンドルが割り当てられるため、通常少数の大きなファイルのほうが多数の小さなファイルより推奨されます。
MaxFileSize
が2^24 * BlockSize
より大きい場合、MaxFileSize
は無視され、値は2^24 * BlockSize
になります。デフォルトのBlockSize
は512で、2^24 * 512は8 GBです。
ストアによって複数のデータ・ファイルが使用されている場合、MaxFileSize
の最小サイズは10 MBです。InitialSize
がMaxFileSize
より小さい場合は、InitialSize
バイトの単一ファイルが作成されます。InitialSize
がMaxFileSize
より大きい場合は、MaxFileSize
バイトの(InitialSize
/ MaxFileSize
)ファイルが作成され、必要に応じて残りを含む追加のファイルが作成されます。
「initialSize」を参照してください
- maxWindowBufferSize(optional): integer(int32)
最小値: -1
最大値: 1073741824
デフォルト値: -1
JVMのアドレス空間にマップされるプライマリ・ストア・ファイルごとのデータの最大容量(バイト単位)。最も近い2のべき乗に切り捨てられます。同期書込みポリシーの「直接書込み - キャッシュあり」
および「無効」
に適用されますが、ネイティブのwlfileio
ライブラリがロードされたときのみです。
ウィンドウ・バッファはJavaヒープ・メモリーを消費しませんが、off-heap (ネイティブ)メモリーを消費します。ストアがリクエストされたバッファ・サイズを割り当てられない場合は、MinWindowBufferSize
に到達するまでより小さいバッファを割り当て、MinWindowBufferSize
に到達すると失敗します
最大ウィンドウ・バッファのサイズを、その他の制約がないかぎり、最大書込みの2倍(同時に更新される複数の記録が1つの書込みとして組み合される可能性があります)およびファイル・サイズ以上に設定することをお薦めします。32ビットのJVMでは、Javaヒープとoff-heap (ネイティブ)のメモリー使用量の合計の制限を2から4 GBに設定します。
- minWindowBufferSize(optional): integer(int32)
最小値: -1
最大値: 1073741824
デフォルト値: -1
JVMのアドレス空間にマップされるプライマリ・ストア・ファイルごとのデータの最小容量(バイト単位)。最も近い2のべき乗に切り捨てられます。同期書込みポリシーが「直接書込み - キャッシュあり」
および「無効」
で、ネイティブwlfileio
ライブラリがロードされているときのみ適用されます。最大ウィンドウ・バッファ・サイズを参照してください。
- name(optional): string
読取り専用: true
このMBeanインスタンスのユーザー定義の名前。
この名前は、MBeanのjavax.management.ObjectName
に、主要なプロパティとして含まれています
Name=user-specified-name
制約
- notes(optional): string
この構成の説明として任意に入力できる情報。
WebLogic Serverは、ドメインの構成ファイル(config.xml
)に、このノートをXML PCDATAとして保存します。すべての左山カッコ(<) are converted to the xml entity <)は、xmlエンティティに変換されます。キャリッジ・リターンとライン・フィードは維持されます。)>
ノート: 管理コンソールからノートを作成または編集した場合、キャリッジ・リターンとライン・フィードは維持されません。
- synchronousWritePolicy(optional): string
デフォルト値: Direct-Write
使用可能な値: [ "Disabled", "Cache-Flush", "Direct-Write", "Direct-Write-With-Cache" ]
ファイル・ストアがデータをディスクに書き込む方法を決定するディスク書込みポリシー。
このポリシーは、JMSファイル・ストアのパフォーマンス、スケーラビリティおよび信頼性にも影響します。通常最大のパフォーマンスを提供する「直接書込み - キャッシュあり」
の使用をお薦めします。デフォルト値は「直接書込み」
です。有効なポリシー・オプションは次のとおりです。
Direct-Write
すべてのプラットフォームで直接I/Oがサポートされます。使用可能な場合、直接I/Oモードのファイル・ストアは自動的にネイティブI/O wlfileio
ドライバをロードします。このオプションは、通常「キャッシュ・フラッシュ」
を上回り、「直接書込み - キャッシュあり」
よりも遅くなります。このモードはネイティブ・ストアのwlfileio
ドライバを必要としませんが、使用すると処理が速くなります。
Direct-Write-With-Cache
ストア記録はDirectory
属性で指定されたディレクトリ内のプライマリ・ファイルに同期的に書き込まれ、キャッシュ・ディレクトリ
内の対応するキャッシュ・ファイルに非同期的に書き込まれます。「キャッシュ・ディレクトリ」
はディスク領域、ロック、セキュリティおよびパフォーマンスの実装に関する情報を提供します。このモードは、ネイティブ・ストアのwlfileiocode
ドライバを必要とします。ネイティブ・ドライバをロードできない場合、書き込みモードは自動的に「直接書込み」
に切り替わります。「cacheDirectory」を参照してください
Cache-Flush
すべての書込みがディスクにフラッシュされるまでトランザクションは完了しません。このポリシーは信頼性があり、同時実行ユーザーが増えるとそれに合わせて拡大します。トランザクションは安全ですが、直接書込みポリシーよりパフォーマンスが低下します。
Disabled
ディスクへの書込み成功を待たず、トランザクションは書込みがメモリーにキャッシュされた時点で完了します。書込みリクエストがディスクとの同期の待機をブロックしないため、これは最速のポリシーです。ただし、他のポリシーと異なり、オペレーティング・システムまたはハードウェアで障害が発生した場合、トランザクションは安全ではありません。このような障害が発生すると、データやメッセージの重複または消失につながる可能性があります。このオプションはネイティブ・ストアのwlfileio
ドライバを必要としませんが、使用すると処理が速くなります。WebLogic以外のJMSベンダーでは、「無効」
に相当するポリシーをデフォルトとするものもあります。
ノート:
使用可能な場合、ファイル・ストアはパフォーマンスを向上するWebLogic wlfileio
ネイティブ・ドライバをロードします。これらのドライバは、Windows、Solaris、LinuxおよびAIX WebLogicのインストールに含まれています。
古いバージョンのMicrosoft Windowsでは、Windowsでデフォルトの書き込みキャッシュを有効にする
設定が使用されている場合、ストレージ・デバイスの同期書込みが完了したことを間違って報告する可能性があります。システムのクラッシュや電源の故障はレコードまたはメッセージの損失や重複につながる可能性があるため、これにより、「直接書込み」
(デフォルト)または「直接書込み - キャッシュあり」
ポリシーで構成されたファイル・ストアを含む、トランザクション製品(Oracleに限られません)のトランザクション・セマンティクスが無視されます。ストレージ・デバイスの物理的な機能を超える高い永続メッセージ/トランザクション・スループットの場合、この問題が現れます。この問題は、Microsoft提供のパッチを適用してWindowsの書き込みキャッシュを有効にする
設定を無効にするか、電源を保護されたストレージ・デバイスを使用することで対処できます。http://support.microsoft.com/kb//281672およびhttp://support.microsoft.com/kb//332023を参照してください。
NFSストレージ・ノート: 一部のオペレーティング・システムで、ファイルがロックされているとき、ネイティブ・ドライバのノート・リーマッピングはNFSと互換性がありません。同期書込みポリシー「直接書込み - キャッシュあり」
または「無効」のストアおよびWebLogic JMSページング・ストアでは、ネイティブwlfileio
ドライバを使用してパフォーマンスを向上し、メモリーマップのオペレーティング・システムの呼出しを実行します。NFS、ファイル・ロック、メモリー・マッピング間に互換性がないことをストアが検出すると、メモリー・マッピングのかわりに、従来の読取りまたは書込みのシステム・コールに自動的にダウングレードされます。最適なパフォーマンスのため、代替NFSクライアント・ドライバの調査、NFS以外のストレージの場所の構成、制御下の環境および自己責任でファイル・ロックの無効化をお薦めします(「ファイル・ロックの有効化」を参照)。詳細は、Oracle WebLogic ServerのパフォーマンスのチューニングのWebLogic永続ストアのチューニングを参照してください。
- tags(optional): array 項目
- type(optional): string
{
"type":"object",
"properties":{
"blockSize":{
"default":-1,
"minimum":-1,
"maximum":8192,
"type":"integer",
"format":"int32",
"description":"<p>The smallest addressable block, in bytes, of a file. When a native <code>wlfileio</code> driver is available and the block size has not been configured by the user, the store selects the minimum OS specific value for unbuffered (direct) I/O, if it is within the range [512, 8192].</p><p> A file store's block size does not change once the file store creates its files. Changes to block size only take effect for new file stores or after the current files have been deleted. See \"Tuning the Persistent Store\" in <i>Tuning Performance of Oracle WebLogic Server</i></p>"
},
"cacheDirectory":{
"default":null,
"x-weblogic-legalNull":true,
"type":"string",
"description":"<p>The location of the cache directory for <code>Direct-Write-With-Cache</code>, ignored for other policies.</p><p>When <code>Direct-Write-With-Cache</code> is specified as the <code>SynchronousWritePolicy</code>, cache files are created in addition to primary files (see Directory for the location of primary files). If a cache directory location is specified, the cache file path is <code><i>CacheDirectory</i>/WLStoreCache/<i>StoreName</i>FileNum.DAT.cache</code>. When specified, Oracle recommends using absolute paths, but if the directory location is a relative path, then <code>CacheDirectory</code> is created relative to the WebLogic Server instance's home directory. If \"\" or <code>Null</code> is specified, the <code>Cache Directory</code> is located in the current operating system <code>temp</code> directory as determined by the <code>java.io.tmpdir</code> Java System property (JDK's default: <code>/tmp</code> on UNIX, <code>%TEMP% </code> on Windows) and is <code><i>TempDirectory</i>/WLStoreCache/<i>DomainName</i><i>unique-id</i><i>StoreName</i>FileNum.DAT.cache</code>. The value of <code>java.io.tmpdir</code> varies between operating systems and configurations, and can be overridden by passing <code>-Djava.io.tmpdir=<i>My_path</i></code> on the JVM command line. </p><p>Considerations:</p><ul><li><p>Security: Some users may want to set specific directory permissions to limit access to the cache directory, especially if there are custom configured user access limitations on the primary directory. For a complete guide to WebLogic security, see \"Securing a Production Environment for Oracle WebLogic Server.\" </p></li><li><p>Additional Disk Space Usage: Cache files consume the same amount of disk space as the primary store files that they mirror. See Directory for the location of primary store files.</p></li><li><p>Performance: For the best performance, a cache directory should be located in local storage instead of NAS/SAN (remote) storage, preferably in the operating system's <code>temp</code> directory. Relative paths should be avoided, as relative paths are located based on the domain installation, which is typically on remote storage. It is safe to delete a cache directory while the store is not running, but this may slow down the next store boot.</p></li><li><p>Preventing Corruption and File Locking: Two same named stores must not be configured to share the same primary or cache directory. There are store file locking checks that are designed to detect such conflicts and prevent corruption by failing the store boot, but it is not recommended to depend on the file locking feature for correctness. See Enable File Locking</p></li><li><p> Boot Recovery: Cache files are reused to speed up the File Store boot and recovery process, but only if the store's host WebLogic Server instance has been shut down cleanly prior to the current boot. For example, cache files are not re-used and are instead fully recreated: after a <code>kill -9</code>, after an OS or JVM crash, or after an off-line change to the primary files, such as a store admin compaction. When cache files are recreated, a <code>Warning</code> log message 280102 is generated.</p></li><li><p>Fail-Over/Migration Recovery: A file store safely recovers its data without its cache directory. Therefore, a cache directory does not need to be copied or otherwise made accessible after a fail-over or migration, and similarly does not need to be placed in NAS/SAN storage. A <code>Warning</code> log message 280102, which is generated to indicate the need to recreate the cache on the new host system, can be ignored.</p></li><li><p> Cache File Cleanup: To prevent unused cache files from consuming disk space, test and developer environments should periodically delete cache files.</p></li></ul><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
},
"directory":{
"default":null,
"x-weblogic-legalNull":true,
"type":"string",
"description":"<p>The path name to the file system directory where the file store maintains its data files.</p><ul><li><p>When targeting a file store to a migratable target, the store directory must be accessible from all candidate server members in the migratable target.</p></li><li><p>For highest availability, use either a SAN (Storage Area Network) or other reliable shared storage.</p></li><li><p>Use of NFS mounts is discouraged, but supported. Most NFS mounts are not transactionally safe by default, and, to ensure transactional correctness, need to be configured using your NFS vendor documentation in order to honor synchronous write requests.</p></li><li><p>For <code>SynchronousWritePolicy</code> of <code>Direct-Write-With-Cache</code>, see Cache Directory. </p></li><li><p>Additional O/S tuning may be required if the directory is hosted by Microsoft Windows, see Synchronous Write Policy for details.</p></li></ul><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
},
"dynamicallyCreated":{
"readOnly":true,
"default":false,
"type":"boolean",
"description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
},
"fileLockingEnabled":{
"default":true,
"type":"boolean",
"description":"<p>Determines whether OS file locking is used. </p><p> When file locking protection is enabled, a store boot fails if another store instance already has opened the store files. Do not disable this setting unless you have procedures in place to prevent multiple store instances from opening the same file. File locking is not required but helps prevent corruption in the event that two same-named file store instances attempt to operate in the same directories. This setting applies to both primary and cache files.</p>"
},
"id":{
"readOnly":true,
"type":"integer",
"format":"int64",
"description":"<p>Return the unique id of this MBean instance</p>"
},
"initialSize":{
"default":0,
"minimum":0,
"type":"integer",
"format":"int64",
"description":"<p>The initial file size, in bytes.</p><ul><li><p>Set <code>InitialSize</code> to pre-allocate file space during a file store boot. If <code>InitialSize</code> exceeds <code>MaxFileSize</code>, a store creates multiple files (number of files = <code>InitialSize</code><code>MaxFileSize</code> rounded up).</p></li><li><p>A file store automatically reuses the space from deleted records and automatically expands a file if there is not enough space for a new write request.</p></li><li><p>Use <code>InitialSize</code> to limit or prevent file expansions during runtime, as file expansion introduces temporary latencies that may be noticeable under rare circumstances. </p></li><li><p>Changes to initial size only take effect for new file stores, or after any current files have been deleted prior to restart.</p></li><li><p> See Maximum File Size</p></li></ul>"
},
"ioBufferSize":{
"default":-1,
"minimum":-1,
"maximum":67108864,
"type":"integer",
"format":"int32",
"description":"<p>The I/O buffer size, in bytes, automatically rounded down to the nearest power of 2.</p><ul><li><p> For the <code>Direct-Write-With-Cache</code> policy when a native <code>wlfileio</code> driver is available, <code>IOBufferSize</code> describes the maximum portion of a cache view that is passed to a system call. This portion does not consume off-heap (native) or Java heap memory.</p></li><li><p> For the <code>Direct-Write</code> and <code>Cache-Flush</code> policies, <code>IOBufferSize</code> is the size of a per store buffer which consumes off-heap (native) memory, where one buffer is allocated during run-time, but multiple buffers may be temporarily created during boot recovery.</p></li><li><p>When a native <code>wlfileio</code> driver is not available, the setting applies to off-heap (native) memory for all policies (including <code>Disabled</code>).</p></li><li><p>For the best runtime performance, Oracle recommends setting <code>IOBufferSize</code> so that it is larger than the largest write (multiple concurrent store requests may be combined into a single write).</p></li><li><p>For the best boot recovery time performance of large stores, Oracle recommends setting <code>IOBufferSize</code> to at least 2 megabytes.</p></li></ul><p>See AllocatedIOBufferBytes to find out the actual allocated off-heap (native) memory amount. It is a multiple of <code>IOBufferSize</code> for the <code>Direct-Write</code> and <code>Cache-Flush</code> policies, or zero.</p>"
},
"maxFileSize":{
"default":1342177280,
"minimum":1048576,
"maximum":2139095040,
"type":"integer",
"format":"int64",
"description":"<p>The maximum file size, in bytes, of an individual data file.</p><ul><li><p>The <code>MaxFileSize</code> value affects the number of files needed to accommodate a store of a particular size (number of files = store size/MaxFileSize rounded up).</p></li><li><p>A file store automatically reuses space freed by deleted records and automatically expands individual files up to <code>MaxFileSize</code> if there is not enough space for a new record. If there is no space left in exiting files for a new record, a store creates an additional file.</p></li><li><p> A small number of larger files is normally preferred over a large number of smaller files as each file allocates Window Buffer and file handles. </p></li><li><p> If <code>MaxFileSize</code> is larger than 2^24 * <code>BlockSize</code>, then <code>MaxFileSize</code> is ignored, and the value becomes 2^24 * <code>BlockSize</code>. The default <code>BlockSize</code> is 512, and 2^24 * 512 is 8 GB.</p></li><li><p>The minimum size for <code>MaxFileSize</code> is 10 MB when multiple data files are used by the store. If <code>InitialSize</code> is less than <code>MaxFileSize</code> then a single file will be created of <code>InitialSize</code> bytes. If <code>InitialSize</code> is larger than <code>MaxFileSize</code> then (<code>InitialSize</code> / <code>MaxFileSize</code>) files will be created of <code>MaxFileSize</code> bytes and an additional file if necessary to contain any remainder.</p></li><li><p> See Initial Size</p></li></ul>"
},
"maxWindowBufferSize":{
"default":-1,
"minimum":-1,
"maximum":1073741824,
"type":"integer",
"format":"int32",
"description":"<p>The maximum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per primary store file. Applies to synchronous write policies <code>Direct-Write-With-Cache</code> and <code>Disabled</code> but only when the native <code>wlfileio</code> library is loaded.</p><p>A window buffer does not consume Java heap memory, but does consume off-heap (native) memory. If the store is unable to allocate the requested buffer size, it allocates smaller and smaller buffers until it reaches <code>MinWindowBufferSize</code>, and then fails if cannot honor <code>MinWindowBufferSize</code></p><p>Oracle recommends setting the max window buffer size to more than double the size of the largest write (multiple concurrently updated records may be combined into a single write), and greater than or equal to the file size, unless there are other constraints. 32-bit JVMs may impose a total limit of between 2 and 4GB for combined Java heap plus off-heap (native) memory usage.</p><ul><li><p>See store attribute <code>AllocatedWindowBufferBytes</code> to find out the actual allocated Window Buffer Size.</p></li><li><p> See Maximum File Size and Minimum Window Buffer Size</p></li></ul>"
},
"minWindowBufferSize":{
"default":-1,
"minimum":-1,
"maximum":1073741824,
"type":"integer",
"format":"int32",
"description":"<p>The minimum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per primary store file. Applies to synchronous write policies <code>Direct-Write-With-Cache</code> and <code>Disabled</code>, but only when a native <code>wlfileio</code> library is loaded. See Maximum Window Buffer Size</p>"
},
"name":{
"readOnly":true,
"x-weblogic-legalNull":true,
"type":"string",
"description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
},
"notes":{
"type":"string",
"description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code><</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
},
"synchronousWritePolicy":{
"default":"Direct-Write",
"enum":[
"Disabled",
"Cache-Flush",
"Direct-Write",
"Direct-Write-With-Cache"
],
"type":"string",
"description":"<p>The disk write policy that determines how the file store writes data to disk.</p><p>This policy also affects the JMS file store's performance, scalability, and reliability. Oracle recommends <code>Direct-Write-With-Cache</code> which tends to have the highest performance. The default value is <code>Direct-Write</code>. The valid policy options are:</p><ul><li><p><code>Direct-Write</code> Direct I/O is supported on all platforms. When available, file stores in direct I/O mode automatically load the native I/O <code>wlfileio</code> driver. This option tends to out-perform <code>Cache-Flush</code> and tend to be slower than <code>Direct-Write-With-Cache</code>. This mode does not require a native store <code>wlfileio</code> driver, but performs faster when they are available.</p></li><li><p><code>Direct-Write-With-Cache</code> Store records are written synchronously to primary files in the directory specified by the <code>Directory</code> attribute and asynchronously to a corresponding cache file in the <code>Cache Directory</code>. The <code>Cache Directory</code> provides information about disk space, locking, security, and performance implications. This mode requires a native store <code>wlfileiocode</code> driver. If the native driver cannot be loaded, then the write mode automatically switches to <code>Direct-Write</code>. See Cache Directory</p></li><li><p><code>Cache-Flush</code> Transactions cannot complete until all of their writes have been flushed down to disk. This policy is reliable and scales well as the number of simultaneous users increases.Transactionally safe but tends to be a lower performer than direct-write policies.</p></li><li><p><code>Disabled</code> Transactions are complete as soon as their writes are cached in memory, instead of waiting for the writes to successfully reach the disk. This is the fastest policy because write requests do not block waiting to be synchronized to disk, but, unlike other policies, is not transactionally safe in the event of operating system or hardware failures. Such failures can lead to duplicate or lost data/messages. This option does not require native store <code>wlfileio</code> drivers, but may run faster when they are available. Some non-WebLogic JMS vendors default to a policy that is equivalent to <code>Disabled</code></p></li></ul><p>Notes:</p><ul><li><p>When available, file stores load WebLogic <code>wlfileio</code> native drivers, which can improve performance. These drivers are included with Windows, Solaris, Linux, and AIX WebLogic installations.</p></li><li><p>Certain older versions of Microsoft Windows may incorrectly report storage device synchronous write completion if the Windows default <code>Write Cache Enabled</code> setting is used. This violates the transactional semantics of transactional products (not specific to Oracle), including file stores configured with a <code>Direct-Write</code> (default) or <code>Direct-Write-With-Cache</code> policy, as a system crash or power failure can lead to a loss or a duplication of records/messages. One of the visible symptoms is that this problem may manifest itself in high persistent message/transaction throughput exceeding the physical capabilities of your storage device. You can address the problem by applying a Microsoft supplied patch, disabling the Windows <code>Write Cache Enabled</code> setting, or by using a power-protected storage device. See <a href=\"http://support.microsoft.com/kb/281672/\">http://support.microsoft.com/kb/281672</a> and <a href=\"http://support.microsoft.com/kb/332023\">http://support.microsoft.com/kb/332023</a>. </p></li><li><p>NFS storage note: On some operating systems, native driver memory-mapping is incompatible with NFS when files are locked. Stores with synchronous write policies <code>Direct-Write-With-Cache</code> or Disabled, and WebLogic JMS paging stores enhance performance by using the native <code>wlfileio</code> driver to perform memory-map operating system calls. When a store detects an incompatibility between NFS, file locking, and memory mapping, it automatically downgrades to conventional read/write system calls instead of memory mapping. For best performance, Oracle recommends investigating alternative NFS client drivers, configuring a non-NFS storage location, or in controlled environments and at your own risk, disabling the file locks (See Enable File Locking). For more information, see \"Tuning the WebLogic Persistent Store\" in <i>Tuning Performance of Oracle WebLogic Server</i></p></li></ul>"
},
"tags":{
"title":"Items",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"<p>Return all tags on this Configuration MBean</p>"
},
"type":{
"readOnly":true,
"x-weblogic-unharvestable":true,
"type":"string",
"description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
}
},
"description":""
}