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 285 286 287 288 289 290 291 292 293 294 295 296 297 298
/* * @(#)MarshalledObject.java 1.35 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package java.rmi; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.InputStream; import java.io.ObjectInputStream; import java.io.ObjectOutputStream; import java.io.ObjectStreamConstants; import java.io.OutputStream; import java.io.Serializable; import sun.rmi.server.MarshalInputStream; import sun.rmi.server.MarshalOutputStream; /** * A <code>MarshalledObject</code> contains a byte stream with the serialized * representation of an object given to its constructor. The <code>get</code> * method returns a new copy of the original object, as deserialized from * the contained byte stream. The contained object is serialized and * deserialized with the same serialization semantics used for marshaling * and unmarshaling parameters and return values of RMI calls: When the * serialized form is created: * * <ul> * <li> classes are annotated with a codebase URL from where the class * can be loaded (if available), and * <li> any remote object in the <code>MarshalledObject</code> is * represented by a serialized instance of its stub. * </ul> * * <p>When copy of the object is retrieved (via the <code>get</code> method), * if the class is not available locally, it will be loaded from the * appropriate location (specified the URL annotated with the class descriptor * when the class was serialized. * * <p><code>MarshalledObject</code> facilitates passing objects in RMI calls * that are not automatically deserialized immediately by the remote peer. * * @param <T> the type of the object contained in this * <code>MarshalledObject</code> * * @version 1.35, 11/17/05 * @author Ann Wollrath * @author Peter Jones * @since 1.2 */ public final class MarshalledObject<T> implements Serializable { /** * @serial Bytes of serialized representation. If <code>objBytes</code> is * <code>null</code> then the object marshalled was a <code>null</code> * reference. */ private byte[] objBytes = null; /** * @serial Bytes of location annotations, which are ignored by * <code>equals</code>. If <code>locBytes</code> is null, there were no * non-<code>null</code> annotations during marshalling. */ private byte[] locBytes = null; /** * @serial Stored hash code of contained object. * * @see #hashCode */ private int hash; /** Indicate compatibility with 1.2 version of class. */ private static final long serialVersionUID = 8988374069173025854L; /** * Creates a new <code>MarshalledObject</code> that contains the * serialized representation of the current state of the supplied object. * The object is serialized with the semantics used for marshaling * parameters for RMI calls. * * @param obj the object to be serialized (must be serializable) * @exception IOException if an <code>IOException</code> occurs; an * <code>IOException</code> may occur if <code>obj</code> is not * serializable. * @since 1.2 */ public MarshalledObject(T obj) throws IOException { if (obj == null) { hash = 13; return; } ByteArrayOutputStream bout = new ByteArrayOutputStream(); ByteArrayOutputStream lout = new ByteArrayOutputStream(); MarshalledObjectOutputStream out = new MarshalledObjectOutputStream(bout, lout); out.writeObject(obj); out.flush(); objBytes = bout.toByteArray(); // locBytes is null if no annotations locBytes = (out.hadAnnotations() ? lout.toByteArray() : null); /* * Calculate hash from the marshalled representation of object * so the hashcode will be comparable when sent between VMs. */ int h = 0; for (int i = 0; i < objBytes.length; i++) { h = 31 * h + objBytes[i]; } hash = h; } /** * Returns a new copy of the contained marshalledobject. The internal * representation is deserialized with the semantics used for * unmarshaling paramters for RMI calls. * * @return a copy of the contained object * @exception IOException if an <code>IOException</code> occurs while * deserializing the object from its internal representation. * @exception ClassNotFoundException if a * <code>ClassNotFoundException</code> occurs while deserializing the * object from its internal representation. * could not be found * @since 1.2 */ public T get() throws IOException, ClassNotFoundException { if (objBytes == null) // must have been a null object return null; ByteArrayInputStream bin = new ByteArrayInputStream(objBytes); // locBytes is null if no annotations ByteArrayInputStream lin = (locBytes == null ? null : new ByteArrayInputStream(locBytes)); MarshalledObjectInputStream in = new MarshalledObjectInputStream(bin, lin); T obj = (T) in.readObject(); in.close(); return obj; } /** * Return a hash code for this <code>MarshalledObject</code>. * * @return a hash code */ public int hashCode() { return hash; } /** * Compares this <code>MarshalledObject</code> to another object. * Returns true if and only if the argument refers to a * <code>MarshalledObject</code> that contains exactly the same * serialized representation of an object as this one does. The * comparison ignores any class codebase annotation, meaning that * two objects are equivalent if they have the same serialized * representation <i>except</i> for the codebase of each class * in the serialized representation. * * @param obj the object to compare with this <code>MarshalledObject</code> * @return <code>true</code> if the argument contains an equaivalent * serialized object; <code>false</code> otherwise * @since 1.2 */ public boolean equals(Object obj) { if (obj == this) return true; if (obj != null && obj instanceof MarshalledObject) { MarshalledObject other = (MarshalledObject) obj; // if either is a ref to null, both must be if (objBytes == null || other.objBytes == null) return objBytes == other.objBytes; // quick, easy test if (objBytes.length != other.objBytes.length) return false; //!! There is talk about adding an array comparision method //!! at 1.2 -- if so, this should be rewritten. -arnold for (int i = 0; i < objBytes.length; ++i) { if (objBytes[i] != other.objBytes[i]) return false; } return true; } else { return false; } } /** * This class is used to marshal objects for * <code>MarshalledObject</code>. It places the location annotations * to one side so that two <code>MarshalledObject</code>s can be * compared for equality if they differ only in location * annotations. Objects written using this stream should be read back * from a <code>MarshalledObjectInputStream</code>. * * @see java.rmi.MarshalledObject * @see MarshalledObjectInputStream */ private static class MarshalledObjectOutputStream extends MarshalOutputStream { /** The stream on which location objects are written. */ private ObjectOutputStream locOut; /** <code>true</code> if non-<code>null</code> annotations are * written. */ private boolean hadAnnotations; /** * Creates a new <code>MarshalledObjectOutputStream</code> whose * non-location bytes will be written to <code>objOut</code> and whose * location annotations (if any) will be written to * <code>locOut</code>. */ MarshalledObjectOutputStream(OutputStream objOut, OutputStream locOut) throws IOException { super(objOut); this.useProtocolVersion(ObjectStreamConstants.PROTOCOL_VERSION_2); this.locOut = new ObjectOutputStream(locOut); hadAnnotations = false; } /** * Returns <code>true</code> if any non-<code>null</code> location * annotations have been written to this stream. */ boolean hadAnnotations() { return hadAnnotations; } /** * Overrides MarshalOutputStream.writeLocation implementation to write * annotations to the location stream. */ protected void writeLocation(String loc) throws IOException { hadAnnotations |= (loc != null); locOut.writeObject(loc); } public void flush() throws IOException { super.flush(); locOut.flush(); } } /** * The counterpart to <code>MarshalledObjectOutputStream</code>. * * @see MarshalledObjectOutputStream */ private static class MarshalledObjectInputStream extends MarshalInputStream { /** * The stream from which annotations will be read. If this is * <code>null</code>, then all annotations were <code>null</code>. */ private ObjectInputStream locIn; /** * Creates a new <code>MarshalledObjectInputStream</code> that * reads its objects from <code>objIn</code> and annotations * from <code>locIn</code>. If <code>locIn</code> is * <code>null</code>, then all annotations will be * <code>null</code>. */ MarshalledObjectInputStream(InputStream objIn, InputStream locIn) throws IOException { super(objIn); this.locIn = (locIn == null ? null : new ObjectInputStream(locIn)); } /** * Overrides MarshalInputStream.readLocation to return locations from * the stream we were given, or <code>null</code> if we were given a * <code>null</code> location stream. */ protected Object readLocation() throws IOException, ClassNotFoundException { return (locIn == null ? null : locIn.readObject()); } } }