org.omg.CORBA

Class Request


public abstract class Request
extends Object

An object, containing the information, needed to invoke the method of the local or remote CORBA object. The Request is used in Dynamic Invocation Interface (DII) which allows dynamic creation of requests.

Method Summary

Any
add_in_arg()
Add the named input parameter that passes value to the method being invoked.
Any
add_inout_arg()
Add the input/output parameter that passes value both to and from the method being invoked.
Any
add_named_in_arg(String name)
Add the named input parameter that passes value to the method being invoked.
Any
add_named_inout_arg(String name)
Add the named input/output parameter that passes value both to and from the method being invoked.
Any
add_named_out_arg(String name)
Add the named output parameter that passes value from the method being invoked.
Any
add_out_arg()
Add the output parameter that passes value from the method being invoked.
NVList
arguments()
Return the list of all previously added parameters.
ContextList
contexts()
Get the context list object for this request.
Context
ctx()
Get the context, previously set using cts(Context).
void
ctx(Context a_context)
Set the context that shuld be later returned by ctx().
Environment
env()
Returns the container, eclosing an exception that the invoked method has thrown.
ExceptionList
exceptions()
List the exceptions that may be thrown by the CORBA object method being invoked.
void
get_response()
Allow to access the response that has been previously sent using send_deferred().
void
invoke()
Submit the request, suspending the current thread until the answer is received.
String
operation()
Get the name of the method being invoked.
boolean
poll_response()
Check if the response is received to the request that was previously send using send_deferred().
NamedValue
result()
Get the value, returned by the method, together with its name.
Any
return_value()
Get the value, returned by the method.
void
send_deferred()
Send a request without suspending the current thread.
void
send_oneway()
Send a request and forget about it, not waiting for a response.
void
set_return_type(TypeCode returns)
Set the return type.
Object
target()
Return the CORBA object on that the method would be invoked.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

add_in_arg

public Any add_in_arg()
Add the named input parameter that passes value to the method being invoked. This is similar to the "passing by value" conception. The created parameter is returned allowing to set the value.

Returns:
the created parameter.


add_inout_arg

public Any add_inout_arg()
Add the input/output parameter that passes value both to and from the method being invoked. This is similar to the "passing by reference" conception. The created parameter is returned allowing to set the value.

Returns:
the created parameter.


add_named_in_arg

public Any add_named_in_arg(String name)
Add the named input parameter that passes value to the method being invoked. This is similar to the "passing by value" conception. The created parameter is returned allowing to set the value.

Parameters:
name - the parameter name.

Returns:
the created parameter.


add_named_inout_arg

public Any add_named_inout_arg(String name)
Add the named input/output parameter that passes value both to and from the method being invoked. This is similar to the "passing by reference" conception. The created parameter is returned allowing to set the value.

Parameters:
name - the parameter name.

Returns:
the created parameter.


add_named_out_arg

public Any add_named_out_arg(String name)
Add the named output parameter that passes value from the method being invoked. Differently from the java language, the CORBA IDL method can return multiple values. The created parameter is returned allowing to set the value.

Parameters:
name - the parameter name.

Returns:
the created parameter.


add_out_arg

public Any add_out_arg()
Add the output parameter that passes value from the method being invoked. Differently from the java language, the CORBA IDL method can return multiple values. The created parameter is returned allowing to set the value.

Returns:
the created parameter.


arguments

public NVList arguments()
Return the list of all previously added parameters.

Returns:
the list of parameters.


contexts

public ContextList contexts()
Get the context list object for this request.

Returns:
a list of strings that must be resolved and sent with the invocation.


ctx

public Context ctx()
Get the context, previously set using cts(Context). The context contains the details about this request.


ctx

public void ctx(Context a_context)
Set the context that shuld be later returned by ctx(). This context contains the details about this request.

Parameters:
a_context - a context to set.


env

public Environment env()
Returns the container, eclosing an exception that the invoked method has thrown.

Returns:
the Environment object, containng the exception.


exceptions

public ExceptionList exceptions()
List the exceptions that may be thrown by the CORBA object method being invoked.

Returns:
the list of exceptions.


get_response

public void get_response()
            throws WrongTransaction
Allow to access the response that has been previously sent using send_deferred().

Throws:
WrongTransaction - if the transaction scope mismatches.


invoke

public void invoke()
Submit the request, suspending the current thread until the answer is received.


operation

public String operation()
Get the name of the method being invoked.

Returns:
the name of the method being invoked.


poll_response

public boolean poll_response()
Check if the response is received to the request that was previously send using send_deferred().

Returns:
true if the response has been already received, false otherwise.


result

public NamedValue result()
Get the value, returned by the method, together with its name.

Returns:
the value, returned by the method.


return_value

public Any return_value()
Get the value, returned by the method.

Returns:
the value, returned by the method.


send_deferred

public void send_deferred()
Send a request without suspending the current thread. Allow later check of the request status by poll_response() and retrieving the results by get_response().


send_oneway

public void send_oneway()
Send a request and forget about it, not waiting for a response. This can be done also for methods that normally are expected to return some values.


set_return_type

public void set_return_type(TypeCode returns)
Set the return type.

Parameters:
returns - the type of the value, returned in response to this request.


target

public Object target()
Return the CORBA object on that the method would be invoked.

Returns:
the invocation target.


Request.java -- Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.