|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.omg.CORBA.Request
public abstract class Request
An object containing the information necessary for invoking a method. This class is the cornerstone of the ORB Dynamic Invocation Interface (DII), which allows dynamic creation and invocation of requests. A server cannot tell the difference between a client invocation using a client stub and a request using the DII.
A Request object consists of:
NVList containing arguments for the operation.NamedValue object, which has three
parts:
Any object)
Request objects may also contain additional information,
depending on how an operation was defined in the original IDL
interface definition. For example, where appropriate, they may contain
a NamedValue object to hold the return value or exception,
a context, a list of possible exceptions, and a list of
context strings that need to be resolved.
New Request objects are created using one of the
create_request methods in the Object class.
In other words, a create_request method is performed on the
object which is to be invoked.
NamedValue| Constructor Summary | |
|---|---|
Request()
|
|
| Method Summary | |
|---|---|
abstract Any |
add_in_arg()
Creates an input argument and adds it to this Request
object. |
abstract Any |
add_inout_arg()
Adds an input/output argument to this Request object. |
abstract Any |
add_named_in_arg(String name)
Creates an input argument with the given name and adds it to this Request object. |
abstract Any |
add_named_inout_arg(String name)
Adds an input/output argument with the given name to this Request object. |
abstract Any |
add_named_out_arg(String name)
Adds an output argument with the given name to this Request object. |
abstract Any |
add_out_arg()
Adds an output argument to this Request object. |
abstract NVList |
arguments()
Retrieves the NVList object containing the arguments
to the method being invoked. |
abstract ContextList |
contexts()
Retrieves the ContextList object for this request. |
abstract Context |
ctx()
Retrieves the Context object for this request. |
abstract void |
ctx(Context c)
Sets this request's Context object to the one given. |
abstract Environment |
env()
Retrieves the Environment object for this request. |
abstract ExceptionList |
exceptions()
Retrieves the ExceptionList object for this request. |
abstract void |
get_response()
Allows the user to access the response for the invocation triggered earlier with the send_deferred method. |
abstract void |
invoke()
Makes a synchronous invocation using the information in the Request object. |
abstract String |
operation()
Retrieves the name of the method to be invoked. |
abstract boolean |
poll_response()
Allows the user to determine whether a response has been received for the invocation triggered earlier with the send_deferred method. |
abstract NamedValue |
result()
Retrieves the NamedValue object containing the return
value for the method. |
abstract Any |
return_value()
Returns the Any object that contains the value for the
result of the method. |
abstract void |
send_deferred()
Makes an asynchronous invocation on the request. |
abstract void |
send_oneway()
Makes a oneway invocation on the request. |
abstract void |
set_return_type(TypeCode tc)
Sets the typecode for the return value of the method. |
abstract Object |
target()
Retrieves the the target object reference. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public Request()
| Method Detail |
|---|
public abstract Object target()
public abstract String operation()
public abstract NVList arguments()
NVList object containing the arguments
to the method being invoked. The elements in the list are
NamedValue objects, with each one describing an argument
to the method.
NVList object containing the arguments
for the methodpublic abstract NamedValue result()
NamedValue object containing the return
value for the method.
NamedValue object containing the result
of the methodpublic abstract Environment env()
Environment object for this request.
It contains the exception that the method being invoked has
thrown (after the invocation returns).
Environment object for this requestpublic abstract ExceptionList exceptions()
ExceptionList object for this request.
This list contains TypeCode objects describing the
exceptions that may be thrown by the method being invoked.
ExceptionList object describing the exceptions
that may be thrown by the method being invokedpublic abstract ContextList contexts()
ContextList object for this request.
This list contains context Strings that need to
be resolved and sent with the invocation.
public abstract Context ctx()
Context object for this request.
This is a list of properties giving information about the
client, the environment, or the circumstances of this request.
Context object that is to be used
to resolve any context strings whose
values need to be sent with the invocationpublic abstract void ctx(Context c)
Context object to the one given.
c - the new Context object to be used for
resolving context stringspublic abstract Any add_in_arg()
Request
object.
Any object that contains the
value and typecode for the input argument addedpublic abstract Any add_named_in_arg(String name)
Request object.
name - the name of the argument being added
Any object that contains the
value and typecode for the input argument addedpublic abstract Any add_inout_arg()
Request object.
Any object that contains the
value and typecode for the input/output argument addedpublic abstract Any add_named_inout_arg(String name)
Request object.
name - the name of the argument being added
Any object that contains the
value and typecode for the input/output argument addedpublic abstract Any add_out_arg()
Request object.
Any object that contains the
value and typecode for the output argument addedpublic abstract Any add_named_out_arg(String name)
Request object.
name - the name of the argument being added
Any object that contains the
value and typecode for the output argument addedpublic abstract void set_return_type(TypeCode tc)
tc - the TypeCode object containing type information
for the return valuepublic abstract Any return_value()
Any object that contains the value for the
result of the method.
Any object containing the value and
typecode for the return valuepublic abstract void invoke()
Request object. Exception information is
placed into the Request object's environment object.
public abstract void send_oneway()
public abstract void send_deferred()
poll_response and get_response to get
the result or exception information for the invocation.
public abstract boolean poll_response()
send_deferred method.
true if the method response has
been received; false otherwise
public abstract void get_response()
throws WrongTransaction
send_deferred method.
WrongTransaction - if the method get_response was invoked
from a different transaction's scope than the one from which the
request was originally sent. See the OMG Transaction Service specification
for details.
|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.