Tue, 19 May 2015 21:51:03 +0100
8068721: RMI-IIOP communication fails when ConcurrentHashMap is passed to remote method
Reviewed-by: chegar, alanb
duke@1 | 1 | /* |
msheppar@940 | 2 | * Copyright (c) 1999, 2015, 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; |
msheppar@940 | 35 | import java.io.NotActiveException; |
duke@1 | 36 | import java.io.OutputStream; |
duke@1 | 37 | import java.io.ObjectOutputStream; |
duke@1 | 38 | import java.io.ObjectOutput; |
coffeys@754 | 39 | import java.util.Map; |
coffeys@754 | 40 | import java.util.HashMap; |
duke@1 | 41 | |
duke@1 | 42 | import org.omg.CORBA.INTERNAL; |
duke@1 | 43 | |
duke@1 | 44 | public abstract class OutputStreamHook extends ObjectOutputStream |
duke@1 | 45 | { |
duke@1 | 46 | private HookPutFields putFields = null; |
duke@1 | 47 | |
duke@1 | 48 | /** |
duke@1 | 49 | * Since ObjectOutputStream.PutField methods specify no exceptions, |
duke@1 | 50 | * we are not checking for null parameters on put methods. |
duke@1 | 51 | */ |
duke@1 | 52 | private class HookPutFields extends ObjectOutputStream.PutField |
duke@1 | 53 | { |
coffeys@754 | 54 | private Map<String,Object> fields = new HashMap<>(); |
duke@1 | 55 | |
duke@1 | 56 | /** |
duke@1 | 57 | * Put the value of the named boolean field into the persistent field. |
duke@1 | 58 | */ |
duke@1 | 59 | public void put(String name, boolean value){ |
duke@1 | 60 | fields.put(name, new Boolean(value)); |
duke@1 | 61 | } |
duke@1 | 62 | |
duke@1 | 63 | /** |
duke@1 | 64 | * Put the value of the named char field into the persistent fields. |
duke@1 | 65 | */ |
duke@1 | 66 | public void put(String name, char value){ |
duke@1 | 67 | fields.put(name, new Character(value)); |
duke@1 | 68 | } |
duke@1 | 69 | |
duke@1 | 70 | /** |
duke@1 | 71 | * Put the value of the named byte field into the persistent fields. |
duke@1 | 72 | */ |
duke@1 | 73 | public void put(String name, byte value){ |
duke@1 | 74 | fields.put(name, new Byte(value)); |
duke@1 | 75 | } |
duke@1 | 76 | |
duke@1 | 77 | /** |
duke@1 | 78 | * Put the value of the named short field into the persistent fields. |
duke@1 | 79 | */ |
duke@1 | 80 | public void put(String name, short value){ |
duke@1 | 81 | fields.put(name, new Short(value)); |
duke@1 | 82 | } |
duke@1 | 83 | |
duke@1 | 84 | /** |
duke@1 | 85 | * Put the value of the named int field into the persistent fields. |
duke@1 | 86 | */ |
duke@1 | 87 | public void put(String name, int value){ |
duke@1 | 88 | fields.put(name, new Integer(value)); |
duke@1 | 89 | } |
duke@1 | 90 | |
duke@1 | 91 | /** |
duke@1 | 92 | * Put the value of the named long field into the persistent fields. |
duke@1 | 93 | */ |
duke@1 | 94 | public void put(String name, long value){ |
duke@1 | 95 | fields.put(name, new Long(value)); |
duke@1 | 96 | } |
duke@1 | 97 | |
duke@1 | 98 | /** |
duke@1 | 99 | * Put the value of the named float field into the persistent fields. |
duke@1 | 100 | * |
duke@1 | 101 | */ |
duke@1 | 102 | public void put(String name, float value){ |
duke@1 | 103 | fields.put(name, new Float(value)); |
duke@1 | 104 | } |
duke@1 | 105 | |
duke@1 | 106 | /** |
duke@1 | 107 | * Put the value of the named double field into the persistent field. |
duke@1 | 108 | */ |
duke@1 | 109 | public void put(String name, double value){ |
duke@1 | 110 | fields.put(name, new Double(value)); |
duke@1 | 111 | } |
duke@1 | 112 | |
duke@1 | 113 | /** |
duke@1 | 114 | * Put the value of the named Object field into the persistent field. |
duke@1 | 115 | */ |
duke@1 | 116 | public void put(String name, Object value){ |
duke@1 | 117 | fields.put(name, value); |
duke@1 | 118 | } |
duke@1 | 119 | |
duke@1 | 120 | /** |
duke@1 | 121 | * Write the data and fields to the specified ObjectOutput stream. |
duke@1 | 122 | */ |
duke@1 | 123 | public void write(ObjectOutput out) throws IOException { |
duke@1 | 124 | OutputStreamHook hook = (OutputStreamHook)out; |
duke@1 | 125 | |
duke@1 | 126 | ObjectStreamField[] osfields = hook.getFieldsNoCopy(); |
duke@1 | 127 | |
duke@1 | 128 | // Write the fields to the stream in the order |
duke@1 | 129 | // provided by the ObjectStreamClass. (They should |
duke@1 | 130 | // be sorted appropriately already.) |
duke@1 | 131 | for (int i = 0; i < osfields.length; i++) { |
duke@1 | 132 | |
duke@1 | 133 | Object value = fields.get(osfields[i].getName()); |
duke@1 | 134 | |
duke@1 | 135 | hook.writeField(osfields[i], value); |
duke@1 | 136 | } |
duke@1 | 137 | } |
duke@1 | 138 | } |
duke@1 | 139 | |
duke@1 | 140 | abstract void writeField(ObjectStreamField field, Object value) throws IOException; |
duke@1 | 141 | |
duke@1 | 142 | public OutputStreamHook() |
duke@1 | 143 | throws java.io.IOException { |
duke@1 | 144 | super(); |
duke@1 | 145 | } |
duke@1 | 146 | |
duke@1 | 147 | public void defaultWriteObject() throws IOException { |
duke@1 | 148 | |
duke@1 | 149 | writeObjectState.defaultWriteObject(this); |
duke@1 | 150 | |
duke@1 | 151 | defaultWriteObjectDelegate(); |
duke@1 | 152 | } |
duke@1 | 153 | |
duke@1 | 154 | public abstract void defaultWriteObjectDelegate(); |
duke@1 | 155 | |
duke@1 | 156 | public ObjectOutputStream.PutField putFields() |
duke@1 | 157 | throws IOException { |
msheppar@940 | 158 | if (putFields == null) { |
msheppar@940 | 159 | putFields = new HookPutFields(); |
msheppar@940 | 160 | } |
duke@1 | 161 | return putFields; |
duke@1 | 162 | } |
duke@1 | 163 | |
duke@1 | 164 | // Stream format version, saved/restored during recursive calls |
duke@1 | 165 | protected byte streamFormatVersion = 1; |
duke@1 | 166 | |
duke@1 | 167 | // Return the stream format version currently being used |
duke@1 | 168 | // to serialize an object |
duke@1 | 169 | public byte getStreamFormatVersion() { |
duke@1 | 170 | return streamFormatVersion; |
duke@1 | 171 | } |
duke@1 | 172 | |
duke@1 | 173 | abstract ObjectStreamField[] getFieldsNoCopy(); |
duke@1 | 174 | |
duke@1 | 175 | // User uses PutFields to simulate default data. |
duke@1 | 176 | // See java.io.ObjectOutputStream.PutFields |
duke@1 | 177 | public void writeFields() |
duke@1 | 178 | throws IOException { |
duke@1 | 179 | |
duke@1 | 180 | writeObjectState.defaultWriteObject(this); |
msheppar@940 | 181 | if (putFields != null) { |
msheppar@940 | 182 | putFields.write(this); |
msheppar@940 | 183 | } else { |
msheppar@940 | 184 | throw new NotActiveException("no current PutField object"); |
msheppar@940 | 185 | } |
duke@1 | 186 | } |
duke@1 | 187 | |
coffeys@478 | 188 | abstract org.omg.CORBA_2_3.portable.OutputStream getOrbStream(); |
duke@1 | 189 | |
duke@1 | 190 | protected abstract void beginOptionalCustomData(); |
duke@1 | 191 | |
duke@1 | 192 | |
duke@1 | 193 | // The following is a State pattern implementation of what |
duke@1 | 194 | // should be done when a Serializable has a |
duke@1 | 195 | // writeObject method. This was especially necessary for |
duke@1 | 196 | // RMI-IIOP stream format version 2. Please see the |
duke@1 | 197 | // state diagrams in the docs directory of the workspace. |
duke@1 | 198 | |
duke@1 | 199 | protected WriteObjectState writeObjectState = NOT_IN_WRITE_OBJECT; |
duke@1 | 200 | |
duke@1 | 201 | protected void setState(WriteObjectState newState) { |
duke@1 | 202 | writeObjectState = newState; |
duke@1 | 203 | } |
duke@1 | 204 | |
duke@1 | 205 | // Description of possible actions |
duke@1 | 206 | protected static class WriteObjectState { |
duke@1 | 207 | public void enterWriteObject(OutputStreamHook stream) throws IOException {} |
duke@1 | 208 | public void exitWriteObject(OutputStreamHook stream) throws IOException {} |
duke@1 | 209 | public void defaultWriteObject(OutputStreamHook stream) throws IOException {} |
duke@1 | 210 | public void writeData(OutputStreamHook stream) throws IOException {} |
duke@1 | 211 | } |
duke@1 | 212 | |
duke@1 | 213 | protected static class DefaultState extends WriteObjectState { |
duke@1 | 214 | public void enterWriteObject(OutputStreamHook stream) throws IOException { |
duke@1 | 215 | stream.setState(IN_WRITE_OBJECT); |
duke@1 | 216 | } |
duke@1 | 217 | } |
duke@1 | 218 | |
duke@1 | 219 | protected static final WriteObjectState NOT_IN_WRITE_OBJECT = new DefaultState(); |
duke@1 | 220 | protected static final WriteObjectState IN_WRITE_OBJECT = new InWriteObjectState(); |
duke@1 | 221 | protected static final WriteObjectState WROTE_DEFAULT_DATA = new WroteDefaultDataState(); |
duke@1 | 222 | protected static final WriteObjectState WROTE_CUSTOM_DATA = new WroteCustomDataState(); |
duke@1 | 223 | |
duke@1 | 224 | protected static class InWriteObjectState extends WriteObjectState { |
duke@1 | 225 | |
duke@1 | 226 | public void enterWriteObject(OutputStreamHook stream) throws IOException { |
duke@1 | 227 | // XXX I18N, logging needed. |
duke@1 | 228 | throw new IOException("Internal state failure: Entered writeObject twice"); |
duke@1 | 229 | } |
duke@1 | 230 | |
duke@1 | 231 | public void exitWriteObject(OutputStreamHook stream) throws IOException { |
duke@1 | 232 | |
duke@1 | 233 | // We didn't write any data, so write the |
duke@1 | 234 | // called defaultWriteObject indicator as false |
duke@1 | 235 | stream.getOrbStream().write_boolean(false); |
duke@1 | 236 | |
duke@1 | 237 | // If we're in stream format verison 2, we must |
duke@1 | 238 | // put the "null" marker to say that there isn't |
duke@1 | 239 | // any optional data |
duke@1 | 240 | if (stream.getStreamFormatVersion() == 2) |
duke@1 | 241 | stream.getOrbStream().write_long(0); |
duke@1 | 242 | |
duke@1 | 243 | stream.setState(NOT_IN_WRITE_OBJECT); |
duke@1 | 244 | } |
duke@1 | 245 | |
duke@1 | 246 | public void defaultWriteObject(OutputStreamHook stream) throws IOException { |
duke@1 | 247 | |
duke@1 | 248 | // The writeObject method called defaultWriteObject |
duke@1 | 249 | // or writeFields, so put the called defaultWriteObject |
duke@1 | 250 | // indicator as true |
duke@1 | 251 | stream.getOrbStream().write_boolean(true); |
duke@1 | 252 | |
duke@1 | 253 | stream.setState(WROTE_DEFAULT_DATA); |
duke@1 | 254 | } |
duke@1 | 255 | |
duke@1 | 256 | public void writeData(OutputStreamHook stream) throws IOException { |
duke@1 | 257 | |
duke@1 | 258 | // The writeObject method first called a direct |
duke@1 | 259 | // write operation. Write the called defaultWriteObject |
duke@1 | 260 | // indicator as false, put the special stream format |
duke@1 | 261 | // version 2 header (if stream format version 2, of course), |
duke@1 | 262 | // and write the data |
duke@1 | 263 | stream.getOrbStream().write_boolean(false); |
duke@1 | 264 | stream.beginOptionalCustomData(); |
duke@1 | 265 | stream.setState(WROTE_CUSTOM_DATA); |
duke@1 | 266 | } |
duke@1 | 267 | } |
duke@1 | 268 | |
duke@1 | 269 | protected static class WroteDefaultDataState extends InWriteObjectState { |
duke@1 | 270 | |
duke@1 | 271 | public void exitWriteObject(OutputStreamHook stream) throws IOException { |
duke@1 | 272 | |
duke@1 | 273 | // We only wrote default data, so if in stream format |
duke@1 | 274 | // version 2, put the null indicator to say that there |
duke@1 | 275 | // is no optional data |
duke@1 | 276 | if (stream.getStreamFormatVersion() == 2) |
duke@1 | 277 | stream.getOrbStream().write_long(0); |
duke@1 | 278 | |
duke@1 | 279 | stream.setState(NOT_IN_WRITE_OBJECT); |
duke@1 | 280 | } |
duke@1 | 281 | |
duke@1 | 282 | public void defaultWriteObject(OutputStreamHook stream) throws IOException { |
duke@1 | 283 | // XXX I18N, logging needed. |
duke@1 | 284 | throw new IOException("Called defaultWriteObject/writeFields twice"); |
duke@1 | 285 | } |
duke@1 | 286 | |
duke@1 | 287 | public void writeData(OutputStreamHook stream) throws IOException { |
duke@1 | 288 | |
duke@1 | 289 | // The writeObject method called a direct write operation. |
duke@1 | 290 | // If in stream format version 2, put the fake valuetype |
duke@1 | 291 | // header. |
duke@1 | 292 | stream.beginOptionalCustomData(); |
duke@1 | 293 | |
duke@1 | 294 | stream.setState(WROTE_CUSTOM_DATA); |
duke@1 | 295 | } |
duke@1 | 296 | } |
duke@1 | 297 | |
duke@1 | 298 | protected static class WroteCustomDataState extends InWriteObjectState { |
duke@1 | 299 | |
duke@1 | 300 | public void exitWriteObject(OutputStreamHook stream) throws IOException { |
duke@1 | 301 | // In stream format version 2, we must tell the ORB |
duke@1 | 302 | // stream to close the fake custom valuetype. |
duke@1 | 303 | if (stream.getStreamFormatVersion() == 2) |
duke@1 | 304 | ((org.omg.CORBA.portable.ValueOutputStream)stream.getOrbStream()).end_value(); |
duke@1 | 305 | |
duke@1 | 306 | stream.setState(NOT_IN_WRITE_OBJECT); |
duke@1 | 307 | } |
duke@1 | 308 | |
duke@1 | 309 | public void defaultWriteObject(OutputStreamHook stream) throws IOException { |
duke@1 | 310 | // XXX I18N, logging needed. |
duke@1 | 311 | throw new IOException("Cannot call defaultWriteObject/writeFields after writing custom data in RMI-IIOP"); |
duke@1 | 312 | } |
duke@1 | 313 | |
duke@1 | 314 | // We don't have to do anything special here, just let |
duke@1 | 315 | // the stream write the data. |
duke@1 | 316 | public void writeData(OutputStreamHook stream) throws IOException {} |
duke@1 | 317 | } |
duke@1 | 318 | } |