ext.sulis

Class SulisReflectionMagic

Object

SulisReflectionMagic

All Implemented Interfaces:

RemoteAccess

public class SulisReflectionMagic
extends Object
implements RemoteAccess

purpose: help with various tasks involving java reflection api:

• invoke method of a class after reloading the class if class file is more recent than the class instance we loaded (even from jar archives, in which case the modification time of the archive is tested)
• return a class from disk, reloaded if class file has a changed modification date
• call method on objects, optionally overriding private/protected access restriction

Author:

mkraegeloh

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	checkReload
static int	CMCALLCHECK_BAD_CLASS
static int	CMCALLCHECK_INVALID_CLASS
static int	CMCALLCHECK_NO_SUCH_METHOD
static int	CMCALLCHECK_OK
static int	CMCALLCHECK_UNKNOWN_ERROR
static int	MAJOR
static int	MINOR

Fields inherited from interface RemoteAccess

versionID

Constructor Summary

Constructors

Constructor and Description
SulisReflectionMagic()

Method Summary

Methods

Modifier and Type	Method and Description
static Object	callMOnO(Object o, String m) call no-argument version of named method on object passed (see 5-argument version of method for full description)
static Object	callMOnO(Object o, String m, Class[] argTypes, Object[] args) call named method on object passed (see 5-argument version of method for full description)
static Object	callMOnO(Object o, String m, Class[] argTypes, Object[] args, boolean force) call named method on object passed - if the name of the method contains one or more periods (.), the calls are chained, allowing constructs like getCreator.getFullName.toUpperCase Note that in this case all methods must have the same signature which usually means you chain getter methods.
static List<Object[]>	classVersions()
static void	flush()
static void	forceFieldValue(Class c, Object o, String field, Object value) force setting a field ignoring private/protected/final flags (unless hindered by security manager)
static Class	getClass(String className) return a class from the classname, reloading the class file if it changed
static String	getErrorMessage(int errorCode)
static Field	getFOfO(Object obj, String field) get the field of an object(s class)
static Field	getFOfO(Object obj, String field, boolean force) get the field of an object(s class)
static Object	invokeMethodWithUp2DateClass(String className, String methodName) first a test is made if the class file changed on disk since it was last loaded, in which case the class is reloaded from disk˙ then the method (with a no-argument signature) is called passing a newly created instance of the class if the method is not static.
static Object	invokeMethodWithUp2DateClass(String className, String methodName, boolean server) first a test is made if the class file changed on disk since it was last loaded, in which case the class is reloaded from disk˙ then the method (with a no-argument signature) is called passing a newly created instance of the class if the method is not static˙ optionally the method is invoked in the MethodServer.
static Object	invokeMethodWithUp2DateClass(String className, String methodName, Class[] types, Object[] args) first a test is made if the class file changed on disk since it was last loaded, in which case the class is reloaded from disk˙ then the method is called passing a newly created instance of the class if the method is not static.
static Object	invokeMethodWithUp2DateClass(String className, String methodName, Class[] types, Object[] args, boolean server) first a test is made if the class file changed on disk since it was last loaded, in which case the class is reloaded from disk˙ then the method is called passing a newly created instance of the class if the method is not static˙ optionally the method is invoked in the MethodServer.
static Object	invokeMethodWithUp2DateClass(String className, String methodName, Class[] types, Object[] args, Boolean server) first a test is made if the class file changed on disk since it was last loaded, in which case the class is reloaded from disk˙ then the method is called passing a newly created instance of the class if the method is not static˙ optionally the method is invoked in the MethodServer, and the user to run as can be passed as well.
static Object	invokeMethodWithUp2DateClass(String className, String methodName, Class[] types, Object[] args, Boolean server, String suTo) first a test is made if the class file changed on disk since it was last loaded, in which case the class is reloaded from disk˙ then the method is called passing a newly created instance of the class if the method is not static˙ optionally the method is invoked in the MethodServer, and the user to run as can be passed as well.
static Object	invokeMethodWithUp2DateClass(String className, String methodName, Class[] types, Object[] args, Boolean server, String suTo, Boolean want) first a test is made if the class file changed on disk since it was last loaded, in which case the class is reloaded from disk˙ then the method is called passing a newly created instance of the class if the method is not static˙ optionally the method is invoked in the MethodServer, and the user to run as can be passed as well.
static Object	invokeMethodWithUp2DateClass(String className, String methodName, Class[] types, Object[] args, String user, String password) first a test is made if the class file changed on disk since it was last loaded, in which case the class is reloaded from disk˙ then the method is called passing a newly created instance of the class if the method is not static˙ optionally the method is invoked in the MethodServer, and the user to run as can be passed as well.
static int	isMethodValid(String className, String methodName, Class[] paramList)
static void	main(String[] a) print program usage info or invoke test cases
static void	setFOnO(Object obj, String field, Object value) set the value of an object's (internal) field (=attribute)
static void	setFOnO(Object obj, String field, Object value, boolean force) set the value of an object's (internal) field (=attribute)
static void	setReload(Map in)

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAJOR

public static final int MAJOR

See Also:

Constant Field Values

MINOR

public static final int MINOR

See Also:

Constant Field Values

CMCALLCHECK_UNKNOWN_ERROR

public static final int CMCALLCHECK_UNKNOWN_ERROR

See Also:

Constant Field Values

CMCALLCHECK_BAD_CLASS

public static final int CMCALLCHECK_BAD_CLASS

See Also:

Constant Field Values

CMCALLCHECK_INVALID_CLASS

public static final int CMCALLCHECK_INVALID_CLASS

See Also:

Constant Field Values

CMCALLCHECK_NO_SUCH_METHOD

public static final int CMCALLCHECK_NO_SUCH_METHOD

See Also:

Constant Field Values

CMCALLCHECK_OK

public static final int CMCALLCHECK_OK

See Also:

Constant Field Values

checkReload

public static boolean checkReload

Constructor Detail

SulisReflectionMagic

public SulisReflectionMagic()

Method Detail

main

public static void main(String[] a)
                 throws Exception

print program usage info or invoke test cases

Parameters:

a - commandline args

Throws:

Exception

setReload

public static void setReload(Map in)

classVersions

public static List<Object[]> classVersions()
                                    throws Exception

Throws:

Exception

invokeMethodWithUp2DateClass

public static Object invokeMethodWithUp2DateClass(String className,
                                  String methodName)
                                           throws Exception

first a test is made if the class file changed on disk since it was last loaded, in which case the class is reloaded from disk˙
then the method (with a no-argument signature) is called passing a newly created instance of the class if the method is not static.

Parameters:

className - fully qualified name of class to [re]load

methodName - name of method to invoke

Returns:

whatever the method returns

Throws:

Exception

invokeMethodWithUp2DateClass

public static Object invokeMethodWithUp2DateClass(String className,
                                  String methodName,
                                  boolean server)
                                           throws Exception

first a test is made if the class file changed on disk since it was last loaded, in which case the class is reloaded from disk˙
then the method (with a no-argument signature) is called passing a newly created instance of the class if the method is not static˙
optionally the method is invoked in the MethodServer.

Parameters:

className - fully qualified name of class to [re]load

methodName - name of method to invoke

server - flag if method must run in MethodServer

Returns:

whatever the method returns

Throws:

Exception

invokeMethodWithUp2DateClass

public static Object invokeMethodWithUp2DateClass(String className,
                                  String methodName,
                                  Class[] types,
                                  Object[] args)
                                           throws Exception

first a test is made if the class file changed on disk since it was last loaded, in which case the class is reloaded from disk˙
then the method is called passing a newly created instance of the class if the method is not static.

Parameters:

className - fully qualified name of class to [re]load

methodName - name of method to invoke

types - method parameter types

args - method call arguments

Returns:

whatever the method returns

Throws:

Exception

invokeMethodWithUp2DateClass

public static Object invokeMethodWithUp2DateClass(String className,
                                  String methodName,
                                  Class[] types,
                                  Object[] args,
                                  boolean server)
                                           throws Exception

first a test is made if the class file changed on disk since it was last loaded, in which case the class is reloaded from disk˙
then the method is called passing a newly created instance of the class if the method is not static˙
optionally the method is invoked in the MethodServer.

Parameters:

className - fully qualified name of class to [re]load

methodName - name of method to invoke

types - method parameter types

args - method call arguments

server - flag if method must run in MethodServer

Returns:

whatever the method returns

Throws:

Exception

invokeMethodWithUp2DateClass

public static Object invokeMethodWithUp2DateClass(String className,
                                  String methodName,
                                  Class[] types,
                                  Object[] args,
                                  String user,
                                  String password)
                                           throws Exception

first a test is made if the class file changed on disk since it was last loaded, in which case the class is reloaded from disk˙
then the method is called passing a newly created instance of the class if the method is not static˙
optionally the method is invoked in the MethodServer, and the user to run as can be passed as well.

Parameters:

className - fully qualified name of class to [re]load

methodName - name of method to invoke

types - method parameter types

args - method call arguments

user - user to run as

password - authenticate the user

Returns:

whatever the method returns

Throws:

Exception

invokeMethodWithUp2DateClass

public static Object invokeMethodWithUp2DateClass(String className,
                                  String methodName,
                                  Class[] types,
                                  Object[] args,
                                  Boolean server)
                                           throws Exception

first a test is made if the class file changed on disk since it was last loaded, in which case the class is reloaded from disk˙
then the method is called passing a newly created instance of the class if the method is not static˙
optionally the method is invoked in the MethodServer, and the user to run as can be passed as well.

Parameters:

className - fully qualified name of class to [re]load

methodName - name of method to invoke

types - method parameter types

args - method call arguments

server - flag if method must run in MethodServer

