Request (Java 2 Platform SE 5.0)

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

Java^TM 2 Platform
Standard Ed. 5.0

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

org.omg.CORBA
クラス Request

java.lang.Object
  org.omg.CORBA.Request

public abstract class Request
extends Object
extends Object

メソッドを呼び出すために必要な情報を含むオブジェクトです。このクラスは、動的作成と要求の呼び出しを可能にする ORB Dynamic Invocation Interface (DII) に似ています。サーバがクライアントスタブを使用するクライアント呼び出しと DII を使用する要求の間の違いを示すことはできません。

次に、Request オブジェクトの構成要素を示します。

呼び出される操作の名前
操作の引数を含む NVList
リスト内の各項目は NamedValue オブジェクトで、次の 3 つの部分があります。
1. 引数の名前
2. 引数の値 (Any オブジェクト)
3. 引数が入力、出力、またはその両方かどうかを示す引数モードフラグ

操作が元の IDL インタフェース定義にどのように定義されているかによって、Request オブジェクトも追加情報を含むことがあります。たとえば、適切な場合は、戻り値または例外、コンテキスト、取り得る例外、および解決する必要のあるコンテキスト文字列のリストを保持するため、NamedValue オブジェクトを含むことがあります。

新規 Request オブジェクトは、Object クラス内の create_request メソッドの 1 つを使用して作成されます。つまり、create_request メソッドは、呼び出されるオブジェクトで実行されます。

関連項目:: NamedValue

コンストラクタの概要
`Request()`

メソッドの概要
`abstract Any`	`add_in_arg()` 入力引数を作成し、その入力引数をこの `Request` オブジェクトに追加します。
`abstract Any`	`add_inout_arg()` 入出力引数をこの `Request` オブジェクトに追加します。
`abstract Any`	`add_named_in_arg(String name)` 指定された名前の入力引数を作成し、その入力引数をこの `Request` オブジェクトに追加します。
`abstract Any`	`add_named_inout_arg(String name)` 指定された名前の入出力引数をこの `Request` オブジェクトに追加します。
`abstract Any`	`add_named_out_arg(String name)` 指定された名前の出力引数をこの `Request` オブジェクトに追加します。
`abstract Any`	`add_out_arg()` 出力引数をこの `Request` オブジェクトに追加します。
`abstract NVList`	`arguments()` 呼び出されるメソッドの引数を含む `NVList` オブジェクトを取得します。
`abstract ContextList`	`contexts()` この要求に対する `ContextList` オブジェクトを取得します。
`abstract Context`	`ctx()` この要求に対する `Context` オブジェクトを取得します。
`abstract void`	`ctx(Context c)` この要求の `Context` オブジェクトを、指定したオブジェクトに設定します。
`abstract Environment`	`env()` この要求に対する `Environment` オブジェクトを取得します。
`abstract ExceptionList`	`exceptions()` この要求に対する `ExceptionList` オブジェクトを取得します。
`abstract void`	`get_response()` `send_deferred` メソッドで以前にトリガされた呼び出しの応答に、ユーザがアクセスできます。
`abstract void`	`invoke()` `Request` オブジェクトの情報を使用して同期呼び出しを行います。
`abstract String`	`operation()` 呼び出されるメソッドの名前を取得します。
`abstract boolean`	`poll_response()` `send_deferred` メソッドで以前にトリガされた呼び出しに対して応答が受信されたかどうかを、ユーザが確認できます。
`abstract NamedValue`	`result()` メソッドの戻り値を含む `NamedValue` を取得します。
`abstract Any`	`return_value()` メソッドの結果に対する値を含む `Any` オブジェクトです。
`abstract void`	`send_deferred()` 要求で非同期を行います。
`abstract void`	`send_oneway()` 要求で一方向呼び出しを行います。
`abstract void`	`set_return_type(TypeCode tc)` メソッドの戻り値の型コードを設定します。
`abstract Object`	`target()` ターゲットオブジェクト参照を取得します。

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

コンストラクタの詳細

Request

public Request()

メソッドの詳細

target

public abstract Object target()

ターゲットオブジェクト参照を取得します。

戻り値:: 呼び出されるメソッドのオブジェクト実装を示すオブジェクト参照

operation

public abstract String operation()

呼び出されるメソッドの名前を取得します。

戻り値:: 呼び出されるメソッドの名前

arguments

public abstract NVList arguments()

呼び出されるメソッドの引数を含む NVList オブジェクトを取得します。リスト内の要素は NamedValue オブジェクトで、それぞれがメソッドの引数を記述します。

戻り値:: メソッドの引数を含む NVList オブジェクト

result

