クライアント API パッケージには、クライアントアプリケーションと CIM Object Manager 間でデータを転送するクラスとメソッドが含まれています。アプリケーションは、CIMClient クラスを使用して CIM Object Manager に接続し、次の表に示す CIMClient クラスのメソッドを使用して CIM Object Manager との間でデータ転送を行います。
表 3–3 クライアントメソッド
メソッド |
説明 |
---|---|
associators |
指定された CIM クラスまたはインスタンスに関連付けられている CIM クラスまたはインスタンスを取得する。 |
associatorNames |
指定された CIM クラスまたはインスタンスに関連付けられている CIM クラスまたはインスタンスの名前を取得する。 |
close |
CIM Object Manager へのクライアント接続を閉じる。このインタフェースは、クライアントセッションに使用されているリソースを解放する。 |
createClass |
CIM クラスを、指定されたネームスペースに追加する。 |
createInstance |
指定されたインスタンスが存在しない場合は、それを作成する。その CIM インスタンスがすでにある場合は、ID が CIM_ERR_ALREADY_EXISTS の CIMInstanceException をスローする。 |
createNameSpace |
CIM ネームスペース (クラスとインスタンスが入ったディレクトリ) を作成する。クライアントアプリケーションは、CIM Object Manager に接続する場合、ネームスペースを指定する。その後の処理はすべて、CIM Object Manager ホスト上のそのネームスペース内で発生する。 |
createQualifierType |
指定された CIM 修飾子型を、指定されたネームスペースに追加する。 |
deleteNameSpace |
指定されたホスト上の指定されたネームスペースを削除する。 |
deleteClass |
指定されたクラスを削除する。 |
deleteInstance |
指定されたインスタンスを削除する。 |
enumClass(CIMObjectPath path, boolean deep) |
Path で指定されたクラスを列挙する。このメソッドは、CIMObjectPath オブジェクトの列挙として 、各クラスの (内容ではなく) 名前を返す。deep が指定されていると、メソッドは、列挙されるクラスから派生したすべてのクラスの名前を列挙する。shallow が指定されていると、列挙するクラスの第一レベルの子の名前だけを列挙する。 |
enumClass(CIMObjectPath path, boolean deep, boolean localonly) |
Path で指定されたクラスを列挙する。このメソッドは、CIMClass オブジェクトの列挙として、クラスの名前だけでなく、クラスの内容全体を返す。deep が指定されていると、メソッドは、列挙されるクラスから派生したすべてのクラスを列挙する。shallow が指定されていると、列挙するクラスの第一レベルの子だけを列挙する。localOnly が真の場合は、継承されたプロパティやメソッド以外のプロパティやメソッドだけを返し、真でない場合は、すべてのプロパティとメソッドを返す。 |
enumInstances(CIMObjectPath path, boolean deep) |
Path で指定されたクラスのインスタンスを列挙する。このメソッドは、CIMObjectPath オブジェクトの列挙として、path で指定されたクラスのインスタンスの名前を返す。deep が真の場合は、指定されたクラスとこのクラスのすべての派生クラスのすべてのインスタンスの名前を返す。真でない場合は、指定されたクラスに属するインスタンスの名前だけを返す。 |
enumInstances(CIMObjectPath path, boolean deep, boolean localOnly) |
Path で指定されたクラスのインスタンスを列挙する。このメソッドは、CIMInstance オブジェクトの列挙として、指定されたクラスのインスタンス (インスタンスの名前だけでなく、インスタンス全体) を返す。 |
enumNameSpace |
ネームスペースのリストを取得する。 |
enumQualifierTypes |
指定されたクラス (1 つまたは複数) の、修飾子のデータ型を取得する。 |
execQuery(CIMObjectPath relNS, java.lang.String query, int ql) |
照会に指定されたプロパティ値と同じプロパティを持つインスタンスの列挙を返す。照会言語には ql を使用する。現在は、WQL (WBEM Query Language) だけがサポートされる。この照会言語は、CIM オブジェクトモデルを SQL テーブルにマップする。 |
getClass |
指定された CIM オブジェクトパスの CIM クラスを取得する。 |
getInstance |
指定された CIM オブジェクトパスの CIM インスタンスを取得する。 |
getProperty |
指定されたプロパティの値を返す。 |
getQualifierType |
指定された CIM オブジェクトパスの修飾子型を取得する。 |
invokeMethod |
指定されたオブジェクトに対して指定されたメソッドを実行する。メソッドは、メソッド名、戻り値のデータ型、およびメソッド内のパラメータを含む宣言である。 |
references |
指定された CIM クラスまたはインスタンスを参照する関連を取得する。 |
referenceNames |
指定された CIM クラスまたはインスタンスを参照する関連の名前を取得する。 |
setClass |
指定された CIM クラスが存在する場合は、それを更新する。その CIM クラスが存在しない場合は、エラーを返す。 |
setInstance |
指定された CIM インスタンスが存在する場合は、それを更新する。その CIM インスタンスが存在しない場合は、エラーを返す。 |
setProperty |
指定されたプロパティに、指定された値を設定する。 |
次の表で、com.sun.wbem.client パッケージに含まれているインスタンスについて説明します。
表 3–4 com.sun.wbem.client パッケージに含まれているインスタンス
インタフェース |
説明 |
---|---|
CIMOMHandle |
CIM Object Manager への参照をクライアントに提供する。このインタフェースには、クライアントが CIM Object Manager との間でデータを転送するときに使用するメソッドが含まれている。 |
ProviderCIMOMHandle |
CIM Object Manager への参照をプロバイダに提供する。このインタフェースには、プロバイダが CIM Object Manager との間でデータを転送するときに使用するメソッドが含まれている。 |
次の表で、ProviderCIMOMHandle インタフェースに含まれているメソッドについて説明します。
表 3–5 ProviderCIMOMHandle インタフェースのメソッド
メソッド |
説明 |
---|---|
decryptData |
指定された文字列の値を認証セッションキーを使って復号化する (暗号化されている場合)。 |
getCurrentAuditId |
リモートクライアント接続を識別するためのレコードを監査するときに使用されるセッション識別子 (一般には固有のもの) を返す。 |
getCurrentRole |
現在の認証済みユーザーが担う現在の役割を返す。 |
getCurrentUser |
プロバイダが呼び出される原因になった現在のユーザーを返す。 |
getInternalProvider |
内部インスタンスプロバイダへの参照を返す。この参照を使えば、プロバイダの静的インスタンスの情報を格納できる。 |