RequestImpl (Red Hat JBoss Enterprise Application Platform 7.2.0.Beta public API)

java.lang.Object
- org.omg.CORBA.Request
- - com.sun.corba.se.impl.corba.RequestImpl

public class RequestImpl
extends Request

Field Summary

Fields
Modifier and Type	Field and Description
`protected NVList`	`_arguments`
`protected Environment`	`_env`
`protected ExceptionList`	`_exceptions`
`protected boolean`	`_isOneWay`
`protected String`	`_opName`
`protected ORB`	`_orb`
`protected Object`	`_target`
`protected boolean`	`gotResponse`

Constructor Summary

Constructors
Constructor and Description
`RequestImpl(ORB orb, Object targetObject, Context ctx, String operationName, NVList argumentList, NamedValue resultContainer, ExceptionList exceptionList, ContextList ctxList)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add_exception(TypeCode exceptionType)`
`Any`	`add_in_arg()` Creates an input argument and adds it to this `Request` object.
`Any`	`add_inout_arg()` Adds an input/output argument to this `Request` object.
`Any`	`add_named_in_arg(String name)` Creates an input argument with the given name and adds it to this `Request` object.
`Any`	`add_named_inout_arg(String name)` Adds an input/output argument with the given name to this `Request` object.
`Any`	`add_named_out_arg(String name)` Adds an output argument with the given name to this `Request` object.
`Any`	`add_out_arg()` Adds an output argument to this `Request` object.
`NVList`	`arguments()` Retrieves the `NVList` object containing the arguments to the method being invoked.
`ContextList`	`contexts()` Retrieves the `ContextList` object for this request.
`Context`	`ctx()` Retrieves the `Context` object for this request.
`void`	`ctx(Context newCtx)` Sets this request's `Context` object to the one given.
`protected void`	`doInvocation()`
`Environment`	`env()` Retrieves the `Environment` object for this request.
`ExceptionList`	`exceptions()` Retrieves the `ExceptionList` object for this request.
`void`	`get_response()` Allows the user to access the response for the invocation triggered earlier with the `send_deferred` method.
`void`	`invoke()` Makes a synchronous invocation using the information in the `Request` object.
`String`	`operation()` Retrieves the name of the method to be invoked.
`boolean`	`poll_response()` Allows the user to determine whether a response has been received for the invocation triggered earlier with the `send_deferred` method.
`NamedValue`	`result()` Retrieves the `NamedValue` object containing the return value for the method.
`Any`	`return_value()` Returns the `Any` object that contains the value for the result of the method.
`void`	`send_deferred()` Makes an asynchronous invocation on the request.
`void`	`send_oneway()` Makes a oneway invocation on the request.
`void`	`set_return_type(TypeCode tc)` Sets the typecode for the return value of the method.
`Object`	`target()` Retrieves the the target object reference.
`void`	`unmarshalReply(InputStream is)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _target
```
protected Object _target
```
  - _opName
```
protected String _opName
```
  - _arguments
```
protected NVList _arguments
```
  - _exceptions
```
protected ExceptionList _exceptions
```
  - _env
```
protected Environment _env
```
  - _orb
```
protected ORB _orb
```
  - _isOneWay
```
protected boolean _isOneWay
```
  - gotResponse
```
protected boolean gotResponse
```
- Constructor Detail
  - RequestImpl
```
public RequestImpl(ORB orb,
                   Object targetObject,
                   Context ctx,
                   String operationName,
                   NVList argumentList,
                   NamedValue resultContainer,
                   ExceptionList exceptionList,
                   ContextList ctxList)
```
- Method Detail
  - target
```
public Object target()
```
    Description copied from class: Request
    
    Retrieves the the target object reference.
    
    Specified by:
    
    target in class Request
    
    Returns:
    
    the object reference that points to the object implementation for the method to be invoked
  - operation
```
public String operation()
```
    Description copied from class: Request
    
    Retrieves the name of the method to be invoked.
    
    Specified by:
    
    operation in class Request
    
    Returns:
    
    the name of the method to be invoked
  - arguments
```
public NVList arguments()
```
    Description copied from class: Request
    
    Retrieves the 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.
    
    Specified by:
    
    arguments in class Request
    
    Returns:
    
    the NVList object containing the arguments for the method
  - result
```
public NamedValue result()
```
    Description copied from class: Request
    
    Retrieves the NamedValue object containing the return value for the method.
    
    Specified by:
    
    result in class Request
    
    Returns:
    
    the NamedValue object containing the result of the method
  - env
```
public Environment env()
```
    Description copied from class: Request
    
    Retrieves the Environment object for this request. It contains the exception that the method being invoked has thrown (after the invocation returns).
    
    Specified by:
    
    env in class Request
    
    Returns:
    
    the Environment object for this request
  - exceptions
```
public ExceptionList exceptions()
```
    Description copied from class: Request
    
    Retrieves the ExceptionList object for this request. This list contains TypeCode objects describing the exceptions that may be thrown by the method being invoked.
    
    Specified by:
    
    exceptions in class Request
    
    Returns:
    
    the ExceptionList object describing the exceptions that may be thrown by the method being invoked
  - contexts
```
public ContextList contexts()
```
    Description copied from class: Request
    
    Retrieves the ContextList object for this request. This list contains context Strings that need to be resolved and sent with the invocation.
    
    Specified by:
    
    contexts in class Request
    
    Returns:
    
    the list of context strings whose values need to be resolved and sent with the invocation.
  - ctx
```
public Context ctx()
```
    Description copied from class: Request
    
    Retrieves the Context object for this request. This is a list of properties giving information about the client, the environment, or the circumstances of this request.
    
    Specified by:
    
    ctx in class Request
    
    Returns:
    
    the Context object that is to be used to resolve any context strings whose values need to be sent with the invocation
  - ctx
```
public void ctx(Context newCtx)
```
    Description copied from class: Request
    
    Sets this request's Context object to the one given.
    
    Specified by:
    
    ctx in class Request
    
    Parameters:
    
    newCtx - the new Context object to be used for resolving context strings
  - add_in_arg
```
public Any add_in_arg()
```
    Description copied from class: Request
    
    Creates an input argument and adds it to this Request object.
    
    Specified by:
    
    add_in_arg in class Request
    
    Returns:
    
    an Any object that contains the value and typecode for the input argument added
  - add_named_in_arg
```
public Any add_named_in_arg(String name)
```
    Description copied from class: Request
    
    Creates an input argument with the given name and adds it to this Request object.
    
    Specified by:
    
    add_named_in_arg in class Request
    
    Parameters:
    
    name - the name of the argument being added
    
    Returns:
    
    an Any object that contains the value and typecode for the input argument added
  - add_inout_arg
```
public Any add_inout_arg()
```
    Description copied from class: Request
    
    Adds an input/output argument to this Request object.
    
    Specified by:
    
    add_inout_arg in class Request
    
    Returns:
    
    an Any object that contains the value and typecode for the input/output argument added
  - add_named_inout_arg
```
public Any add_named_inout_arg(String name)
```
    Description copied from class: Request
    
    Adds an input/output argument with the given name to this Request object.
    
    Specified by:
    
    add_named_inout_arg in class Request
    
    Parameters:
    
    name - the name of the argument being added
    
    Returns:
    
    an Any object that contains the value and typecode for the input/output argument added
  - add_out_arg
```
public Any add_out_arg()
```
    Description copied from class: Request
    
    Adds an output argument to this Request object.
    
    Specified by:
    
    add_out_arg in class Request
    
    Returns:
    
    an Any object that contains the value and typecode for the output argument added
  - add_named_out_arg
```
public Any add_named_out_arg(String name)
```
    Description copied from class: Request
    
    Adds an output argument with the given name to this Request object.
    
    Specified by:
    
    add_named_out_arg in class Request
    
    Parameters:
    
    name - the name of the argument being added
    
    Returns:
    
    an Any object that contains the value and typecode for the output argument added
  - set_return_type
```
public void set_return_type(TypeCode tc)
```
    Description copied from class: Request
    
    Sets the typecode for the return value of the method.
    
    Specified by:
    
    set_return_type in class Request
    
    Parameters:
    
    tc - the TypeCode object containing type information for the return value
  - return_value
```
public Any return_value()
```
    Description copied from class: Request
    
    Returns the Any object that contains the value for the result of the method.
    
    Specified by:
    
    return_value in class Request
    
    Returns:
    
    an Any object containing the value and typecode for the return value
  - add_exception
```
public void add_exception(TypeCode exceptionType)
```
  - invoke
```
public void invoke()
```
    Description copied from class: Request
    
    Makes a synchronous invocation using the information in the Request object. Exception information is placed into the Request object's environment object.
    
    Specified by:
    
    invoke in class Request
  - send_oneway
```
public void send_oneway()
```
    Description copied from class: Request
    
    Makes a oneway invocation on the request. In other words, it does not expect or wait for a response. Note that this can be used even if the operation was not declared as oneway in the IDL declaration. No response or exception information is returned.
    
    Specified by:
    
    send_oneway in class Request
  - send_deferred
```
public void send_deferred()
```
    Description copied from class: Request
    
    Makes an asynchronous invocation on the request. In other words, it does not wait for a response before it returns to the user. The user can then later use the methods poll_response and get_response to get the result or exception information for the invocation.
    
    Specified by:
    
    send_deferred in class Request
  - poll_response
```
public boolean poll_response()
```
    Description copied from class: Request
    
    Allows the user to determine whether a response has been received for the invocation triggered earlier with the send_deferred method.
    
    Specified by:
    
    poll_response in class Request
    
    Returns:
    
    true if the method response has been received; false otherwise
  - get_response
```
public void get_response()
                  throws WrongTransaction
```
    Description copied from class: Request
    
    Allows the user to access the response for the invocation triggered earlier with the send_deferred method.
    
    Specified by:
    
    get_response in class Request
    
    Throws:
    
    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.
  - doInvocation
```
protected void doInvocation()
```
  - unmarshalReply
```
public void unmarshalReply(InputStream is)
```

Class RequestImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_target

_opName

_arguments

_exceptions

_env

_orb

_isOneWay

gotResponse

Constructor Detail

RequestImpl

Method Detail

target

operation

arguments

result

env

exceptions

contexts

ctx

ctx

add_in_arg

add_named_in_arg

add_inout_arg

add_named_inout_arg

add_out_arg

add_named_out_arg

set_return_type

return_value

add_exception

invoke

send_oneway

send_deferred

poll_response

get_response

doInvocation

unmarshalReply