public abstract NamedValue result()

メソッドの戻り値を含む NamedValue を取得します。

戻り値:: メソッドの結果を含む NamedValue オブジェクト

env

public abstract Environment env()

この要求に対する Environment オブジェクトを取得します。これは、呼び出しが復帰したあと、呼び出されたメソッドがスローされたという例外を含みます。

戻り値:: この要求に対する Environment オブジェクト

exceptions

public abstract ExceptionList exceptions()

この要求に対する ExceptionList オブジェクトを取得します。このリストは、呼び出されるメソッドによってスローされることがある例外を記述する TypeCode オブジェクトを含みます。

戻り値:: 呼び出されるメソッドによってスローされることがある例外を記述する ExceptionList オブジェクト

contexts

public abstract ContextList contexts()

この要求に対する ContextList オブジェクトを取得します。このリストは、この呼び出しで解決して送る必要があるコンテキスト String を含みます。

戻り値:: この呼び出しで解決して送る必要があるコンテキスト文字列のリスト

ctx

public abstract Context ctx()

この要求に対する Context オブジェクトを取得します。これは、この要求のクライアント、環境、または状況に関する情報を提供するプロパティのリストです。

戻り値:: 呼び出しで値を渡す必要のある任意のコンテキスト文字列の解決で使用する Context オブジェクト

ctx

public abstract void ctx(Context c)

この要求の Context オブジェクトを、指定したオブジェクトに設定します。

パラメータ:: c - コンテキスト文字列を解決するために使用される新しい Context オブジェクト

add_in_arg

public abstract Any add_in_arg()

入力引数を作成し、その入力引数をこの Request オブジェクトに追加します。

戻り値:: 付加的な入力引数の値および型コードを含む Any オブジェクト

add_named_in_arg

public abstract Any add_named_in_arg(String name)

指定された名前の入力引数を作成し、その入力引数をこの Request オブジェクトに追加します。

パラメータ:: name - 追加される引数の名前
戻り値:: 付加的な入力引数の値および型コードを含む Any オブジェクト

add_inout_arg

public abstract Any add_inout_arg()

入出力引数をこの Request オブジェクトに追加します。

戻り値:: 付加的な入出力引数の値および型コードを含む Any オブジェクト

add_named_inout_arg

public abstract Any add_named_inout_arg(String name)

指定された名前の入出力引数をこの Request オブジェクトに追加します。

パラメータ:: name - 追加される引数の名前
戻り値:: 付加的な入出力引数の値および型コードを含む Any オブジェクト

add_out_arg

public abstract Any add_out_arg()

出力引数をこの Request オブジェクトに追加します。

戻り値:: 付加的な出力引数の値および型コードを含む Any オブジェクト

add_named_out_arg

public abstract Any add_named_out_arg(String name)

指定された名前の出力引数をこの Request オブジェクトに追加します。

パラメータ:: name - 追加される引数の名前
戻り値:: 付加的な出力引数の値および型コードを含む Any オブジェクト

set_return_type

public abstract void set_return_type(TypeCode tc)

メソッドの戻り値の型コードを設定します。

パラメータ:: tc - 戻り値の型情報を含む TypeCode オブジェクト

return_value

public abstract Any return_value()

メソッドの結果に対する値を含む Any オブジェクトです。

戻り値:: 戻り値の値および型コードを含む Any オブジェクト

invoke

public abstract void invoke()

Request オブジェクトの情報を使用して同期呼び出しを行います。例外情報は、Request オブジェクトの環境オブジェクトに格納されます。

send_oneway

public abstract void send_oneway()

要求で一方向呼び出しを行います。つまり、応答は前提とされたり待機されたりしません。これは、IDL 宣言で操作が一方向として宣言されていない場合でも使用できることに注意してください。応答または例外情報は返されません。

send_deferred

public abstract void send_deferred()

要求で非同期を行います。つまり、ユーザに返す前は応答を待機しません。ユーザは、あとでメソッド poll_response および get_response を使用して、呼び出しの結果または例外情報を取得します。

poll_response

public abstract boolean poll_response()

send_deferred メソッドで以前にトリガされた呼び出しに対して応答が受信されたかどうかを、ユーザが確認できます。

戻り値:: メソッド応答があらかじめ受信されている場合は true、そうでない場合は false

get_response

public abstract void get_response()
                           throws WrongTransaction

send_deferred メソッドで以前にトリガされた呼び出しの応答に、ユーザがアクセスできます。

例外:: WrongTransaction - 元の要求の送信元とは異なるトランザクションスコープから get_response メソッドが呼び出された場合。詳細は、「OMG Transaction Service 仕様」を参照

概要