Direct link to this page
JDK 1.6
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
/* * @(#)Request.java 1.26 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package org.omg.CORBA; /** * 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. * <P> * A <code>Request</code> object consists of: * <UL> * <LI>the name of the operation to be invoked * <LI>an <code>NVList</code> containing arguments for the operation.<BR> * Each item in the list is a <code>NamedValue</code> object, which has three * parts: * <OL> * <LI>the name of the argument * <LI>the value of the argument (as an <code>Any</code> object) * <LI>the argument mode flag indicating whether the argument is * for input, output, or both * </OL> * </UL> * <P> * <code>Request</code> 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 <code>NamedValue</code> 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. * <P> * New <code>Request</code> objects are created using one of the * <code>create_request</code> methods in the <code>Object</code> class. * In other words, a <code>create_request</code> method is performed on the * object which is to be invoked. * * @see org.omg.CORBA.NamedValue * * @version 1.13 09/09/97 */ public abstract class Request { /** * Retrieves the the target object reference. * * @return the object reference that points to the * object implementation for the method * to be invoked */ public abstract org.omg.CORBA.Object target(); /** * Retrieves the name of the method to be invoked. * * @return the name of the method to be invoked */ public abstract String operation(); /** * Retrieves the <code>NVList</code> object containing the arguments * to the method being invoked. The elements in the list are * <code>NamedValue</code> objects, with each one describing an argument * to the method. * * @return the <code>NVList</code> object containing the arguments * for the method * */ public abstract NVList arguments(); /** * Retrieves the <code>NamedValue</code> object containing the return * value for the method. * * @return the <code>NamedValue</code> object containing the result * of the method */ public abstract NamedValue result(); /** * Retrieves the <code>Environment</code> object for this request. * It contains the exception that the method being invoked has * thrown (after the invocation returns). * * * @return the <code>Environment</code> object for this request */ public abstract Environment env(); /** * Retrieves the <code>ExceptionList</code> object for this request. * This list contains <code>TypeCode</code> objects describing the * exceptions that may be thrown by the method being invoked. * * @return the <code>ExceptionList</code> object describing the exceptions * that may be thrown by the method being invoked */ public abstract ExceptionList exceptions(); /** * Retrieves the <code>ContextList</code> object for this request. * This list contains context <code>String</code>s that need to * be resolved and sent with the invocation. * * * @return the list of context strings whose values * need to be resolved and sent with the * invocation. */ public abstract ContextList contexts(); /** * Retrieves the <code>Context</code> object for this request. * This is a list of properties giving information about the * client, the environment, or the circumstances of this request. * * @return the <code>Context</code> object that is to be used * to resolve any context strings whose * values need to be sent with the invocation */ public abstract Context ctx(); /** * Sets this request's <code>Context</code> object to the one given. * * @param c the new <code>Context</code> object to be used for * resolving context strings */ public abstract void ctx(Context c); /** * Creates an input argument and adds it to this <code>Request</code> * object. * * @return an <code>Any</code> object that contains the * value and typecode for the input argument added */ public abstract Any add_in_arg(); /** * Creates an input argument with the given name and adds it to * this <code>Request</code> object. * * @param name the name of the argument being added * @return an <code>Any</code> object that contains the * value and typecode for the input argument added */ public abstract Any add_named_in_arg(String name); /** * Adds an input/output argument to this <code>Request</code> object. * * @return an <code>Any</code> object that contains the * value and typecode for the input/output argument added */ public abstract Any add_inout_arg(); /** * Adds an input/output argument with the given name to this * <code>Request</code> object. * * @param name the name of the argument being added * @return an <code>Any</code> object that contains the * value and typecode for the input/output argument added */ public abstract Any add_named_inout_arg(String name); /** * Adds an output argument to this <code>Request</code> object. * * @return an <code>Any</code> object that contains the * value and typecode for the output argument added */ public abstract Any add_out_arg(); /** * Adds an output argument with the given name to this * <code>Request</code> object. * * @param name the name of the argument being added * @return an <code>Any</code> object that contains the * value and typecode for the output argument added */ public abstract Any add_named_out_arg(String name); /** * Sets the typecode for the return * value of the method. * * @param tc the <code>TypeCode</code> object containing type information * for the return value */ public abstract void set_return_type(TypeCode tc); /** * Returns the <code>Any</code> object that contains the value for the * result of the method. * * @return an <code>Any</code> object containing the value and * typecode for the return value */ public abstract Any return_value(); /** * Makes a synchronous invocation using the * information in the <code>Request</code> object. Exception information is * placed into the <code>Request</code> object's environment object. */ public abstract void invoke(); /** * 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. */ public abstract void send_oneway(); /** * 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 * <code>poll_response</code> and <code>get_response</code> to get * the result or exception information for the invocation. */ public abstract void send_deferred(); /** * Allows the user to determine * whether a response has been received for the invocation triggered * earlier with the <code>send_deferred</code> method. * * @return <code>true</code> if the method response has * been received; <code>false</code> otherwise */ public abstract boolean poll_response(); /** * Allows the user to access the * response for the invocation triggered earlier with the * <code>send_deferred</code> method. * * @exception WrongTransaction if the method <code>get_response</code> 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. */ public abstract void get_response() throws WrongTransaction; };
