C POFユーザー定義型の構成要素

この付録では、POF構成デプロイメント・ディスクリプタのリファレンスと、ディスクリプタの簡単な概要を示します。

バイナリ形式の詳細は、PIF-POFバイナリ形式を参照してください。

この付録の内容は次のとおりです。

C.1 POF構成デプロイメント・ディスクリプタ

POF構成デプロイメント・ディスクリプタは、POFを使用してシリアライズおよびデシリアライズされているオブジェクトの非固有の型(ユーザー定義型)を指定するために使用します。POF構成デプロイメント・ディスクリプタの名前と場所はオペレーション・デプロイメント・ディスクリプタで指定され、pof-config.xmlにデフォルト設定されます。サンプルのPOF構成ディスクリプタがcoherence.jarライブラリのルートに配置されており、アプリケーションのクラスパス内でcoherence.jarファイルより前にカスタムのpof-config.xmlファイルが検出されないかぎり、これが使用されます。すべてのクラスタ・メンバーで使用するPOF構成デプロイメント・ディスクリプタを統一してください。

POF構成デプロイメント・ディスクリプタ・スキーマは、coherence-pof-config.xsdファイルで定義します。このXSDファイルは、coherence.jarライブラリのルートにあります。<pof-config>要素はPOF構成デプロイメントのルート要素であり、通常はXSDおよびネームスペースの宣言が含まれます。次に例を示します。

<?xml version='1.0'?>

<pof-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://xmlns.oracle.com/coherence/coherence-pof-config"
   xsi:schemaLocation="http://xmlns.oracle.com/coherence/coherence-pof-config
   coherence-pof-config.xsd">

注意:

coherence.jarライブラリにあるスキーマは、xsi:schemaLocation属性がWeb URLを参照する場合であっても、常に実行時に使用されます。
xsi:schemaLocation属性を省略すると、スキーマ検証を無効にできます。
デフォルトの文字セットがASCIIではなくEBCDICである環境にCoherenceをデプロイする場合、デプロイメント・ディスクリプタ・ファイルがASCII形式であり、ランタイム環境にバイナリ形式でデプロイされることを確認してください。

Coherenceに固有のユーザー定義型は、同じくcoherence.jarライブラリのルートにあるcoherence-pof-config.xmlファイルで定義します。pof-config.xmlファイルを作成するときは、このファイルを次のように参照する必要があります。

<?xml version='1.0'?>

<pof-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://xmlns.oracle.com/coherence/coherence-pof-config"
   xsi:schemaLocation="http://xmlns.oracle.com/coherence/coherence-pof-config
   coherence-pof-config.xsd">
   <user-type-list>
      <include>coherence-pof-config.xml</include>
   </user-type-list>
   ...
</pof-config>

C.2 POF構成要素リファレンス

このリファレンスには、POF構成のすべての非終端要素が含まれます。各項で、要素の使用方法とすべての有効なサブ要素についても説明されています。

C.2.1 default-serializer

使用場所: pof-config

説明

この要素は、pof-config要素内で定義されるすべてのユーザー定義型のシリアライズおよびデシリアライズの際に使用するPofSerializerを指定します。シリアライザがuser-type内に指定されている場合、そのユーザー定義型にはデフォルトのシリアライザのかわりにそのシリアライザが使用されます。

default-serializer要素を省略すると、特定のユーザー定義型に対して定義されたシリアライザが使用されます。そのユーザー定義型のserializer要素も省略すると、ユーザー定義型によってPortableObjectインタフェースが実装され、PortableObjectSerializer実装がPofSerializerとして使用されることになります。

default-serializer要素からinit-params要素を省略した場合は、そのPofSerializer実装に対して次の4つのコンストラクタが、ここに示された順序で試行されます。

(int nTypeId, Class clz, ClassLoader loader)
(int nTypeId, Class clz)
(int nTypeId)
()

要素

表C-1で、default-serializer要素のサブ要素を説明します。

表C-1 default-serializerのサブ要素

要素	必須/ オプション	説明
`<class-name>`	必須	`PofSerializer`実装の完全修飾名を指定します。
<`init-params`>	オプション	(それぞれが`init-param`として)ゼロ個以上の引数を指定し、それらの引数は、構成されているクラスのコンストラクタのパラメータに対応します。

C.2.2 init-param

使用場所: init-params

説明

init-param要素では、構成パラメータの型、および引数として渡す対応値を指定します。

要素

表C-2は、init-param要素のサブ要素を示しています。

表C-2 init-paramのサブ要素

