src/share/classes/sun/rmi/rmic/iiop/ValueType.java

Wed, 28 Mar 2012 02:50:50 -0700

author
mbankal
date
Wed, 28 Mar 2012 02:50:50 -0700
changeset 371
e324dfb90c9e
parent 158
91006f157c46
child 748
6845b95cba6b
permissions
-rw-r--r--

7079902: Refine CORBA data models
Reviewed-by: coffeys

duke@1 1 /*
ohair@158 2 * Copyright (c) 1998, 2007, 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 sun.rmi.rmic.iiop;
duke@1 33
duke@1 34 import java.util.Vector;
duke@1 35 import sun.tools.java.ClassNotFound;
duke@1 36 import sun.tools.java.ClassDeclaration;
duke@1 37 import sun.tools.java.ClassDefinition;
duke@1 38 import sun.tools.java.MemberDefinition;
duke@1 39 import java.util.Hashtable;
duke@1 40 import java.io.ObjectStreamClass;
duke@1 41 import java.io.ObjectStreamField;
duke@1 42
duke@1 43
duke@1 44 /**
duke@1 45 * ValueType represents any non-special class which does inherit from
duke@1 46 * java.io.Serializable and does not inherit from java.rmi.Remote.
duke@1 47 * <p>
duke@1 48 * The static forValue(...) method must be used to obtain an instance, and
duke@1 49 * will return null if the ClassDefinition is non-conforming.
duke@1 50 *
duke@1 51 * @author Bryan Atsatt
duke@1 52 */
duke@1 53 public class ValueType extends ClassType {
duke@1 54
duke@1 55 private boolean isCustom;
duke@1 56
duke@1 57 //_____________________________________________________________________
duke@1 58 // Public Interfaces
duke@1 59 //_____________________________________________________________________
duke@1 60
duke@1 61 /**
duke@1 62 * Create an ValueType object for the given class.
duke@1 63 *
duke@1 64 * If the class is not a properly formed or if some other error occurs, the
duke@1 65 * return value will be null, and errors will have been reported to the
duke@1 66 * supplied BatchEnvironment.
duke@1 67 */
duke@1 68 public static ValueType forValue(ClassDefinition classDef,
duke@1 69 ContextStack stack,
duke@1 70 boolean quiet) {
duke@1 71
duke@1 72 if (stack.anyErrors()) return null;
duke@1 73
duke@1 74 // Do we already have it?
duke@1 75
duke@1 76 sun.tools.java.Type theType = classDef.getType();
duke@1 77 String typeKey = theType.toString();
duke@1 78 Type existing = getType(typeKey,stack);
duke@1 79
duke@1 80 if (existing != null) {
duke@1 81
duke@1 82 if (!(existing instanceof ValueType)) return null; // False hit.
duke@1 83
duke@1 84 // Yep, so return it...
duke@1 85
duke@1 86 return (ValueType) existing;
duke@1 87 }
duke@1 88
duke@1 89 // Is this java.lang.Class?
duke@1 90
duke@1 91 boolean javaLangClass = false;
duke@1 92
duke@1 93 if (classDef.getClassDeclaration().getName() == idJavaLangClass) {
duke@1 94
duke@1 95 // Yes, so replace classDef with one for
duke@1 96 // javax.rmi.CORBA.ClassDesc...
duke@1 97
duke@1 98 javaLangClass = true;
duke@1 99 BatchEnvironment env = stack.getEnv();
duke@1 100 ClassDeclaration decl = env.getClassDeclaration(idClassDesc);
duke@1 101 ClassDefinition def = null;
duke@1 102
duke@1 103 try {
duke@1 104 def = decl.getClassDefinition(env);
duke@1 105 } catch (ClassNotFound ex) {
duke@1 106 classNotFound(stack,ex);
duke@1 107 return null;
duke@1 108 }
duke@1 109
duke@1 110 classDef = def;
duke@1 111 }
duke@1 112
duke@1 113 // Could this be a value?
duke@1 114
duke@1 115 if (couldBeValue(stack,classDef)) {
duke@1 116
duke@1 117 // Yes, so check it...
duke@1 118
duke@1 119 ValueType it = new ValueType(classDef,stack,javaLangClass);
duke@1 120 putType(typeKey,it,stack);
duke@1 121 stack.push(it);
duke@1 122
duke@1 123 if (it.initialize(stack,quiet)) {
duke@1 124 stack.pop(true);
duke@1 125 return it;
duke@1 126 } else {
duke@1 127 removeType(typeKey,stack);
duke@1 128 stack.pop(false);
duke@1 129 return null;
duke@1 130 }
duke@1 131 } else {
duke@1 132 return null;
duke@1 133 }
duke@1 134 }
duke@1 135
duke@1 136
duke@1 137 /**
duke@1 138 * Return a string describing this type.
duke@1 139 */
duke@1 140 public String getTypeDescription () {
duke@1 141 String result = addExceptionDescription("Value");
duke@1 142 if (isCustom) {
duke@1 143 result = "Custom " + result;
duke@1 144 }
duke@1 145 if (isIDLEntity) {
duke@1 146 result = result + " [IDLEntity]";
duke@1 147 }
duke@1 148 return result;
duke@1 149 }
duke@1 150
duke@1 151 /**
duke@1 152 * Return true if this type is a "custom" type (i.e.
duke@1 153 * it implements java.io.Externalizable or has a
duke@1 154 * method with the following signature:
duke@1 155 *
duke@1 156 * private void writeObject(java.io.ObjectOutputStream out);
duke@1 157 *
duke@1 158 */
duke@1 159 public boolean isCustom () {
duke@1 160 return isCustom;
duke@1 161 }
duke@1 162
duke@1 163
duke@1 164 //_____________________________________________________________________
duke@1 165 // Subclass/Internal Interfaces
duke@1 166 //_____________________________________________________________________
duke@1 167
duke@1 168 /**
duke@1 169 * Create a ValueType instance for the given class. The resulting
duke@1 170 * object is not yet completely initialized.
duke@1 171 */
duke@1 172 private ValueType(ClassDefinition classDef,
duke@1 173 ContextStack stack,
duke@1 174 boolean isMappedJavaLangClass) {
duke@1 175 super(stack,classDef,TYPE_VALUE | TM_CLASS | TM_COMPOUND);
duke@1 176 isCustom = false;
duke@1 177
duke@1 178 // If this is the mapped version of java.lang.Class,
duke@1 179 // set the non-IDL names back to java.lang.Class...
duke@1 180
duke@1 181 if (isMappedJavaLangClass) {
duke@1 182 setNames(idJavaLangClass,IDL_CLASS_MODULE,IDL_CLASS);
duke@1 183 }
duke@1 184 }
duke@1 185
duke@1 186 //_____________________________________________________________________
duke@1 187 // Internal Interfaces
duke@1 188 //_____________________________________________________________________
duke@1 189
duke@1 190 /**
duke@1 191 * Initialize this instance.
duke@1 192 */
duke@1 193
duke@1 194 private static boolean couldBeValue(ContextStack stack, ClassDefinition classDef) {
duke@1 195
duke@1 196 boolean result = false;
duke@1 197 ClassDeclaration classDecl = classDef.getClassDeclaration();
duke@1 198 BatchEnvironment env = stack.getEnv();
duke@1 199
duke@1 200 try {
duke@1 201 // Make sure it's not remote...
duke@1 202
duke@1 203 if (env.defRemote.implementedBy(env, classDecl)) {
duke@1 204 failedConstraint(10,false,stack,classDef.getName());
duke@1 205 } else {
duke@1 206
duke@1 207 // Make sure it's Serializable...
duke@1 208
duke@1 209 if (!env.defSerializable.implementedBy(env, classDecl)) {
duke@1 210 failedConstraint(11,false,stack,classDef.getName());
duke@1 211 } else {
duke@1 212 result = true;
duke@1 213 }
duke@1 214 }
duke@1 215 } catch (ClassNotFound e) {
duke@1 216 classNotFound(stack,e);
duke@1 217 }
duke@1 218
duke@1 219 return result;
duke@1 220 }
duke@1 221
duke@1 222 /**
duke@1 223 * Initialize this instance.
duke@1 224 */
duke@1 225 private boolean initialize (ContextStack stack, boolean quiet) {
duke@1 226
duke@1 227 ClassDefinition ourDef = getClassDefinition();
duke@1 228 ClassDeclaration ourDecl = getClassDeclaration();
duke@1 229
duke@1 230 try {
duke@1 231
duke@1 232 // Make sure our parentage is ok...
duke@1 233
duke@1 234 if (!initParents(stack)) {
duke@1 235 failedConstraint(12,quiet,stack,getQualifiedName());
duke@1 236 return false;
duke@1 237 }
duke@1 238
duke@1 239
duke@1 240 // We're ok, so make up our collections...
duke@1 241
duke@1 242 Vector directInterfaces = new Vector();
duke@1 243 Vector directMethods = new Vector();
duke@1 244 Vector directMembers = new Vector();
duke@1 245
duke@1 246 // Get interfaces...
duke@1 247
duke@1 248 if (addNonRemoteInterfaces(directInterfaces,stack) != null) {
duke@1 249
duke@1 250 // Get methods...
duke@1 251
duke@1 252 if (addAllMethods(ourDef,directMethods,false,false,stack) != null) {
duke@1 253
duke@1 254 // Update parent class methods
duke@1 255 if (updateParentClassMethods(ourDef,directMethods,false,stack) != null) {
duke@1 256
duke@1 257 // Get constants and members...
duke@1 258
duke@1 259 if (addAllMembers(directMembers,false,false,stack)) {
duke@1 260
duke@1 261 // We're ok, so pass 'em up...
duke@1 262
duke@1 263 if (!initialize(directInterfaces,directMethods,directMembers,stack,quiet)) {
duke@1 264 return false;
duke@1 265 }
duke@1 266
duke@1 267 // Is this class Externalizable?
duke@1 268
duke@1 269 boolean externalizable = false;
duke@1 270 if (!env.defExternalizable.implementedBy(env, ourDecl)) {
duke@1 271
duke@1 272 // No, so check to see if we have a serialPersistentField
duke@1 273 // that will modify the members.
duke@1 274
duke@1 275 if (!checkPersistentFields(getClassInstance(),quiet)) {
duke@1 276 return false;
duke@1 277 }
duke@1 278 } else {
duke@1 279
duke@1 280 // Yes.
duke@1 281
duke@1 282 externalizable = true;
duke@1 283 }
duke@1 284
duke@1 285 // Should this class be considered "custom"? It is if
duke@1 286 // it is Externalizable OR if it has a method with the
duke@1 287 // following signature:
duke@1 288 //
duke@1 289 // private void writeObject(java.io.ObjectOutputStream out);
duke@1 290 //
duke@1 291
duke@1 292 if (externalizable) {
duke@1 293 isCustom = true;
duke@1 294 } else {
duke@1 295 for (MemberDefinition member = ourDef.getFirstMember();
duke@1 296 member != null;
duke@1 297 member = member.getNextMember()) {
duke@1 298
duke@1 299 if (member.isMethod() &&
duke@1 300 !member.isInitializer() &&
duke@1 301 member.isPrivate() &&
duke@1 302 member.getName().toString().equals("writeObject")) {
duke@1 303
duke@1 304 // Check return type, arguments and exceptions...
duke@1 305
duke@1 306 sun.tools.java.Type methodType = member.getType();
duke@1 307 sun.tools.java.Type rtnType = methodType.getReturnType();
duke@1 308
duke@1 309 if (rtnType == sun.tools.java.Type.tVoid) {
duke@1 310
duke@1 311 // Return type is correct. How about arguments?
duke@1 312
duke@1 313 sun.tools.java.Type[] args = methodType.getArgumentTypes();
duke@1 314 if (args.length == 1 &&
duke@1 315 args[0].getTypeSignature().equals("Ljava/io/ObjectOutputStream;")) {
duke@1 316
duke@1 317 // Arguments are correct, so it is a custom
duke@1 318 // value type...
duke@1 319
duke@1 320 isCustom = true;
duke@1 321 }
duke@1 322 }
duke@1 323 }
duke@1 324 }
duke@1 325 }
duke@1 326 }
duke@1 327
duke@1 328 return true;
duke@1 329 }
duke@1 330 }
duke@1 331 }
duke@1 332 } catch (ClassNotFound e) {
duke@1 333 classNotFound(stack,e);
duke@1 334 }
duke@1 335
duke@1 336 return false;
duke@1 337 }
duke@1 338
duke@1 339
duke@1 340 private boolean checkPersistentFields (Class clz, boolean quiet) {
duke@1 341
duke@1 342 // Do we have a writeObject method?
duke@1 343
duke@1 344 for (int i = 0; i < methods.length; i++) {
duke@1 345 if (methods[i].getName().equals("writeObject") &&
duke@1 346 methods[i].getArguments().length == 1) {
duke@1 347
duke@1 348 Type returnType = methods[i].getReturnType();
duke@1 349 Type arg = methods[i].getArguments()[0];
duke@1 350 String id = arg.getQualifiedName();
duke@1 351
duke@1 352 if (returnType.isType(TYPE_VOID) &&
duke@1 353 id.equals("java.io.ObjectOutputStream")) {
duke@1 354
duke@1 355 // Got one, so there's nothing to do...
duke@1 356
duke@1 357 return true;
duke@1 358 }
duke@1 359 }
duke@1 360 }
duke@1 361
duke@1 362 // Do we have a valid serialPersistentField array?
duke@1 363
duke@1 364 MemberDefinition spfDef = null;
duke@1 365
duke@1 366 for (int i = 0; i < members.length; i++) {
duke@1 367 if (members[i].getName().equals("serialPersistentFields")) {
duke@1 368
duke@1 369 Member member = members[i];
duke@1 370 Type type = member.getType();
duke@1 371 Type elementType = type.getElementType();
duke@1 372
duke@1 373 // We have a member with the correct name. Make sure
duke@1 374 // we have the correct signature...
duke@1 375
duke@1 376 if (elementType != null &&
duke@1 377 elementType.getQualifiedName().equals(
duke@1 378 "java.io.ObjectStreamField")
duke@1 379 ) {
duke@1 380
duke@1 381 if (member.isStatic() &&
duke@1 382 member.isFinal() &&
duke@1 383 member.isPrivate()) {
duke@1 384
duke@1 385 // We have the correct signature
duke@1 386
duke@1 387 spfDef = member.getMemberDefinition();
duke@1 388
duke@1 389 } else {
duke@1 390
duke@1 391 // Bad signature...
duke@1 392
duke@1 393 failedConstraint(4,quiet,stack,getQualifiedName());
duke@1 394 return false;
duke@1 395 }
duke@1 396 }
duke@1 397 }
duke@1 398 }
duke@1 399
duke@1 400 // If we do not have a serialPersistentField,
duke@1 401 // there's nothing to do, so return with no error...
duke@1 402
duke@1 403 if (spfDef == null) {
duke@1 404 return true;
duke@1 405 }
duke@1 406
duke@1 407 // Ok, now we must examine the contents of the array -
duke@1 408 // then validate them...
duke@1 409
duke@1 410 Hashtable fields = getPersistentFields(clz);
duke@1 411 boolean result = true;
duke@1 412
duke@1 413 for (int i = 0; i < members.length; i++) {
duke@1 414 String fieldName = members[i].getName();
duke@1 415 String fieldType = members[i].getType().getSignature();
duke@1 416
duke@1 417 // Is this field present in the array?
duke@1 418
duke@1 419 String type = (String) fields.get(fieldName);
duke@1 420
duke@1 421 if (type == null) {
duke@1 422
duke@1 423 // No, so mark it transient...
duke@1 424
duke@1 425 members[i].setTransient();
duke@1 426
duke@1 427 } else {
duke@1 428
duke@1 429 // Yes, does the type match?
duke@1 430
duke@1 431 if (type.equals(fieldType)) {
duke@1 432
duke@1 433 // Yes, so remove it from the fields table...
duke@1 434
duke@1 435 fields.remove(fieldName);
duke@1 436
duke@1 437 } else {
duke@1 438
duke@1 439 // No, so error...
duke@1 440
duke@1 441 result = false;
duke@1 442 failedConstraint(2,quiet,stack,fieldName,getQualifiedName());
duke@1 443 }
duke@1 444 }
duke@1 445 }
duke@1 446
duke@1 447 // Ok, we've checked all of our fields. Are there any left in the "array"?
duke@1 448 // If so, it's an error...
duke@1 449
duke@1 450 if (result && fields.size() > 0) {
duke@1 451
duke@1 452 result = false;
duke@1 453 failedConstraint(9,quiet,stack,getQualifiedName());
duke@1 454 }
duke@1 455
duke@1 456 // Return result...
duke@1 457
duke@1 458 return result;
duke@1 459 }
duke@1 460
duke@1 461 /**
duke@1 462 * Get the names and types of all the persistent fields of a Class.
duke@1 463 */
duke@1 464 private Hashtable getPersistentFields (Class clz) {
duke@1 465 Hashtable result = new Hashtable();
duke@1 466 ObjectStreamClass osc = ObjectStreamClass.lookup(clz);
duke@1 467 if (osc != null) {
duke@1 468 ObjectStreamField[] fields = osc.getFields();
duke@1 469 for (int i = 0; i < fields.length; i++) {
duke@1 470 String typeSig;
duke@1 471 String typePrefix = String.valueOf(fields[i].getTypeCode());
duke@1 472 if (fields[i].isPrimitive()) {
duke@1 473 typeSig = typePrefix;
duke@1 474 } else {
duke@1 475 if (fields[i].getTypeCode() == '[') {
duke@1 476 typePrefix = "";
duke@1 477 }
duke@1 478 typeSig = typePrefix + fields[i].getType().getName().replace('.','/');
duke@1 479 if (typeSig.endsWith(";")) {
duke@1 480 typeSig = typeSig.substring(0,typeSig.length()-1);
duke@1 481 }
duke@1 482 }
duke@1 483 result.put(fields[i].getName(),typeSig);
duke@1 484 }
duke@1 485 }
duke@1 486 return result;
duke@1 487 }
duke@1 488 }

mercurial