oracle.toplink.essentials.internal.security

Class PrivilegedAccessHelper

java.lang.Object

oracle.toplink.essentials.internal.security.PrivilegedAccessHelper

public class PrivilegedAccessHelper
extends java.lang.Object

INTERNAL: Privileged Access Helper provides a utility so all calls that require privileged access can use the same code For users that wish to use a security manager and disable the use of doPrivileged, users can set one of two system flags (through the java -Dxxxxx option): oracle.j2ee.toplink.security.usedoprivileged=false oracle.j2ee.security.usedoprivileged=false

Constructor Summary

Constructors

Constructor and Description
PrivilegedAccessHelper()

Method Summary

Modifier and Type	Method and Description
static java.lang.Class	getClassForName(java.lang.String className) Execute a java Class.forName().
static java.lang.Class	getClassForName(java.lang.String className, boolean initialize, java.lang.ClassLoader loader) Execute a java Class.forName() wrap the call in a doPrivileged block if necessary.
static java.lang.ClassLoader	getClassLoaderForClass(java.lang.Class clazz) Gets the class loader for a given class.
static java.lang.reflect.Constructor	getConstructorFor(java.lang.Class javaClass, java.lang.Class[] args, boolean shouldSetAccessible) Get the public constructor for the given class and given arguments and wrap it in doPrivileged if necessary.
static java.lang.ClassLoader	getContextClassLoader(java.lang.Thread thread) Get the context ClassLoader for a thread.
static java.lang.reflect.Constructor	getDeclaredConstructorFor(java.lang.Class javaClass, java.lang.Class[] args, boolean shouldSetAccessible) Get the constructor for the given class and given arguments (regardless of whether it is public or private))and wrap it in doPrivileged if necessary.
static java.lang.reflect.Field	getDeclaredField(java.lang.Class javaClass, java.lang.String fieldName, boolean shouldSetAccessible) Get a field actually declared in a class and wrap the call in doPrivileged if necessary.
static java.lang.reflect.Field[]	getDeclaredFields(java.lang.Class clazz) Get the list of fields in a class.
static java.lang.reflect.Method	getDeclaredMethod(java.lang.Class clazz, java.lang.String methodName, java.lang.Class[] methodParameterTypes) Return a method on a given class with the given method name and parameter types.
static java.lang.reflect.Method[]	getDeclaredMethods(java.lang.Class clazz) Get the list of methods in a class.
static java.lang.reflect.Field	getField(java.lang.Class javaClass, java.lang.String fieldName, boolean shouldSetAccessible) Get a field in a class or its superclasses and wrap the call in doPrivileged if necessary.
static java.lang.Class	getFieldType(java.lang.reflect.Field field) Get the return type for a given method.
static java.lang.String	getLineSeparator() Get the line separator character.
static java.lang.reflect.Method	getMethod(java.lang.Class javaClass, java.lang.String methodName, java.lang.Class[] methodParameterTypes, boolean shouldSetAccessible) Get a method declared in the given class.
static java.lang.Class[]	getMethodParameterTypes(java.lang.reflect.Method method) Get the list of parameter types for a given method.
static java.lang.Class	getMethodReturnType(java.lang.reflect.Method method) Get the return type for a given method.
static java.lang.reflect.Method[]	getMethods(java.lang.Class clazz) Get the list of methods in a class.
static java.lang.Object	getValueFromField(java.lang.reflect.Field field, java.lang.Object object) Get the value of the given field in the given object.
static java.lang.Object	invokeConstructor(java.lang.reflect.Constructor constructor, java.lang.Object[] args) Construct an object with the given Constructor and the given array of arguments.
static java.lang.Object	invokeMethod(java.lang.reflect.Method method, java.lang.Object object, java.lang.Object[] parameters) Invoke the givenMethod on a givenObject using the array of parameters given.
static java.lang.Object	newInstanceFromClass(java.lang.Class clazz) Get a new instance of a class using the default constructor.
static void	setValueInField(java.lang.reflect.Field field, java.lang.Object object, java.lang.Object value) Set the value of a given field in the given object with the value given.
static boolean	shouldUsePrivilegedAccess() This method checks to see if calls should be made to doPrivileged.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrivilegedAccessHelper

public PrivilegedAccessHelper()

Method Detail

getClassForName

public static java.lang.Class getClassForName(java.lang.String className)
                                       throws java.lang.ClassNotFoundException

Execute a java Class.forName(). Wrap the call in a doPrivileged block if necessary.

Parameters:

className -

Throws:

java.lang.ClassNotFoundException

getClassForName

public static java.lang.Class getClassForName(java.lang.String className,
                                              boolean initialize,
                                              java.lang.ClassLoader loader)
                                       throws java.lang.ClassNotFoundException

Execute a java Class.forName() wrap the call in a doPrivileged block if necessary.

Parameters:

className -

initialize -

loader -

Throws:

java.lang.ClassNotFoundException

getClassLoaderForClass

public static java.lang.ClassLoader getClassLoaderForClass(java.lang.Class clazz)

Gets the class loader for a given class. Wraps the call in a privileged block if necessary

getConstructorFor

public static java.lang.reflect.Constructor getConstructorFor(java.lang.Class javaClass,
                                                              java.lang.Class[] args,
                                                              boolean shouldSetAccessible)
                                                       throws java.lang.NoSuchMethodException

Get the public constructor for the given class and given arguments and wrap it in doPrivileged if necessary. The shouldSetAccessible parameter allows the the setAccessible API to be called as well. This option was added to avoid making multiple doPrivileged calls within InstantiationPolicy.

Parameters:

javaClass - The class to get the Constructor for

args - An array of classes representing the argument types of the constructor

shouldSetAccessible - whether or not to call the setAccessible API

Throws:

java.lang.NoSuchMethodException

getContextClassLoader

public static java.lang.ClassLoader getContextClassLoader(java.lang.Thread thread)

Get the context ClassLoader for a thread. Wrap the call in a doPrivileged block if necessary.

getDeclaredConstructorFor

public static java.lang.reflect.Constructor getDeclaredConstructorFor(java.lang.Class javaClass,
                                                                      java.lang.Class[] args,
                                                                      boolean shouldSetAccessible)
                                                               throws java.lang.NoSuchMethodException

Get the constructor for the given class and given arguments (regardless of whether it is public or private))and wrap it in doPrivileged if necessary. The shouldSetAccessible parameter allows the the setAccessible API to be called as well. This option was added to avoid making multiple doPrivileged calls within InstantiationPolicy.

Parameters:

javaClass - The class to get the Constructor for

args - An array of classes representing the argument types of the constructor

shouldSetAccessible - whether or not to call the setAccessible API

Throws:

java.lang.NoSuchMethodException

getField

public static java.lang.reflect.Field getField(java.lang.Class javaClass,
                                               java.lang.String fieldName,
                                               boolean shouldSetAccessible)
                                        throws java.lang.NoSuchFieldException

Get a field in a class or its superclasses and wrap the call in doPrivileged if necessary. The shouldSetAccessible parameter allows the the setAccessible API to be called as well. This option was added to avoid making multiple doPrivileged calls within InstanceVariableAttributeAccessor.

Parameters:

javaClass - The class to get the field from

fieldName - The name of the field

shouldSetAccessible - whether or not to call the setAccessible API

Throws:

java.lang.NoSuchFieldException

getDeclaredField

public static java.lang.reflect.Field getDeclaredField(java.lang.Class javaClass,
                                                       java.lang.String fieldName,
                                                       boolean shouldSetAccessible)
                                                throws java.lang.NoSuchFieldException

Get a field actually declared in a class and wrap the call in doPrivileged if necessary. The shouldSetAccessible parameter allows the the setAccessible API to be called as well. This option was added to avoid making multiple doPrivileged calls within InstanceVariableAttributeAccessor.

Parameters:

javaClass - The class to get the field from

fieldName - The name of the field

shouldSetAccessible - whether or not to call the setAccessible API

Throws:

java.lang.NoSuchFieldException

getDeclaredFields

public static java.lang.reflect.Field[] getDeclaredFields(java.lang.Class clazz)

Get the list of fields in a class. Wrap the call in doPrivileged if necessary Excludes inherited fields.

Parameters:

clazz - the class to get the fields from.

getDeclaredMethod

public static java.lang.reflect.Method getDeclaredMethod(java.lang.Class clazz,
                                                         java.lang.String methodName,
                                                         java.lang.Class[] methodParameterTypes)
                                                  throws java.lang.NoSuchMethodException

Return a method on a given class with the given method name and parameter types. This call will NOT traverse the superclasses. Wrap the call in doPrivileged if necessary.

Parameters:

method - the class to get the method from

methodName - the name of the method to get

methodParameters - a list of classes representing the classes of the parameters of the method.

Throws:

java.lang.NoSuchMethodException

getMethod

public static java.lang.reflect.Method getMethod(java.lang.Class javaClass,
                                                 java.lang.String methodName,
                                                 java.lang.Class[] methodParameterTypes,
                                                 boolean shouldSetAccessible)
                                          throws java.lang.NoSuchMethodException

Get a method declared in the given class. Wrap the call in doPrivileged if necessary. This call will traver the superclasses. The shouldSetAccessible parameter allows the the setAccessible API to be called as well. This option was added to avoid making multiple doPrivileged calls within MethodBasedAttributeAccessor.

Parameters:

javaClass - The class to get the method from

methodName - The name of the method to get

methodParameterTypes - A list of classes representing the classes of the parameters of the mthod

shouldSetAccessible - whether or not to call the setAccessible API

Throws:

java.lang.NoSuchMethodException

getDeclaredMethods

public static java.lang.reflect.Method[] getDeclaredMethods(java.lang.Class clazz)

Get the list of methods in a class. Wrap the call in doPrivileged if necessary. Excludes inherited methods.

Parameters:

clazz - the class to get the methods from.

getFieldType

public static java.lang.Class getFieldType(java.lang.reflect.Field field)

Get the return type for a given method. Wrap the call in doPrivileged if necessary.

Parameters:

field -

getLineSeparator

public static java.lang.String getLineSeparator()

Get the line separator character. Previous versions of TopLink always did this in a privileged block so we will continue to do so.

getMethodParameterTypes

public static java.lang.Class[] getMethodParameterTypes(java.lang.reflect.Method method)

Get the list of parameter types for a given method. Wrap the call in doPrivileged if necessary.

Parameters:

method - The method to get the parameter types of

getMethodReturnType

public static java.lang.Class getMethodReturnType(java.lang.reflect.Method method)

Get the return type for a given method. Wrap the call in doPrivileged if necessary.

Parameters:

method -

getMethods

public static java.lang.reflect.Method[] getMethods(java.lang.Class clazz)

Get the list of methods in a class. Wrap the call in doPrivileged if necessary. This call will traver the superclasses.

Parameters:

clazz - the class to get the methods from.

getValueFromField

public static java.lang.Object getValueFromField(java.lang.reflect.Field field,
                                                 java.lang.Object object)
                                          throws java.lang.IllegalAccessException

Get the value of the given field in the given object.

Throws:

java.lang.IllegalAccessException

invokeConstructor

public static java.lang.Object invokeConstructor(java.lang.reflect.Constructor constructor,
                                                 java.lang.Object[] args)
                                          throws java.lang.IllegalAccessException,
                                                 java.lang.reflect.InvocationTargetException,
                                                 java.lang.InstantiationException

Construct an object with the given Constructor and the given array of arguments. Wrap the call in a doPrivileged block if necessary.

Throws:

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

java.lang.InstantiationException

invokeMethod

public static java.lang.Object invokeMethod(java.lang.reflect.Method method,
                                            java.lang.Object object,
                                            java.lang.Object[] parameters)
                                     throws java.lang.IllegalAccessException,
                                            java.lang.reflect.InvocationTargetException

Invoke the givenMethod on a givenObject using the array of parameters given. Wrap in a doPrivileged block if necessary.

Throws:

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

newInstanceFromClass

public static java.lang.Object newInstanceFromClass(java.lang.Class clazz)
                                             throws java.lang.IllegalAccessException,
                                                    java.lang.InstantiationException

Get a new instance of a class using the default constructor. Wrap the call in a privileged block if necessary.

Throws:

java.lang.IllegalAccessException

java.lang.InstantiationException

setValueInField

public static void setValueInField(java.lang.reflect.Field field,
                                   java.lang.Object object,
                                   java.lang.Object value)
                            throws java.lang.IllegalAccessException

Set the value of a given field in the given object with the value given. Wrap the call in a privileged block if necessary.

Throws:

java.lang.IllegalAccessException

shouldUsePrivilegedAccess

public static boolean shouldUsePrivilegedAccess()

This method checks to see if calls should be made to doPrivileged. In general, if a security manager is enabled, it will return true and if one is not enabled, it will return false. It will, however, always return false if either of the following two java properties is set. oracle.j2ee.toplink.security.usedoprivileged=false oracle.j2ee.security.usedoprivileged=false Note: it is not possible to run TopLink using doPrivileged blocks when there is no SecurityManager enabled.