要素必須/ オプション説明

要素	必須/ オプション	説明
`<param-type>`	必須	`param-type`要素は、初期化パラメータのJavaタイプを指定します。サポートされているタイプは次のとおりです。 `string`: 値が`java.lang.String`であることを示します。 `boolean`: 値が`java.lang.Boolean`であることを示します。 `int`: 値が`java.lang.Integer`であることを示します。 `long`: 値が`java.lang.Long`であることを示します。 `double`: 値が`java.lang.Double`であることを示します。 `decimal`: 値が`java.math.BigDecimal`であることを示します。 `file`: 値が`java.io.File`であることを示します。 `date`: 値が`java.sql.Date`であることを示します。 `time`: 値が`java.sql.Timedatetime`であることを示します。 `datetime`: 値が`java.sql.Timestamp`であることを示します。 `xml`: 値が`init-param XmlElement`全体であることを示します。値は指定された型に変換されます。インスタンス化を正常に実行するには、ターゲットのコンストラクタまたはメソッドにその型のパラメータが存在している必要があります。
`<param-value>`	必須	`param-value`要素は、初期化パラメータの値を指定します。この値は、パラメータの型に固有の形式にします。指定できる値が4つ予約されています。これらの値がそれぞれ、実行時に特定の値に置換されてから、コンストラクタが起動されます。 `{type-id}`: ユーザー定義型のタイプIDに置換されます。 `{class-name}`: ユーザー定義型のクラスの名前に置換されます。 `{class}`: ユーザー定義型のクラスに置換されます。 `{class-loader}`: `ConfigurablePofContext`の`ContextClassLoader`に置換されます。

<param-type>

必須

param-type要素は、初期化パラメータのJavaタイプを指定します。サポートされているタイプは次のとおりです。

string: 値がjava.lang.Stringであることを示します。
boolean: 値がjava.lang.Booleanであることを示します。
int: 値がjava.lang.Integerであることを示します。
long: 値がjava.lang.Longであることを示します。
double: 値がjava.lang.Doubleであることを示します。
decimal: 値がjava.math.BigDecimalであることを示します。
file: 値がjava.io.Fileであることを示します。
date: 値がjava.sql.Dateであることを示します。
time: 値がjava.sql.Timedatetimeであることを示します。
datetime: 値がjava.sql.Timestampであることを示します。
xml: 値がinit-param XmlElement全体であることを示します。

値は指定された型に変換されます。インスタンス化を正常に実行するには、ターゲットのコンストラクタまたはメソッドにその型のパラメータが存在している必要があります。

<param-value>

必須

param-value要素は、初期化パラメータの値を指定します。この値は、パラメータの型に固有の形式にします。指定できる値が4つ予約されています。これらの値がそれぞれ、実行時に特定の値に置換されてから、コンストラクタが起動されます。

{type-id}: ユーザー定義型のタイプIDに置換されます。
{class-name}: ユーザー定義型のクラスの名前に置換されます。
{class}: ユーザー定義型のクラスに置換されます。
{class-loader}: ConfigurablePofContextのContextClassLoaderに置換されます。

C.2.3 init-params

使用場所: serializer、default-serializer

説明

init-params要素には、(それぞれがinit-paramとして)ゼロ個以上の引数を記述し、それらの引数は、構成されているクラスのコンストラクタのパラメータに対応します。

要素

表C-3は、init-params要素のサブ要素を示しています。

表C-3 init-paramsのサブ要素

要素	必須/ オプション	説明
<`init-param`>	必須	`init-param`要素では、構成パラメータの型、および引数として渡す対応値を指定します。

C.2.4 pof-config

ルート要素

説明

pof-config要素は、POFユーザー定義型のディスクリプタのルート要素です。

要素

表C-4で、pof-config要素のサブ要素を説明します。

表C-4 pof-configのサブ要素

要素	必須/ オプション	説明
<`user-type-list`>	必須	`user-type-list`要素には、ゼロ個以上のuser-type要素を記述します。使用されるPOFユーザー定義型はそれぞれ、`user-type-list`に一覧表示されている必要があります。`user-type-list`要素には、ゼロ個以上の`include`要素も記述できます。それぞれのinclude要素は、別の`pof-config`ファイルで定義されたuser-type要素の追加に使用されます。
<allow-interfaces>	オプション	`allow-interfaces`要素は、user-type `class-name`でJavaクラス・タイプ以外にJavaインタフェース・タイプも指定できるかどうかを示します。有効な値は`true`または`false`です。デフォルト値は`false`です。
<allow-subclasses>	オプション	`allow-subclasses`要素は、user-type `class-name`で抽象的なJavaクラス・タイプを指定できるかどうか、および、指定したuser-type `class-name`のサブクラスが実行時に許可され、シリアライザの取得を目的として指定したスーパークラスに自動的にマップされるかどうかを示します。有効な値は`true`または`false`です。デフォルト値は`false`です。
<enable-references>	オプション	`enable-references`要素は、Identity/Reference型のサポートを有効にするかどうかを指定します。有効な値は`true`または`false`です。デフォルト値は`false`です。
`<default-serializer>`	オプション	`default-serializer`は、POF構成ファイルで定義されたすべてのユーザー定義型のシリアライズおよびデシリアライズに使用するシリアライザを指定します。特定のシリアライザが定義されているuser-typeでは、デフォルトのシリアライザのかわりに、そのシリアライザが使用されます。

C.2.5 serializer

使用場所: user-type

説明

serializer要素は、特定のユーザー定義型のシリアライズおよびデシリアライズに使用するPOFシリアライザを指定します。PofSerializer実装は、POFストリームとの間でのユーザー定義型の値のシリアライズおよびデシリアライズに使用されます。

serializer要素を省略すると、ユーザー定義型によってPortableObjectインタフェースが実装され、PortableObjectSerializer実装がPOFシリアライザとして使用されることになります。POF注釈を使用する場合は、PofAnnotationSerializer実装がPOFシリアライザとして使用されます。

init-params要素を省略した場合は、そのPofSerializer実装に対して次の4つのコンストラクタが、ここに示された順序で試行されます。

(int nTypeId, Class clz, ClassLoader loader)
(int nTypeId, Class clz)
(int nTypeId)
()

要素

表C-5で、serializer要素のサブ要素を説明します。

表C-5 serializerのサブ要素

要素	必須/ オプション	説明
`<class-name>`	必須	`PofSerializer`実装の完全修飾名を指定します。
<`init-params`>	オプション	`init-params`要素には、(それぞれが`init-param`として)ゼロ個以上の引数を記述し、それらの引数は、構成されているクラスのコンストラクタのパラメータに対応します。

C.2.6 user-type

使用場所: user-type-list

説明

user-type要素には、POFユーザー定義型の宣言を記述します。POFユーザー定義型は、一意の識別、移植、バージョニングが可能なオブジェクト・クラスで、言語、オペレーティング・システム、ハードウェアおよび場所に関係なく、システム間で通信できます。

user-type要素の中ではtype-id要素を省略できますが、スキーマのバージョニングおよび進化をサポートできるように、使用することを強くお薦めします。

user-type要素の中にはclass-name要素が必要であり、ユーザー定義型のすべての値にタイプの割当てが可能なJavaクラスまたはJavaインタフェースの完全修飾名を指定します。

serializer要素を省略すると、ユーザー定義型によってPortableObjectインタフェースが実装され、PortableObjectSerializer実装がPofSerializerとして使用されることになります。

要素

表C-6で、user-type要素のサブ要素を説明します。

表C-6 user-typeのサブ要素

要素必須/ オプション説明

要素	必須/ オプション	説明
`<type-id>`	オプション	`type-id`要素は、ユーザー定義型を一意に識別する整数値(`n` `>=` `0`)を指定します。`user-type`要素のいずれも`type-id`要素を記述していない場合には、ユーザー定義型の型IDは、`user-type-list`に表示される順序に基づきます。そこでは、最初に割り当てられるユーザー定義型の型`ID`が`0`、2番目に割り当てられるユーザー定義型の型`ID`が`1`になります(以下同様)。ただし、スキーマのバージョニングおよび進化をサポートできるように、ユーザー定義型のIDを常に指定することを強くお薦めします。最初の1000個のIDは、Coherenceの内部使用に予約されているため、使用できません。
`<class-name>`	必須	`class-name`要素は、ユーザー定義型のすべての値にタイプの割当てが可能なJavaクラスまたはJavaインタフェースの完全修飾名を指定します。
<`serializer`>	オプション	`serializer`要素は、特定のユーザー定義型のシリアライズおよびデシリアライズに使用する`PofSerializer`を指定します。`PofSerializer`は、POFストリームとの間でのユーザー定義型の値のシリアライズおよびデシリアライズに使用されます。`serializer`要素の中には`class-name`要素が必要であり、`init-params`要素の中にはゼロ個以上のコンストラクタ・パラメータを定義できます。 serializer要素を省略すると、ユーザー定義型によって`PortableObject`インタフェースが実装され、`PortableObjectSerializer`実装が`PofSerializer`として使用されることになります。 `serializer`要素から`init-params`要素を省略した場合は、その`PofSerializer`実装に対して次の4つのコンストラクタが、ここに示された順序で試行されます。 `(int nTypeId, Class clz, ClassLoader loader)` `(int nTypeId, Class clz)` `(int nTypeId)` `()`

