Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-4630895

Potential wrong use of Class.forName in java/util/ResourceBundle.java

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Not an Issue
    • Icon: P4 P4
    • None
    • 1.4.1
    • core-libs
    • None

      This is the part of bug 4452040 which is applicable to i18n.

      Bug: Potential wrong use of Class.forName
      =========================================

      The Class.forName method must be used with care in JRE code. A call
      of the type Class.forName(classname) can only be assumes to find classes
      on the bootclasspath, since it does a look up on the callers classloader.

      This often leads to problems when what used to be optional packages are
      moved into the JRE, since if the code is used as an optional package (i.e.,
      loaded using -classpath), then Class.forName(classname) is essential:

          Class.forName(classname, ClassLoader.getSystemClassLoader())

      which is NOT the same as Class.forName(classname)

      The general rules of thumb for using Class.forName in JRE code are:

       1. Use Class.forName(classname) if you know that only JRE code should be
          found, i.e., no application specific classes should ever be found.
          (This is general, should only apply to the really low-level SPIs)

       2. Use either

              Class.forName(classname, ClassLoader.getSystemClassLoader())

         or
       
              Class.forName(classname, Thread.current().getContextClassLoader())

         The later should be used if it is reasonable to assume that the lookup
         it related to some computation on the current thread.

      Note: For historic reasons, the use of Thread.current().getContextClassLoader()
      has some advantages, since the code is more likely to work with both Java Web Start
      and Java Plug-In. Since application classes are typically not available on the
      system classloader. [This is what is being addressed in RFE 4372945 - but the
      problem will still exist for users with early versions of these products]

      It is also clear looking at the JRE code that the Class.forName issue has
      been a long standing issue. Various componetns of the JRE are using different
      workarounds, e.g., provide the developer with various APIs for setting the
      system classloader that the system should use. In these cases using the
      Class.forName(classname, Thread.current().getContextClassLoader()) is most
      likely the right thing to do, and the developers would not need to worry
      about the setting-what-classloader-to-use APIs. This should make it a lot
      easier for our developers to use our APIs, and write code that
      works across our different deployment solutions, i.e., Java Web start, Java
      Plug-In, and the java.exe command-line tool.

      In some of the Java files below, Class.forName is used with hard-coded class
      names. These seems to be often used to detect specific version of a JRE. This
      should not be neccesary for code belonging to a 1.4 codebase. That should
      eventually be cleaned up.

      Each file is maked with a number:
       
      3. Uses with Class.forName(xyz, true/false, cl), where cl is an argument to method

      5. Uses a Class.forName, and then a lookup on other classloader

          [That might be a workaround API. Maybe Class.forName(..., ContextClassLoader,SystemClassloader)
           would be better]

      4. A Class.forName look up hardcoded rt.jar class

          [This might not be needed - JRE version checking?]

      X. Just a Class.forName(cl) with possible not rt.jar argument

          [Might be a lingering bug]

      5 java/util/ResourceBundle.java:

      rene.schmidt@eng 2001-04-27

      According to the spec for ResourceBundle.loadBundle(), if the ClassLoader is
      null, the system (== "application") class loader is used. However, the
      bootstrap class loader is used to load the ResourceBundle, thus to implement the
      spec, the class loader must be explicitly named so the call should be
      changed to:

         Class.forName(bundleName, false, ClassLoader.getSystemClassLoader())

      However, I've been advised that ResourceBundle is a historically fragile class,
      so perhaps it is the spec which should be changed.

      -- iag@sfbay 2002-01-30

            nlindenbsunw Norbert Lindenberg (Inactive)
            iris Iris Clark
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: