この付録では、REST構成デプロイメント・ディスクリプタに関する詳細リファレンスと、ディスクリプタの簡単な概要を示します。
この付録は、次の各項で構成されています。
REST構成デプロイメント・ディスクリプタにより、REST実装の構成を指定します。ディスクリプタのデフォルト名はcoherence-rest-config.xml
で、クラスパス上で見つかる必要があります。tangosol.coherence.rest.config
システム・プロパティを使用して、名前をオーバーライドできます。次に例を示します。
-Dtangosol.coherence.rest.config=MyConfig.xml
REST構成デプロイメント・ディスクリプタのスキーマは、coherence-rest-config.xsd
ファイルに定義されます。XSDファイルはcoherence.jar
ライブラリのルートにおいて次のWeb URLにあります。
http://xmlns.oracle.com/coherence/coherence-rest-config/1.0/coherence-rest-config.xsd
<rest>
要素は構成ファイルのルート要素で、一般的にXSDとCoherenceのネームスペース参照およびcoherence-rest-config.xsd
ファイルの場所が含まれています。次に例を示します。
<?xml version='1.0'?> <cache-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://xmlns.oracle.com/coherence/coherence-rest-config" xsi:schemaLocation="http://xmlns.oracle.com/coherence/coherence-rest-config coherence-rest-config.xsd">
注意:
|
表A-1に、非終端REST構成要素のすべてを示します。
使用場所: aggregators
説明
aggregator
要素は、キャッシュにあるデータの集計に使用するカスタム・アグリゲータの定義に使用されます。各aggregator
要素には、アグリゲータ・クラスまたはアグリゲータのファクトリ・クラスと名前との間における単一バインディングが含まれている必要があります。
要素
表A-2でaggregator
要素の下位要素を説明します。
表A-2 aggregatorの下位要素
要素 | 必須/ オプション |
説明 |
---|---|---|
< |
必須 |
アグリゲータ・クラスまたはアグリゲータのファクトリ・クラスにバインドされるREST用URLで使用する名前を指定します。 |
< |
必須 |
名前にバインドされるカスタム・アグリゲータ・クラスまたはカスタム・アグリゲータのファクトリ・クラスの完全修飾名を指定します。このクラスは |
使用場所: rest
説明
aggregators
要素には、任意の数のカスタム・アグリゲータ定義が格納されます。
要素
表A-3でaggregators
要素の下位要素を説明します。
使用場所: resource
説明
キャッシュ・エントリのキーと値のクラスとマーシャリング処理クラス(それらのクラスのインスタンスでマーシャリングとアンマーシャリングに使用)との間におけるバインドがマーシャリング要素にはあります。
要素
表A-4でmarshaller
要素の下位要素を説明します。
表A-4 marshallerの下位要素
要素 | 必須/ オプション |
説明 |
---|---|---|
|
必須 |
マーシャリング用に使用するメディアの名前を指定します。CoherenceではXMLとJSONのデータ出力のデフォルト実装が用意されています。 |
|
必須 |
|
使用場所: processors
説明
processor
要素は、キャッシュにあるデータの処理に使用するカスタム入力プロセッサの定義に使用されます。各processor
要素には、プロセッサのファクトリ・クラスと名前との間における単一バインディングが含まれている必要があります。
要素
表A-5でprocessor
要素の下位要素を説明します。
表A-5 processorの下位要素
要素 | 必須/ オプション |
説明 |
---|---|---|
|
必須 |
プロセッサのファクトリ・クラスにバインドされるREST用URLで使用する名前を指定します。 |
|
必須 |
名前にバインドされるカスタム・プロセッサのファクトリ・クラスの完全修飾名を指定します。このクラスは |
使用場所: rest
説明
processors
要素には、任意の数のカスタム・プロセッサ定義が格納されます。
要素
表A-6でprocessors
要素の下位要素を説明します。
使用場所: resources
説明
resource
要素によりキャッシュ・エントリのマーシャリングとアンマーシャリングに使用するメタデータを渡します。キャッシュ名とキャッシュ・エントリ・キーと値クラスとの間における単一バインディングがメタデータに含まれます。
要素
表A-7でresource
要素の下位要素を説明します。
表A-7 resourceの下位要素
要素 | 必須/ オプション |
説明 |
---|---|---|
|
必須 |
このリソースで公開されるキャッシュの名前を指定します。キャッシュは、キャッシュ構成ファイルで定義する必要があります。 |
|
オプション |
名前がRESTのURLパス・セグメント用に理想的でない場合における |
|
必須 |
このキャッシュに格納されるエントリ・キーのタイプを指定します。 |
|
必須 |
このキャッシュに格納されるエントリ値のタイプを指定します。 |
|
オプション |
|
オプション |
|
使用場所: rest
説明
リソース要素には、任意の数のリソース定義が格納されます。キャッシュ・エントリのマーシャリングとアンマーシャリングに使用するメタデータをリソース定義により渡します。
要素
表A-8でresources
要素の下位要素を説明します。
root element
説明
rest要素は、Coherence REST実装の構成に使用するcoherence-rest-config.xml
ファイルのルート要素です。実装ではRESTのWebサービスを使用して、リモート・クライアントでクラスタにあるデータをHTTPでアクセスでき、POFシリアライズを使用する必要はありません。
要素
表A-9でrest
要素の下位要素を説明します。