src/share/classes/com/sun/corba/se/impl/io/InputStreamHook.java

Tue, 30 Apr 2013 11:53:51 +0100

author
coffeys
date
Tue, 30 Apr 2013 11:53:51 +0100
changeset 478
80161c61aa68
parent 158
91006f157c46
child 553
5ca1b4c282b8
child 561
b083590cb088
permissions
-rw-r--r--

8000642: Better handling of objects for transportation
Reviewed-by: alanb, mchung, skoivu

duke@1 1 /*
ohair@158 2 * Copyright (c) 1999, 2004, Oracle and/or its affiliates. All rights reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
ohair@158 7 * published by the Free Software Foundation. Oracle designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
ohair@158 9 * by Oracle in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
ohair@158 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@158 22 * or visit www.oracle.com if you need additional information or have any
ohair@158 23 * questions.
duke@1 24 */
duke@1 25 /*
duke@1 26 * Licensed Materials - Property of IBM
duke@1 27 * RMI-IIOP v1.0
duke@1 28 * Copyright IBM Corp. 1998 1999 All Rights Reserved
duke@1 29 *
duke@1 30 */
duke@1 31
duke@1 32 package com.sun.corba.se.impl.io;
duke@1 33
duke@1 34 import java.io.IOException;
duke@1 35 import java.io.StreamCorruptedException;
duke@1 36 import java.io.NotActiveException;
duke@1 37 import java.io.InputStream;
duke@1 38 import java.io.ObjectInputStream;
duke@1 39 import java.util.*;
duke@1 40 import java.lang.reflect.Array;
duke@1 41 import java.lang.reflect.Constructor;
duke@1 42
duke@1 43 import org.omg.CORBA.portable.ValueInputStream;
duke@1 44
duke@1 45 import com.sun.corba.se.spi.orb.ORB;
duke@1 46 import com.sun.corba.se.spi.orb.ORBVersion;
duke@1 47 import com.sun.corba.se.spi.orb.ORBVersionFactory;
duke@1 48 import com.sun.corba.se.spi.logging.CORBALogDomains;
duke@1 49 import com.sun.corba.se.impl.logging.UtilSystemException;
duke@1 50 import com.sun.corba.se.impl.logging.OMGSystemException;
duke@1 51
duke@1 52 public abstract class InputStreamHook extends ObjectInputStream
duke@1 53 {
duke@1 54 // These should be visible in all the nested classes
duke@1 55 static final OMGSystemException omgWrapper =
duke@1 56 OMGSystemException.get( CORBALogDomains.RPC_ENCODING ) ;
duke@1 57
duke@1 58 static final UtilSystemException utilWrapper =
duke@1 59 UtilSystemException.get( CORBALogDomains.RPC_ENCODING ) ;
duke@1 60
duke@1 61 private class HookGetFields extends ObjectInputStream.GetField {
duke@1 62 private Map fields = null;
duke@1 63
duke@1 64 HookGetFields(Map fields){
duke@1 65 this.fields = fields;
duke@1 66 }
duke@1 67
duke@1 68 /**
duke@1 69 * Get the ObjectStreamClass that describes the fields in the stream.
duke@1 70 *
duke@1 71 * REVISIT! This doesn't work since we have our own ObjectStreamClass.
duke@1 72 */
duke@1 73 public java.io.ObjectStreamClass getObjectStreamClass() {
duke@1 74 return null;
duke@1 75 }
duke@1 76
duke@1 77 /**
duke@1 78 * Return true if the named field is defaulted and has no value
duke@1 79 * in this stream.
duke@1 80 */
duke@1 81 public boolean defaulted(String name)
duke@1 82 throws IOException, IllegalArgumentException {
duke@1 83 return (!fields.containsKey(name));
duke@1 84 }
duke@1 85
duke@1 86 /**
duke@1 87 * Get the value of the named boolean field from the persistent field.
duke@1 88 */
duke@1 89 public boolean get(String name, boolean defvalue)
duke@1 90 throws IOException, IllegalArgumentException {
duke@1 91 if (defaulted(name))
duke@1 92 return defvalue;
duke@1 93 else return ((Boolean)fields.get(name)).booleanValue();
duke@1 94 }
duke@1 95
duke@1 96 /**
duke@1 97 * Get the value of the named char field from the persistent fields.
duke@1 98 */
duke@1 99 public char get(String name, char defvalue)
duke@1 100 throws IOException, IllegalArgumentException {
duke@1 101 if (defaulted(name))
duke@1 102 return defvalue;
duke@1 103 else return ((Character)fields.get(name)).charValue();
duke@1 104
duke@1 105 }
duke@1 106
duke@1 107 /**
duke@1 108 * Get the value of the named byte field from the persistent fields.
duke@1 109 */
duke@1 110 public byte get(String name, byte defvalue)
duke@1 111 throws IOException, IllegalArgumentException {
duke@1 112 if (defaulted(name))
duke@1 113 return defvalue;
duke@1 114 else return ((Byte)fields.get(name)).byteValue();
duke@1 115
duke@1 116 }
duke@1 117
duke@1 118 /**
duke@1 119 * Get the value of the named short field from the persistent fields.
duke@1 120 */
duke@1 121 public short get(String name, short defvalue)
duke@1 122 throws IOException, IllegalArgumentException {
duke@1 123 if (defaulted(name))
duke@1 124 return defvalue;
duke@1 125 else return ((Short)fields.get(name)).shortValue();
duke@1 126
duke@1 127 }
duke@1 128
duke@1 129 /**
duke@1 130 * Get the value of the named int field from the persistent fields.
duke@1 131 */
duke@1 132 public int get(String name, int defvalue)
duke@1 133 throws IOException, IllegalArgumentException {
duke@1 134 if (defaulted(name))
duke@1 135 return defvalue;
duke@1 136 else return ((Integer)fields.get(name)).intValue();
duke@1 137
duke@1 138 }
duke@1 139
duke@1 140 /**
duke@1 141 * Get the value of the named long field from the persistent fields.
duke@1 142 */
duke@1 143 public long get(String name, long defvalue)
duke@1 144 throws IOException, IllegalArgumentException {
duke@1 145 if (defaulted(name))
duke@1 146 return defvalue;
duke@1 147 else return ((Long)fields.get(name)).longValue();
duke@1 148
duke@1 149 }
duke@1 150
duke@1 151 /**
duke@1 152 * Get the value of the named float field from the persistent fields.
duke@1 153 */
duke@1 154 public float get(String name, float defvalue)
duke@1 155 throws IOException, IllegalArgumentException {
duke@1 156 if (defaulted(name))
duke@1 157 return defvalue;
duke@1 158 else return ((Float)fields.get(name)).floatValue();
duke@1 159
duke@1 160 }
duke@1 161
duke@1 162 /**
duke@1 163 * Get the value of the named double field from the persistent field.
duke@1 164 */
duke@1 165 public double get(String name, double defvalue)
duke@1 166 throws IOException, IllegalArgumentException {
duke@1 167 if (defaulted(name))
duke@1 168 return defvalue;
duke@1 169 else return ((Double)fields.get(name)).doubleValue();
duke@1 170
duke@1 171 }
duke@1 172
duke@1 173 /**
duke@1 174 * Get the value of the named Object field from the persistent field.
duke@1 175 */
duke@1 176 public Object get(String name, Object defvalue)
duke@1 177 throws IOException, IllegalArgumentException {
duke@1 178 if (defaulted(name))
duke@1 179 return defvalue;
duke@1 180 else return fields.get(name);
duke@1 181
duke@1 182 }
duke@1 183
duke@1 184 public String toString(){
duke@1 185 return fields.toString();
duke@1 186 }
duke@1 187 }
duke@1 188
duke@1 189 public InputStreamHook()
duke@1 190 throws IOException {
duke@1 191 super();
duke@1 192 }
duke@1 193
duke@1 194 public void defaultReadObject()
duke@1 195 throws IOException, ClassNotFoundException, NotActiveException
duke@1 196 {
duke@1 197 readObjectState.beginDefaultReadObject(this);
duke@1 198
duke@1 199 defaultReadObjectDelegate();
duke@1 200
duke@1 201 readObjectState.endDefaultReadObject(this);
duke@1 202 }
duke@1 203
duke@1 204 public abstract void defaultReadObjectDelegate();
duke@1 205
duke@1 206 abstract void readFields(java.util.Map fieldToValueMap)
duke@1 207 throws java.io.InvalidClassException, java.io.StreamCorruptedException,
duke@1 208 ClassNotFoundException, java.io.IOException;
duke@1 209
duke@1 210
duke@1 211 // See java.io.ObjectInputStream.GetField
duke@1 212 // Remember that this is equivalent to defaultReadObject
duke@1 213 // in RMI-IIOP
duke@1 214 public ObjectInputStream.GetField readFields()
duke@1 215 throws IOException, ClassNotFoundException, NotActiveException {
duke@1 216
duke@1 217 HashMap fieldValueMap = new HashMap();
duke@1 218
duke@1 219 // We were treating readFields same as defaultReadObject. It is
duke@1 220 // incorrect if the state is readOptionalData. If this line
duke@1 221 // is uncommented, it will throw a stream corrupted exception.
duke@1 222 // _REVISIT_: The ideal fix would be to add a new state. In
duke@1 223 // writeObject user may do one of the following
duke@1 224 // 1. Call defaultWriteObject()
duke@1 225 // 2. Put out optional fields
duke@1 226 // 3. Call writeFields
duke@1 227 // We have the state defined for (1) and (2) but not for (3), so
duke@1 228 // we should ideally introduce a new state for 3 and have the
duke@1 229 // beginDefaultReadObject do nothing.
duke@1 230 //readObjectState.beginDefaultReadObject(this);
duke@1 231
duke@1 232 readFields(fieldValueMap);
duke@1 233
duke@1 234 readObjectState.endDefaultReadObject(this);
duke@1 235
duke@1 236 return new HookGetFields(fieldValueMap);
duke@1 237 }
duke@1 238
duke@1 239 // The following is a State pattern implementation of what
duke@1 240 // should be done when the sender's Serializable has a
duke@1 241 // writeObject method. This was especially necessary for
duke@1 242 // RMI-IIOP stream format version 2. Please see the
duke@1 243 // state diagrams in the docs directory of the workspace.
duke@1 244 //
duke@1 245 // On the reader's side, the main factors are whether or not
duke@1 246 // we have a readObject method and whether or not the
duke@1 247 // sender wrote default data
duke@1 248
duke@1 249 protected void setState(ReadObjectState newState) {
duke@1 250 readObjectState = newState;
duke@1 251 }
duke@1 252
duke@1 253 protected abstract byte getStreamFormatVersion();
coffeys@478 254 abstract org.omg.CORBA_2_3.portable.InputStream getOrbStream();
duke@1 255
duke@1 256 // Description of possible actions
duke@1 257 protected static class ReadObjectState {
duke@1 258 public void beginUnmarshalCustomValue(InputStreamHook stream,
duke@1 259 boolean calledDefaultWriteObject,
duke@1 260 boolean hasReadObject) throws IOException {}
duke@1 261
duke@1 262 public void endUnmarshalCustomValue(InputStreamHook stream) throws IOException {}
duke@1 263 public void beginDefaultReadObject(InputStreamHook stream) throws IOException {}
duke@1 264 public void endDefaultReadObject(InputStreamHook stream) throws IOException {}
duke@1 265 public void readData(InputStreamHook stream) throws IOException {}
duke@1 266 }
duke@1 267
duke@1 268 protected ReadObjectState readObjectState = DEFAULT_STATE;
duke@1 269
duke@1 270 protected static final ReadObjectState DEFAULT_STATE = new DefaultState();
duke@1 271 protected static final ReadObjectState IN_READ_OBJECT_OPT_DATA
duke@1 272 = new InReadObjectOptionalDataState();
duke@1 273 protected static final ReadObjectState IN_READ_OBJECT_NO_MORE_OPT_DATA
duke@1 274 = new InReadObjectNoMoreOptionalDataState();
duke@1 275 protected static final ReadObjectState IN_READ_OBJECT_DEFAULTS_SENT
duke@1 276 = new InReadObjectDefaultsSentState();
duke@1 277 protected static final ReadObjectState NO_READ_OBJECT_DEFAULTS_SENT
duke@1 278 = new NoReadObjectDefaultsSentState();
duke@1 279
duke@1 280 protected static final ReadObjectState IN_READ_OBJECT_REMOTE_NOT_CUSTOM_MARSHALED
duke@1 281 = new InReadObjectRemoteDidNotUseWriteObjectState();
duke@1 282 protected static final ReadObjectState IN_READ_OBJECT_PAST_DEFAULTS_REMOTE_NOT_CUSTOM
duke@1 283 = new InReadObjectPastDefaultsRemoteDidNotUseWOState();
duke@1 284
duke@1 285 protected static class DefaultState extends ReadObjectState {
duke@1 286
duke@1 287 public void beginUnmarshalCustomValue(InputStreamHook stream,
duke@1 288 boolean calledDefaultWriteObject,
duke@1 289 boolean hasReadObject)
duke@1 290 throws IOException {
duke@1 291
duke@1 292 if (hasReadObject) {
duke@1 293 if (calledDefaultWriteObject)
duke@1 294 stream.setState(IN_READ_OBJECT_DEFAULTS_SENT);
duke@1 295 else {
duke@1 296 try {
duke@1 297 if (stream.getStreamFormatVersion() == 2)
duke@1 298 ((ValueInputStream)stream.getOrbStream()).start_value();
duke@1 299 } catch( Exception e ) {
duke@1 300 // This will happen for Big Integer which uses
duke@1 301 // writeFields in it's writeObject. We should be past
duke@1 302 // start_value by now.
duke@1 303 // NOTE: If we don't log any exception here we should
duke@1 304 // be fine. If there is an error, it will be caught
duke@1 305 // while reading the optional data.
duke@1 306
duke@1 307 }
duke@1 308 stream.setState(IN_READ_OBJECT_OPT_DATA);
duke@1 309 }
duke@1 310 } else {
duke@1 311 if (calledDefaultWriteObject)
duke@1 312 stream.setState(NO_READ_OBJECT_DEFAULTS_SENT);
duke@1 313 else
duke@1 314 // XXX I18N and logging needed.
duke@1 315 throw new StreamCorruptedException("No default data sent");
duke@1 316 }
duke@1 317 }
duke@1 318 }
duke@1 319
duke@1 320 // REVISIT. If a readObject exits here without reading
duke@1 321 // default data, we won't skip it. This could be done automatically
duke@1 322 // as in line 1492 in IIOPInputStream.
duke@1 323 protected static class InReadObjectRemoteDidNotUseWriteObjectState extends ReadObjectState {
duke@1 324
duke@1 325 public void beginUnmarshalCustomValue(InputStreamHook stream,
duke@1 326 boolean calledDefaultWriteObject,
duke@1 327 boolean hasReadObject)
duke@1 328 {
duke@1 329 throw utilWrapper.badBeginUnmarshalCustomValue() ;
duke@1 330 }
duke@1 331
duke@1 332 public void endDefaultReadObject(InputStreamHook stream) {
duke@1 333 stream.setState(IN_READ_OBJECT_PAST_DEFAULTS_REMOTE_NOT_CUSTOM);
duke@1 334 }
duke@1 335
duke@1 336 public void readData(InputStreamHook stream) {
duke@1 337 stream.throwOptionalDataIncompatibleException();
duke@1 338 }
duke@1 339 }
duke@1 340
duke@1 341 protected static class InReadObjectPastDefaultsRemoteDidNotUseWOState extends ReadObjectState {
duke@1 342
duke@1 343 public void beginUnmarshalCustomValue(InputStreamHook stream,
duke@1 344 boolean calledDefaultWriteObject,
duke@1 345 boolean hasReadObject)
duke@1 346 {
duke@1 347 throw utilWrapper.badBeginUnmarshalCustomValue() ;
duke@1 348 }
duke@1 349
duke@1 350 public void beginDefaultReadObject(InputStreamHook stream) throws IOException
duke@1 351 {
duke@1 352 // XXX I18N and logging needed.
duke@1 353 throw new StreamCorruptedException("Default data already read");
duke@1 354 }
duke@1 355
duke@1 356
duke@1 357 public void readData(InputStreamHook stream) {
duke@1 358 stream.throwOptionalDataIncompatibleException();
duke@1 359 }
duke@1 360 }
duke@1 361
duke@1 362 protected void throwOptionalDataIncompatibleException()
duke@1 363 {
duke@1 364 throw omgWrapper.rmiiiopOptionalDataIncompatible2() ;
duke@1 365 }
duke@1 366
duke@1 367
duke@1 368 protected static class InReadObjectDefaultsSentState extends ReadObjectState {
duke@1 369
duke@1 370 public void beginUnmarshalCustomValue(InputStreamHook stream,
duke@1 371 boolean calledDefaultWriteObject,
duke@1 372 boolean hasReadObject) {
duke@1 373 // This should never happen.
duke@1 374 throw utilWrapper.badBeginUnmarshalCustomValue() ;
duke@1 375 }
duke@1 376
duke@1 377 public void endUnmarshalCustomValue(InputStreamHook stream) {
duke@1 378
duke@1 379 // In stream format version 2, we can skip over
duke@1 380 // the optional data this way. In stream format version 1,
duke@1 381 // we will probably wind up with an error if we're
duke@1 382 // unmarshaling a superclass.
duke@1 383 if (stream.getStreamFormatVersion() == 2) {
duke@1 384 ((ValueInputStream)stream.getOrbStream()).start_value();
duke@1 385 ((ValueInputStream)stream.getOrbStream()).end_value();
duke@1 386 }
duke@1 387
duke@1 388 stream.setState(DEFAULT_STATE);
duke@1 389 }
duke@1 390
duke@1 391 public void endDefaultReadObject(InputStreamHook stream) throws IOException {
duke@1 392
duke@1 393 // Read the fake valuetype header in stream format version 2
duke@1 394 if (stream.getStreamFormatVersion() == 2)
duke@1 395 ((ValueInputStream)stream.getOrbStream()).start_value();
duke@1 396
duke@1 397 stream.setState(IN_READ_OBJECT_OPT_DATA);
duke@1 398 }
duke@1 399
duke@1 400 public void readData(InputStreamHook stream) throws IOException {
duke@1 401 org.omg.CORBA.ORB orb = stream.getOrbStream().orb();
duke@1 402 if ((orb == null) ||
duke@1 403 !(orb instanceof com.sun.corba.se.spi.orb.ORB)) {
duke@1 404 throw new StreamCorruptedException(
duke@1 405 "Default data must be read first");
duke@1 406 }
duke@1 407 ORBVersion clientOrbVersion =
duke@1 408 ((com.sun.corba.se.spi.orb.ORB)orb).getORBVersion();
duke@1 409
duke@1 410 // Fix Date interop bug. For older versions of the ORB don't do
duke@1 411 // anything for readData(). Before this used to throw
duke@1 412 // StreamCorruptedException for older versions of the ORB where
duke@1 413 // calledDefaultWriteObject always returns true.
duke@1 414 if ((ORBVersionFactory.getPEORB().compareTo(clientOrbVersion) <= 0) ||
duke@1 415 (clientOrbVersion.equals(ORBVersionFactory.getFOREIGN()))) {
duke@1 416 // XXX I18N and logging needed.
duke@1 417 throw new StreamCorruptedException("Default data must be read first");
duke@1 418 }
duke@1 419 }
duke@1 420 }
duke@1 421
duke@1 422 protected static class InReadObjectOptionalDataState extends ReadObjectState {
duke@1 423
duke@1 424 public void beginUnmarshalCustomValue(InputStreamHook stream,
duke@1 425 boolean calledDefaultWriteObject,
duke@1 426 boolean hasReadObject)
duke@1 427 {
duke@1 428 // This should never happen.
duke@1 429 throw utilWrapper.badBeginUnmarshalCustomValue() ;
duke@1 430 }
duke@1 431
duke@1 432 public void endUnmarshalCustomValue(InputStreamHook stream) throws IOException
duke@1 433 {
duke@1 434 if (stream.getStreamFormatVersion() == 2) {
duke@1 435 ((ValueInputStream)stream.getOrbStream()).end_value();
duke@1 436 }
duke@1 437 stream.setState(DEFAULT_STATE);
duke@1 438 }
duke@1 439
duke@1 440 public void beginDefaultReadObject(InputStreamHook stream) throws IOException
duke@1 441 {
duke@1 442 // XXX I18N and logging needed.
duke@1 443 throw new StreamCorruptedException("Default data not sent or already read/passed");
duke@1 444 }
duke@1 445
duke@1 446
duke@1 447 }
duke@1 448
duke@1 449 protected static class InReadObjectNoMoreOptionalDataState
duke@1 450 extends InReadObjectOptionalDataState {
duke@1 451
duke@1 452 public void readData(InputStreamHook stream) throws IOException {
duke@1 453 stream.throwOptionalDataIncompatibleException();
duke@1 454 }
duke@1 455 }
duke@1 456
duke@1 457 protected static class NoReadObjectDefaultsSentState extends ReadObjectState {
duke@1 458 public void endUnmarshalCustomValue(InputStreamHook stream) throws IOException {
duke@1 459 // Code should read default fields before calling this
duke@1 460
duke@1 461 if (stream.getStreamFormatVersion() == 2) {
duke@1 462 ((ValueInputStream)stream.getOrbStream()).start_value();
duke@1 463 ((ValueInputStream)stream.getOrbStream()).end_value();
duke@1 464 }
duke@1 465
duke@1 466 stream.setState(DEFAULT_STATE);
duke@1 467 }
duke@1 468 }
duke@1 469 }

mercurial