/*
 * Javassist, a Java-bytecode translator toolkit.
 * Copyright (C) 1999- Shigeru Chiba. All Rights Reserved.
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License.  Alternatively, the contents of this file may be used under
 * the terms of the GNU Lesser General Public License Version 2.1 or later,
 * or the Apache License Version 2.0.
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 */

package javassist.tools.reflect;

import javassist.CannotCompileException;
import javassist.ClassPool;
import javassist.NotFoundException;

A class loader for reflection.

To run a program, say MyApp, including a reflective class, you must write a start-up program as follows:

public class Main {
  public static void main(String[] args) throws Throwable {
    javassist.tools.reflect.Loader cl
        = (javassist.tools.reflect.Loader)Main.class.getClassLoader();
    cl.makeReflective("Person", "MyMetaobject",
                      "javassist.tools.reflect.ClassMetaobject");
    cl.run("MyApp", args);
  }
}

Then run this program as follows:

% java javassist.tools.reflect.Loader Main arg1, ...

This command runs Main.main() with arg1, ... and Main.main() runs MyApp.main() with arg1, ... The Person class is modified to be a reflective class. Method calls on a Person object are intercepted by an instance of MyMetaobject.

Also, you can run MyApp in a slightly different way:

public class Main2 {
  public static void main(String[] args) throws Throwable {
    javassist.tools.reflect.Loader cl = new javassist.tools.reflect.Loader();
    cl.makeReflective("Person", "MyMetaobject",
                      "javassist.tools.reflect.ClassMetaobject");
    cl.run("MyApp", args);
  }
}

This program is run as follows:

% java Main2 arg1, ...

The difference from the former one is that the class Main is loaded by javassist.tools.reflect.Loader whereas the class Main2 is not. Thus, Main belongs to the same name space (security domain) as MyApp whereas Main2 does not; Main2 belongs to the same name space as javassist.tools.reflect.Loader. For more details, see the notes in the manual page of javassist.Loader.

The class Main2 is equivalent to this class:

public class Main3 {
  public static void main(String[] args) throws Throwable {
    Reflection reflection = new Reflection();
    javassist.Loader cl
        = new javassist.Loader(ClassPool.getDefault(reflection));
    reflection.makeReflective("Person", "MyMetaobject",
                              "javassist.tools.reflect.ClassMetaobject");
    cl.run("MyApp", args);
  }
}

Note:

javassist.tools.reflect.Loader does not make a class reflective if that class is in a java.* or javax.* pacakge because of the specifications on the class loading algorithm of Java. The JVM does not allow to load such a system class with a user class loader.

To avoid this limitation, those classes should be statically modified with javassist.tools.reflect.Compiler and the original class files should be replaced.

See Also:
/** * A class loader for reflection. * * <p>To run a program, say <code>MyApp</code>, * including a reflective class, * you must write a start-up program as follows: * * <pre> * public class Main { * public static void main(String[] args) throws Throwable { * javassist.tools.reflect.Loader cl * = (javassist.tools.reflect.Loader)Main.class.getClassLoader(); * cl.makeReflective("Person", "MyMetaobject", * "javassist.tools.reflect.ClassMetaobject"); * cl.run("MyApp", args); * } * } * </pre> * * <p>Then run this program as follows: * * <pre>% java javassist.tools.reflect.Loader Main arg1, ...</pre> * * <p>This command runs <code>Main.main()</code> with <code>arg1</code>, ... * and <code>Main.main()</code> runs <code>MyApp.main()</code> with * <code>arg1</code>, ... * The <code>Person</code> class is modified * to be a reflective class. Method calls on a <code>Person</code> * object are intercepted by an instance of <code>MyMetaobject</code>. * * <p>Also, you can run <code>MyApp</code> in a slightly different way: * * <pre> * public class Main2 { * public static void main(String[] args) throws Throwable { * javassist.tools.reflect.Loader cl = new javassist.tools.reflect.Loader(); * cl.makeReflective("Person", "MyMetaobject", * "javassist.tools.reflect.ClassMetaobject"); * cl.run("MyApp", args); * } * } * </pre> * * <p>This program is run as follows: * * <pre>% java Main2 arg1, ...</pre> * * <p>The difference from the former one is that the class <code>Main</code> * is loaded by <code>javassist.tools.reflect.Loader</code> whereas the class * <code>Main2</code> is not. Thus, <code>Main</code> belongs * to the same name space (security domain) as <code>MyApp</code> * whereas <code>Main2</code> does not; <code>Main2</code> belongs * to the same name space as <code>javassist.tools.reflect.Loader</code>. * For more details, * see the notes in the manual page of <code>javassist.Loader</code>. * * <p>The class <code>Main2</code> is equivalent to this class: * * <pre> * public class Main3 { * public static void main(String[] args) throws Throwable { * Reflection reflection = new Reflection(); * javassist.Loader cl * = new javassist.Loader(ClassPool.getDefault(reflection)); * reflection.makeReflective("Person", "MyMetaobject", * "javassist.tools.reflect.ClassMetaobject"); * cl.run("MyApp", args); * } * } * </pre> * * <p><b>Note:</b> * * <p><code>javassist.tools.reflect.Loader</code> does not make a class reflective * if that class is in a <code>java.*</code> or * <code>javax.*</code> pacakge because of the specifications * on the class loading algorithm of Java. The JVM does not allow to * load such a system class with a user class loader. * * <p>To avoid this limitation, those classes should be statically * modified with <code>javassist.tools.reflect.Compiler</code> and the original * class files should be replaced. * * @see javassist.tools.reflect.Reflection * @see javassist.tools.reflect.Compiler * @see javassist.Loader */
public class Loader extends javassist.Loader { protected Reflection reflection;
Loads a class with an instance of Loader and calls main() in that class.
Params:
  • args – command line parameters.
      args[0] is the class name to be loaded.
      args[1..n] are parameters passed to the target main().
/** * Loads a class with an instance of <code>Loader</code> * and calls <code>main()</code> in that class. * * @param args command line parameters. * <br>&nbsp;&nbsp;<code>args[0]</code> is the class name to be loaded. * <br>&nbsp;&nbsp;<code>args[1..n]</code> are parameters passed * to the target <code>main()</code>. */
public static void main(String[] args) throws Throwable { Loader cl = new Loader(); cl.run(args); }
Constructs a new class loader.
/** * Constructs a new class loader. */
public Loader() throws CannotCompileException, NotFoundException { super(); delegateLoadingOf("javassist.tools.reflect.Loader"); reflection = new Reflection(); ClassPool pool = ClassPool.getDefault(); addTranslator(pool, reflection); }
Produces a reflective class. If the super class is also made reflective, it must be done before the sub class.
Params:
  • clazz – the reflective class.
  • metaobject – the class of metaobjects. It must be a subclass of Metaobject.
  • metaclass – the class of the class metaobject. It must be a subclass of ClassMetaobject.
See Also:
Returns:false if the class is already reflective.
/** * Produces a reflective class. * If the super class is also made reflective, it must be done * before the sub class. * * @param clazz the reflective class. * @param metaobject the class of metaobjects. * It must be a subclass of * <code>Metaobject</code>. * @param metaclass the class of the class metaobject. * It must be a subclass of * <code>ClassMetaobject</code>. * @return <code>false</code> if the class is already reflective. * * @see javassist.tools.reflect.Metaobject * @see javassist.tools.reflect.ClassMetaobject */
public boolean makeReflective(String clazz, String metaobject, String metaclass) throws CannotCompileException, NotFoundException { return reflection.makeReflective(clazz, metaobject, metaclass); } }