<type-id>

オプション

type-id要素は、ユーザー定義型を一意に識別する整数値(n >= 0)を指定します。user-type要素のいずれもtype-id要素を記述していない場合には、ユーザー定義型の型IDは、user-type-listに表示される順序に基づきます。そこでは、最初に割り当てられるユーザー定義型の型IDが0、2番目に割り当てられるユーザー定義型の型IDが1になります(以下同様)。ただし、スキーマのバージョニングおよび進化をサポートできるように、ユーザー定義型のIDを常に指定することを強くお薦めします。最初の1000個のIDは、Coherenceの内部使用に予約されているため、使用できません。

<class-name>

必須

class-name要素は、ユーザー定義型のすべての値にタイプの割当てが可能なJavaクラスまたはJavaインタフェースの完全修飾名を指定します。

<serializer>

オプション

serializer要素は、特定のユーザー定義型のシリアライズおよびデシリアライズに使用するPofSerializerを指定します。PofSerializerは、POFストリームとの間でのユーザー定義型の値のシリアライズおよびデシリアライズに使用されます。serializer要素の中にはclass-name要素が必要であり、init-params要素の中にはゼロ個以上のコンストラクタ・パラメータを定義できます。

serializer要素を省略すると、ユーザー定義型によってPortableObjectインタフェースが実装され、PortableObjectSerializer実装がPofSerializerとして使用されることになります。

serializer要素からinit-params要素を省略した場合は、そのPofSerializer実装に対して次の4つのコンストラクタが、ここに示された順序で試行されます。

(int nTypeId, Class clz, ClassLoader loader)
(int nTypeId, Class clz)
(int nTypeId)
()

C.2.7 user-type-list

使用場所: pof-config

説明

user-type-list要素には、ゼロ個以上のuser-type要素を記述します。使用されるPOFユーザー定義型はそれぞれ、user-type-listに一覧表示されている必要があります。

user-type-list要素には、ゼロ個以上のinclude要素も記述できます。それぞれのinclude要素は、別のpof-configファイルで定義されたuser-type要素の追加に使用されます。

要素

表C-7で、user-type-list要素のサブ要素を説明します。

表C-7 user-type-listのサブ要素

要素必須/ オプション説明

要素	必須/ オプション	説明
<`user-type`>	オプション	`user-type`要素には、POFユーザー定義型の宣言を記述します。POFユーザー定義型は、一意の識別、移植、バージョニングが可能なオブジェクト・クラスで、言語、オペレーティング・システム、ハードウェアおよび場所に関係なく、システム間で通信できます。任意の数の`<user-type>`要素を指定できます。 `user-type`要素の中では`type-id`要素を省略できますが、スキーマのバージョニングおよび進化をサポートできるように、使用することを強くお薦めします。 `user-type`要素の中には`class-name`要素が必要であり、ユーザー定義型のすべての値にタイプの割当てが可能なJavaクラスまたはJavaインタフェースの完全修飾名を指定します。 `serializer`要素を省略すると、ユーザー定義型によって`PortableObject`インタフェースが実装され、`PortableObjectSerializer`実装が`PofSerializer`として使用されることになります。
`<include>`	オプション	`include`要素は、`user-type`要素のロード元であるPOF構成ファイルの場所を指定します。この値は、ロード先のファイルの場所を特定するロケータ文字列(有効なパスとURLのいずれか)です。任意の数の`<include>`要素を指定できます。

<user-type>

オプション

user-type要素には、POFユーザー定義型の宣言を記述します。POFユーザー定義型は、一意の識別、移植、バージョニングが可能なオブジェクト・クラスで、言語、オペレーティング・システム、ハードウェアおよび場所に関係なく、システム間で通信できます。任意の数の<user-type>要素を指定できます。

<include>

オプション

include要素は、user-type要素のロード元であるPOF構成ファイルの場所を指定します。この値は、ロード先のファイルの場所を特定するロケータ文字列(有効なパスとURLのいずれか)です。任意の数の<include>要素を指定できます。