org.datanucleus.enhancer.EnhancementHelper Maven / Gradle / Ivy
Show all versions of datanucleus-core Show documentation
/**********************************************************************
Copyright (c) 2014 Andy Jefferson and others. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Contributors:
...
**********************************************************************/
package org.datanucleus.enhancer;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.EventListener;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import org.datanucleus.enhancement.Persistable;
import org.datanucleus.enhancement.StateManager;
import org.datanucleus.exceptions.NucleusUserException;
/**
* Helper class for the DN bytecode enhancement contract.
* It contains methods to register metadata for persistable classes and to perform common operations needed by implementations, not by end users.
*
* It allows construction of instances of persistable classes without using reflection.
*
* Persistable classes register themselves via a static method at class load time. There is no security restriction on this access.
*
* TODO Provide a mechanism to automatically deregister classes when their class loader exits? or register against the NucleusContext?
*/
public class EnhancementHelper extends java.lang.Object
{
private static EnhancementHelper singletonHelper = new EnhancementHelper();
/**
* Static mapping of Persistable class to an instance of that class.
* New entries are added by the static method in each Persistable class initialisation. Entries are never removed.
*/
private static Map registeredClasses = new ConcurrentHashMap<>();
/**
* This list contains the registered listeners for RegisterClassEvents.
*/
private static final List listeners = new ArrayList();
private EnhancementHelper()
{
}
public static EnhancementHelper getInstance()/* throws SecurityException*/
{
return singletonHelper;
}
/**
* Create a new instance of the class and assign its StateManager.
* @see Persistable#dnNewInstance(StateManager sm)
* @param pcClass the Persistable class.
* @param sm the StateManager which will own the new instance.
* @return the new instance, or null if the class is not registered.
*/
public Persistable newInstance(Class pcClass, StateManager sm)
{
Persistable pc = getPersistableForClass(pcClass);
return pc == null ? null : pc.dnNewInstance(sm);
}
/**
* Create a new instance of the class and assign its StateManager and key values from the ObjectId. If the oid parameter is null, no key values are copied.
* The new instance has its dnFlags set to LOAD_REQUIRED.
* @see Persistable#dnNewInstance(StateManager sm, Object oid)
* @param pcClass the Persistable class.
* @param sm the StateManager which will own the new instance.
* @return the new instance, or null if the class is not registered.
* @param oid the ObjectId instance from which to copy key field values.
*/
public Persistable newInstance(Class pcClass, StateManager sm, Object oid)
{
Persistable pc = getPersistableForClass(pcClass);
return pc == null ? null : pc.dnNewInstance(sm, oid);
}
/**
* Create a new instance of the ObjectId class of this Persistable class.
* It is intended only for application identity.
* This method should not be called for classes that use single field identity; newObjectIdInstance(Class, Object) should be used instead.
* If the class has been enhanced for datastore identity, or if the class is abstract, null is returned.
* @param pcClass the Persistable class.
* @return the new ObjectId instance, or null if the class is not registered.
*/
public Object newObjectIdInstance(Class pcClass)
{
Persistable pc = getPersistableForClass(pcClass);
return pc == null ? null : pc.dnNewObjectIdInstance();
}
/**
* Create a new instance of the class used by the parameter Class for JDO identity, using the key constructor of the object id class.
* It is intended for single field identity.
* The identity instance returned has no relationship with the values of the primary key fields of the persistence-capable instance on which the method is called.
* If the key is the wrong class for the object id class, null is returned.
*
* For classes that use single field identity, if the parameter is of one of the following types, the behavior must be as specified:
*
* Number or Character: the parameter must be the single field type or the
* wrapper class of the primitive field type; the parameter is passed to the single field identity constructorObjectIdFieldSupplier: the field value is fetched from the
* ObjectIdFieldSupplier and passed to the single field identity constructorString: the String is passed to the single field identity constructor
* @return the new ObjectId instance, or null if the class is not registered.
* @param obj the Object form of the object id
* @param pcClass the Persistable class.
*/
public Object newObjectIdInstance(Class pcClass, Object obj)
{
Persistable pc = getPersistableForClass(pcClass);
return (pc == null) ? null : pc.dnNewObjectIdInstance(obj);
}
public static interface RegisterClassListener extends EventListener
{
/**
* This method gets called when a Persistable class is registered.
* @param registeredClass The class that has just been initialised/registered
*/
public void registerClass(Class registeredClass);
}
/**
* Register metadata by class.
* This is called by the enhanced constructor of the Persistable class.
* @param pcClass the Persistable class used as the key for lookup.
* @param pc an instance of the Persistable class. TODO We can just do pcClass.newInstance() to get one!
*/
public static void registerClass(Class pcClass, Persistable pc)
{
if (pcClass == null)
{
throw new NullPointerException("Attempt to register class with null class type");
}
registeredClasses.put(pcClass, new Meta(pc));
// Notify all listeners
synchronized (listeners)
{
if (!listeners.isEmpty())
{
for (Iterator i = listeners.iterator(); i.hasNext();)
{
RegisterClassListener crl = (RegisterClassListener) i.next();
if (crl != null)
{
crl.registerClass(pcClass);
}
}
}
}
}
/**
* Unregister all classes for the specified class loader.
* @param cl ClassLoader
*/
public void unregisterClasses (ClassLoader cl)
{
synchronized(registeredClasses)
{
for (Iterator i = registeredClasses.keySet().iterator(); i.hasNext();)
{
Class pcClass = (Class)i.next();
// Note, the pc class was registered by calling the static method EnhancementHelper.registerClass.
// This means the EnhancementHelper class loader is the same as or an ancestor of the class loader of the pc class.
if ((pcClass != null) && (pcClass.getClassLoader() == cl))
{
// unregister pc class, if its class loader is the specified one.
i.remove();
}
}
}
}
/**
* Add the specified RegisterClassListener to the listener list.
* @param crl the listener to be added
*/
public void addRegisterClassListener(RegisterClassListener crl)
{
Set alreadyRegisteredClasses = null;
synchronized (listeners)
{
listeners.add(crl);
// Make a copy of the existing set of registered classes.
// Between these two lines of code, any number of new class registrations might occur, and will then all wait until this synchronized block completes.
// Some of the class registrations might be delivered twice to the newly registered listener.
alreadyRegisteredClasses = new HashSet(registeredClasses.keySet());
}
// new registrations will call the new listener while the following occurs notify the new listener about already-registered classes
for (Class pcClass : alreadyRegisteredClasses)
{
crl.registerClass(pcClass);
}
}
/**
* Remove the specified RegisterClassListener from the listener list.
* @param crl the listener to be removed
*/
public void removeRegisterClassListener(RegisterClassListener crl)
{
synchronized (listeners)
{
listeners.remove(crl);
}
}
/**
* Returns a collection of class objects of the registered persistable classes.
* @return registered persistable classes
*/
public Collection getRegisteredClasses()
{
return Collections.unmodifiableCollection(registeredClasses.keySet());
}
/**
* Look up the instance for a Persistable class.
* @param pcClass the Class.
* @return the Persistable instance for the Class.
*/
private static Persistable getPersistableForClass(Class pcClass)
{
Meta ret = registeredClasses.get(pcClass);
if (ret == null)
{
// Commented out code that we could enable, particularly if we update registerClass to not pass an instance
/*if (Persistable.class.isAssignableFrom(pcClass))
{
// Not yet registered but this is Persistable, so create an instance
Persistable pc;
try
{
pc = (Persistable) pcClass.newInstance();
registeredClasses.put(pcClass, new Meta(pc));
return pc;
}
catch (InstantiationException | IllegalAccessException e)
{
}
}*/
throw new NucleusUserException("Cannot lookup meta info for " + pcClass + " - nothing found").setFatal();
}
return ret.getPC();
}
/**
* Helper class to manage persistable classes.
*/
static class Meta
{
/** Instance of Persistable, used at runtime to create new instances. */
Persistable pc;
/**
* Construct an instance of Meta.
* @param pc An instance of the Persistable class
*/
Meta(Persistable pc)
{
this.pc = pc;
}
Persistable getPC()
{
return pc;
}
public String toString()
{
return "Meta-" + pc.getClass().getName();
}
}
}