Returns:

whatever the method returns

Throws:

Exception

invokeMethodWithUp2DateClass

public static Object invokeMethodWithUp2DateClass(String className,
                                  String methodName,
                                  Class[] types,
                                  Object[] args,
                                  Boolean server,
                                  String suTo)
                                           throws Exception

first a test is made if the class file changed on disk since it was last loaded, in which case the class is reloaded from disk˙
then the method is called passing a newly created instance of the class if the method is not static˙
optionally the method is invoked in the MethodServer, and the user to run as can be passed as well.

Parameters:

className - fully qualified name of class to [re]load

methodName - name of method to invoke

types - method parameter types

args - method call arguments

server - flag if method must run in MethodServer

suTo - if not null contains the name of the user we need to switch to before the method is invoked

Returns:

whatever the method returns

Throws:

Exception

invokeMethodWithUp2DateClass

public static Object invokeMethodWithUp2DateClass(String className,
                                  String methodName,
                                  Class[] types,
                                  Object[] args,
                                  Boolean server,
                                  String suTo,
                                  Boolean want)
                                           throws Throwable

first a test is made if the class file changed on disk since it was last loaded, in which case the class is reloaded from disk˙
then the method is called passing a newly created instance of the class if the method is not static˙
optionally the method is invoked in the MethodServer, and the user to run as can be passed as well.

Parameters:

className - fully qualified name of class to [re]load

methodName - name of method to invoke

types - method parameter types

args - method call arguments

server - flag if method must run in MethodServer

suTo - if not null contains the name of the user we need to switch to before the method is invoked

Returns:

whatever the method returns

Throws:

Exception

Throwable

flush

public static void flush()

getClass

public static Class getClass(String className)
                      throws Exception

return a class from the classname, reloading the class file if it changed

Parameters:

className - fully qualified class name

Returns:

the class

Throws:

Exception

setFOnO

public static void setFOnO(Object obj,
           String field,
           Object value)
                    throws Exception

set the value of an object's (internal) field (=attribute)

Parameters:

obj - the object to set value of

field - the name of the field

value - the value to set - make sure it is of the correct type.

Throws:

Exception - if anything goes wrong (name bad, value bad, field protected or private etc.)

setFOnO

public static void setFOnO(Object obj,
           String field,
           Object value,
           boolean force)
                    throws Exception

set the value of an object's (internal) field (=attribute)

Parameters:

obj - the object to set value of

field - the name of the field

value - the value to set - make sure it is of the correct type.

force - if true will ignore private/protected flag (unless hindered by security manager)

Throws:

Exception - if anything goes wrong (name bad, value bad etc.)

forceFieldValue

public static void forceFieldValue(Class c,
                   Object o,
                   String field,
                   Object value)
                            throws Exception

force setting a field ignoring private/protected/final flags (unless hindered by security manager)

Parameters:

c - class holding field

o - instance object (can be null for static fields)

field - field name

value - new field value

Throws:

Exception

getFOfO

public static Field getFOfO(Object obj,
            String field)
                     throws Exception

get the field of an object(s class)

Parameters:

obj - the object to retrieve the field from

field - the name of the field

Throws:

Exception - if anything goes wrong (name bad?)

getFOfO

public static Field getFOfO(Object obj,
            String field,
            boolean force)
                     throws Exception

get the field of an object(s class)

Parameters:

obj - the object to retrieve the field from

field - the name of the field

force - if true will ignore private/protected flag and return an accessible Field (unless hindered by security manager)

Throws:

Exception - if anything goes wrong (name bad?)

callMOnO

public static Object callMOnO(Object o,
              String m)
                       throws Exception

call no-argument version of named method on object passed (see 5-argument version of method for full description)

Parameters:

o - the object to invoke method on

m - the name of the method

Returns:

whatever the method returns

Throws:

Exception

callMOnO

public static Object callMOnO(Object o,
              String m,
              Class[] argTypes,
              Object[] args)
                       throws Exception

call named method on object passed (see 5-argument version of method for full description)

Parameters:

o - the object to invoke method on

m - the name of the method

argTypes - argument types for the method to find/call

args - the arguments to pass

Returns:

whatever the method returns

Throws:

Exception

callMOnO

public static Object callMOnO(Object o,
              String m,
              Class[] argTypes,
              Object[] args,
              boolean force)
                       throws Exception

call named method on object passed - if the name of the method contains one or more periods (.), the calls are chained, allowing constructs like getCreator.getFullName.toUpperCase Note that in this case all methods must have the same signature which usually means you chain getter methods.

Parameters:

o - the object to invoke method on

m - the name of the method

argTypes - argument types for the method to find/call

args - the arguments to pass

force - flag if private/protected access should be overridden

Returns:

whatever the method returns

Throws:

Exception

isMethodValid

public static int isMethodValid(String className,
                String methodName,
                Class[] paramList)

getErrorMessage

public static String getErrorMessage(int errorCode)