この節では、VDX Webサービスで利用できるメソッドの詳細を説明します。このAPIは、WSSDKツールキットで生成したJavaコードを使用することを前提にしています。別のWebサービスツールキットを使用する場合、APIは異なります。
すべてのメソッドがVdxServiceExceptionをスローします。 読みやすくするために、メソッドの署名のthrows節は省略されています。
この節では、IRemoveVdxインタフェースに関連する各メソッドの参照情報を説明しています。
実行中のVDXサービスのバージョン番号を返します。
構文: メソッドの署名を次に示します。
VersionVO getVersion() throws java.rmi.RemoteException;
あらかじめ定義された、グローバルクエリと呼ばれる検索を実行できます。グローバルクエリは、LDAPの検索に保存されます。これらは、一部のストアドプロシージャの機能を提供しています。
グローバルクエリを定義するには、ディレクトリ抽象化層エディタを使用する必要があります。詳細は、『Identity Managerユーザアプリケーション:設計ガイド』のディレクトリ抽象化層エディタに関する項目を参照してください。
構文: メソッドの署名を次に示します。
java.lang.String[] globalQuery(java.lang.String queryDN, StringMap queryParameterValues) throws VdxServiceException, java.rmi.RemoteException;
エンティティ、一連の属性、返されるデータをフィルタリングするクエリ式を指定したクエリを実行できます。
構文: メソッドの署名を次に示します。
EntityAttributeMap query(java.lang.String entityDefinition, java.lang.String[] attributeKeys, java.lang.String queryFilter) throws VdxServiceException, java.rmi.RemoteException;
query()メソッドのqueryFilterパラメータを使って、返されるデータをフィルタリングする検索条件の式を渡すことができます。この節では、これらの式の文法について説明します。
クエリ構文1: もっとも簡単な形式のクエリを次に示します。
RelationalExpression1
クエリ構文2: クエリでは、論理演算子を使って複数の式を組み合わせることができます。
RelationalExpession1 logicalOperator RelationalExpression2
クエリ構文3: 代わりに、括弧を使って式をセットオフすることができます。
(RelationalExpession1) logicalOperator (RelationalExpression2)
クエリ構文4: 括弧を使って、サブクエリをセットオフすることもできます。
RelationalExpession1 logicalOperator (RelationalExpression2 logicalOperator1 RelationalExpression3)
関係式は、同じ論理演算子で区切る必要があります。有効なクエリの列を次に示します。
expression1 AND expression2 AND expression3
次のクエリは無効になります。
expression1 AND expression2 OR expression3
次の例のように、括弧を使って条件グループを作成することができます。
expression1 AND (expression2 OR expression3)
関係式の構文: 関係式は、この構文に準拠していなければなりません。
attribute relationalOperator value
関係演算子: 関係演算子は次のいずれかでなければなりません。
> , < , >= , <= , = , != , !< , !> , !<= , !>= , STARTWITH, !STARTWITH, IN , !IN , PRESENT, !PRESENT
論理演算子: 論理演算子は次のいずれかでなければなりません。
AND, OR
値: 値側の式は、次のいずれかでなければなりません。
'foo',"foo", 1-9, true, false
関係演算子PRESENTと!PRESENTには、値は必要ありません。
単一のAttributeオブジェクトを返します。これを使って、ディレクトリ抽象化層の属性のデータを取得して、調べることができます。
構文: メソッドの署名を次に示します。
Attribute getAttribute(java.lang.String objectDN, java.lang.String entityDefinition, java.lang.String attributeKey) throws VdxServiceException, java.rmi.RemoteException;
Attributeオブジェクトの配列を返します。これを使って、ディレクトリ抽象化層の属性のデータを取得して、調べることができます。
構文: メソッドの署名を次に示します。
Attribute[] getAttributes(java.lang.String objectDN, java.lang.String entityDefinition, java.lang.String[] attributeKeys) throws VdxServiceException, java.rmi.RemoteException;
Attributeクラスは、ディレクトリ抽象化層の属性を表しています。
この節では、Attributeクラスに関する参照情報を説明しています。
Attributeクラスには、2つのコンストラクタがあります。
構文1: 引数を取得しないコンストラクタの構文を次に示します。
Attribute()
構文2: サポートするすべてのデータタイプの配列を引数として取得するコンストラクタの構文を次に示します。
Attribute(ByteArrayArray BinariesVal, BooleanArray BooleansVal, DateArray DatesVal, IntegerArray IntegersVal, StringArray StringsVal, AttributeType TypeVal)
属性のByteArrayArrayオブジェクトを返します。
構文: メソッドの署名を次に示します。
ByteArrayArray getBinaries()
属性のByteArrayArrayオブジェクトを設定します。
構文: メソッドの署名を次に示します。
void setBinaries(ByteArrayArray BinariesVal)
属性のBooleanArrayオブジェクトを返します。
構文: メソッドの署名を次に示します。
BooleanArray getBooleans()
属性のBooleanArrayオブジェクトを設定します。
構文: メソッドの署名を次に示します。
void setBooleans(BooleanArray BooleansVal)
属性のDateArrayオブジェクトを返します。
構文: メソッドの署名を次に示します。
DateArray getDates()
属性のDateArrayオブジェクトを設定します。
構文: メソッドの署名を次に示します。
void setDates(DateArray DatesVal)
属性のIntegerArrayオブジェクトを返します。
構文: メソッドの署名を次に示します。
IntegerArray getIntegers()
属性のIntegerArrayオブジェクトを設定します。
構文: メソッドの署名を次に示します。
void setIntegers(IntegerArray IntegersVal)
属性のStringArrayオブジェクトを返します。
構文: メソッドの署名を次に示します。
StringArray getStrings()
属性のStringArrayオブジェクトを設定します。
構文: メソッドの署名を次に示します。
void setStrings(StringArray StringsVal)
属性のAttributeTypeオブジェクトを返します。
構文: メソッドの署名を次に示します。
AttributeType getType()
属性のAttributeTypeオブジェクトを設定します。
構文: メソッドの署名を次に示します。
void setType(AttributeType TypeVal)
この節では、AttributeArrayクラスに関する参考情報を説明しています。
AttributeArrayクラスには、2つのコンストラクタがあります。
構文1: パラメータを取得しないコンストラクタの構文を次に示します。
AttributeArray()
構文2: AttributeArrayオブジェクトの配列をパラメータとして取得するコンストラクタの構文を次に示します。
AttributeArray(Attribute[] AttributeVal)
Attributeオブジェクトの配列を返します。
構文: メソッドの署名を次に示します。
Attribute[] getAttribute()
AttributeArrayクラスに関連するAttributeオブジェクトの配列を設定します。
構文: メソッドの署名を次に示します。
void setAttribute(Attribute[] AttributeVal)
この節では、AttributeTypeクラスに関する参考情報を説明しています。
AttributeTypeクラスは、1つのコンストラクタをサポートしています。
構文: コンストラクタの構文を次に示します。
protected AttributeType(java.lang.String value)
属性タイプを示す文字列を返します。
構文: メソッドの署名を次に示します。
java.lang.String getValue()
この節では、BooleanArrayクラスに関する参考情報を説明しています。
BooleanArrayクラスには、2つのコンストラクタがあります。
構文1: パラメータを取得しないコンストラクタの構文を次に示します。
BooleanArray()
構文2: ブール値をパラメータとして取得するコンストラクタの構文を次に示します。
BooleanArray(boolean[] BooleanVal)
属性のブール値の配列を返します。
構文: メソッドの署名を次に示します。
boolean[] getBoolean()
属性にブール値の配列を設定します。
構文: メソッドの署名を次に示します。
void setBoolean(boolean[] BooleanVal)
この節では、ByteArrayArrayクラスに関する参考情報を説明しています。
ByteArrayArrayクラスには、2つのコンストラクタがあります。
構文1: パラメータを取得しないコンストラクタの構文を次に示します。
ByteArrayArray()
構文2: Base 64バイナリ値をパラメータとして取得するコンストラクタの構文を次に示します。
ByteArrayArray(byte[][] Base64BinaryVal)
属性のバイトの2次元配列を返します。
構文: メソッドの署名を次に示します。
byte[][] getBase64Binary()
属性にバイトの2次元配列を設定します。
構文: メソッドの署名を次に示します。
void setBase64Binary(byte[][] Base64BinaryVal)
この節では、DateArrayクラスに関する参考情報を説明しています。
DateArrayクラスには、2つのコンストラクタがあります。
構文1: パラメータを取得しないコンストラクタの構文を次に示します。
DateArray()
構文2: カレンダ配列をパラメータとして取得するコンストラクタの構文を次に示します。
DateArray(java.util.Calendar[] DatetimeVal)
属性のカレンダオブジェクトの配列を返します。
構文: メソッドの署名を次に示します。
java.util.Calendar[] getDatetime()
属性にカレンダオブジェクトの配列を設定します。
構文: メソッドの署名を次に示します。
void setDatetime(java.util.Calendar[] DatetimeVal)
EntryAttributeMapクラスは、EntryArrayオブジェクトのコンテナです。 これは、スタブのクエリメソッドにより返されます。
この節では、EntryAttributeMapクラスに関連するメソッドの参考情報を説明しています。
EntryAttributeMapクラスには、2つのコンストラクタがあります。
構文1: パラメータを取得しないコンストラクタの構文を次に示します。
EntryAttributeMap()
構文2: EntryArrayオブジェクトをパラメータとして取得するコンストラクタの構文を次に示します。
EntityAttributeMap(EntryArray EntriesVal)
このEntryAttributeMapオブジェクト内に保管されているEntryArrayオブジェクトを返します。
構文: メソッドの署名を次に示します。
EntryArray getEntries()
このEntryAttributeMapオブジェクトにEntryArrayオブジェクトを設定します。
構文: メソッドの署名を次に示します。
void setEntry(EntryArray EntriesVal)
Entryクラスは、EntryArrayオブジェクト内のエントリを表します。
この節では、Entryクラスに関連する各メソッドの参照情報を説明しています。
Entryクラスには、2つのコンストラクタがあります。
構文1: パラメータを取得しないコンストラクタの構文を次に示します。
Entry()
構文2: キーの値と属性値の配列の2つのパラメータを取得するコンストラクタの構文を次に示します。
Entry(java.lang.String KeyVal, AttributeArray ValuesVal)
Entryオブジェクトに定義されているキーを返します。このキーは、属性を識別します。
構文: メソッドの署名を次に示します。
java.lang.String getKey()
Entryオブジェクトにキーを設定します。このキーは、属性を識別します。
構文: メソッドの署名を次に示します。
void setKey(java.lang.String KeyVal)
Entryオブジェクトの値を表すAttributeArrayオブジェクトを返します。
構文: メソッドの署名を次に示します。
AttributeArray getValues()
Entryオブジェクトに値を設定します。
構文: メソッドの署名を次に示します。
void setValues(AttributeArray ValuesVal)
EntryArrayクラスは、Entryオブジェクトの配列のコンテナです。これは、EntryAttributeMapオブジェクトにより保管されます。
この節では、EntryArrayクラスに関連するメソッドの参照情報を説明しています。
EntryArrayクラスには、2つのコンストラクタがあります。
構文1: パラメータを取得しないコンストラクタの構文を次に示します。
EntryArray()
構文2: Entryオブジェクトの配列をパラメータとして取得するコンストラクタの構文を次に示します。
EntryArray(Entry[] EntryVal)
EntryArrayオブジェクト内に保管されているEntryオブジェクトを返します。
構文: メソッドの署名を次に示します。
Entry[] getEntry()
このEntryArrayオブジェクトにEntryオブジェクトを設定します。
構文: メソッドの署名を次に示します。
void setEntry(Entry[] EntryVal)
この節では、IntegerArrayクラスに関する参考情報を説明しています。
IntegerArrayクラスには、2つのコンストラクタがあります。
構文1: パラメータを取得しないコンストラクタの構文を次に示します。
IntegerArray()
構文2: int配列をパラメータとして取得するコンストラクタの構文を次に示します。
IntegerArray(int[] IntVal)
属性の整数配列を返します。
構文: メソッドの署名を次に示します。
int[] getInt()
属性に整数配列を設定します。
構文: メソッドの署名を次に示します。
void setInt(int[] IntVal)
StringArrayクラスは、Stringオブジェクトの配列のコンテナです。query()およびgetAttributes()メソッドを呼び出す場合、StringArrayオブジェクトに値を取得する属性を指定して渡します。
この節では、StringArrayクラスに関する参照情報を説明しています。
StringArrayクラスには、2つのコンストラクタがあります。
構文1: パラメータを取得しないコンストラクタの構文を次に示します。
StringArray()
構文2: String配列をパラメータとして取得するコンストラクタの構文を次に示します。
StringArray(java.lang.String[] StringVal)
StringArrayオブジェクトに関連するStringオブジェクトの配列を返します。
構文: メソッドの署名を次に示します。
java.lang.String[] getString()
StringArrayオブジェクトに関連するStringオブジェクトの配列を設定します。
構文: メソッドの署名を次に示します。
void setString(java.lang.String[] StringVal)
StringEntryクラスは、StringEntryArrayクラスにより保管されます。
この節では、StringEntryクラスに関する参考情報を説明しています。
StringEntryクラスには、2つのコンストラクタがあります。
構文1: パラメータを取得しないコンストラクタの構文を次に示します。
StringEntry()
構文2: キーとStringの値をパラメータとして取得するコンストラクタの構文を次に示します。
StringEntry(java.lang.String KeyVal, java.lang.String ValuesVal)
StringEntryオブジェクトに定義されているキーを返します。
構文: メソッドの署名を次に示します。
java.lang.String getKey()
StringEntryオブジェクトにキーを設定します。
構文: メソッドの署名を次に示します。
void setKey(java.lang.String KeyVal)
StringEntryArrayクラスは、StringEntryオブジェクトの配列のコンテナです。これは、StringMapオブジェクトにより保管されます。
この節では、StringEntryArrayクラスに関する参考情報を説明しています。
StringEntryArrayクラスには、2つのコンストラクタがあります。
構文1: パラメータを取得しないコンストラクタの構文を次に示します。
StringEntryArray()
構文2: StringEntry配列をパラメータとして取得するコンストラクタの構文を次に示します。
StringEntryArray(StringEntry[] StringentryVal)
StringEntryArrayオブジェクトのキーを返します。
構文: メソッドの署名を次に示します。
StringEntry[] getStringentry()
StringEntryArrayオブジェクトのキーを設定します。
構文: メソッドの署名を次に示します。
void setStringentry(StringEntry[] StringentryVal)
StringMapは、StringEntryArrayオブジェクトのコンテナです。
この節では、StringMapクラスに関する参考情報を説明しています。
StringMapクラスには、2つのコンストラクタがあります。
構文1: パラメータを取得しないコンストラクタの構文を次に示します。
StringMap()
構文2: StringEntryArrayをパラメータとして取得するコンストラクタの構文を次に示します。
StringMap(StringEntryArray EntriesVal)
このStringMapオブジェクトに保管されているStringEntryArrayオブジェクトを返します。
構文: メソッドの署名を次に示します。
StringEntryArray getEntries()
このStringMapオブジェクトのStringEntryArrayオブジェクトを設定します。
構文: メソッドの署名を次に示します。
void setEntries(StringEntryArray EntriesVal)
この節では、VdxServiceインタフェースに関する参考情報を説明しています。
リモートサービスのスタブを取得します。このスタブは、タイプIRemoteVdxのポートです。
構文: メソッドの署名を次に示します。
IRemoteVdx getIRemoteVdxPort() throws javax.xml.rpc.ServiceException;
この節では、VersionVOクラスに関する参照情報を説明しています。
サービスのバージョン番号を返します。
構文: メソッドの署名を次に示します。
java.lang.String getValue()