/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* // Copyright (c) 1998, 2007, Oracle. All rights reserved.
*
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package oracle.toplink.essentials.internal.ejb.cmp3.metadata.listeners;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.security.AccessController;
import java.security.PrivilegedActionException;
import java.util.Hashtable;
import java.util.Vector;
import oracle.toplink.essentials.descriptors.DescriptorEvent;
import oracle.toplink.essentials.descriptors.DescriptorEventAdapter;
import oracle.toplink.essentials.descriptors.DescriptorEventManager;
import oracle.toplink.essentials.exceptions.ValidationException;
import oracle.toplink.essentials.internal.security.PrivilegedAccessHelper;
import oracle.toplink.essentials.internal.security.PrivilegedMethodInvoker;
/**
* A MetadataEntityListener and is placed on the owning entity's descriptor.
* Callback methods from an EntityListener require a signature on the method.
* Namely, they must have an Object parameter.
*
* @author Guy Pelletier
* @since TopLink 10.1.3/EJB 3.0 Preview
*/
public class MetadataEntityListener extends DescriptorEventAdapter {
public final static String POST_BUILD = "postBuild";
public final static String POST_CLONE = "postClone";
public final static String POST_DELETE = "postDelete";
public final static String POST_INSERT = "postInsert";
public final static String POST_REFRESH = "postRefresh";
public final static String POST_UPDATE = "postUpdate";
public final static String PRE_PERSIST = "prePersist";
public final static String PRE_REMOVE = "preRemove";
public final static String PRE_UPDATE_WITH_CHANGES = "preUpdateWithChanges";
private Object m_listener;
private Class m_entityClass;
private Hashtable<String, Method> m_methods;
private Hashtable<Integer, Boolean> m_overriddenEvents;
private static Hashtable<Integer, String> m_eventStrings;
/**
* INTERNAL:
* The default constructor should not be used.
*/
protected MetadataEntityListener() {
m_methods = new Hashtable<String, Method>();
// Remember which events are overridden in subclasses.
m_overriddenEvents = new Hashtable<Integer, Boolean>();
// For quick look up of equivalent event strings from event codes.
if (m_eventStrings == null) {
m_eventStrings = new Hashtable<Integer, String>();
m_eventStrings.put(new Integer(DescriptorEventManager.PostBuildEvent), POST_BUILD);
m_eventStrings.put(new Integer(DescriptorEventManager.PostCloneEvent), POST_CLONE);
m_eventStrings.put(new Integer(DescriptorEventManager.PostDeleteEvent), POST_DELETE);
m_eventStrings.put(new Integer(DescriptorEventManager.PostInsertEvent), POST_INSERT);
m_eventStrings.put(new Integer(DescriptorEventManager.PostRefreshEvent), POST_REFRESH);
m_eventStrings.put(new Integer(DescriptorEventManager.PostUpdateEvent), POST_UPDATE);
m_eventStrings.put(new Integer(DescriptorEventManager.PrePersistEvent), PRE_PERSIST);
m_eventStrings.put(new Integer(DescriptorEventManager.PreRemoveEvent), PRE_REMOVE);
m_eventStrings.put(new Integer(DescriptorEventManager.PreUpdateWithChangesEvent), PRE_UPDATE_WITH_CHANGES);
}
}
/**
* INTERNAL:
*/
protected MetadataEntityListener(Class entityClass) {
this();
m_entityClass = entityClass;
}
/**
* INTERNAL:
*/
public MetadataEntityListener(Class listenerClass, Class entityClass) {
this(entityClass);
try {
m_listener = listenerClass.newInstance();
} catch (Exception ex) {
ValidationException.errorInstantiatingClass(listenerClass, ex);
}
}
/**
* INTERNAL:
*/
public void addEventMethod(String event, Method method) {
validateMethod(method);
if (m_methods.containsKey(event)) {
throw ValidationException.multipleLifecycleCallbackMethodsForSameLifecycleEvent(getListenerClass(), method, getEventMethod(event));
} else {
m_methods.put(event, method);
}
}
/**
* INTERNAL:
*/
public Class getEntityClass() {
return m_entityClass;
}
/**
* INTERNAL:
*/
protected Method getEventMethod(int eventCode) {
String eventString = m_eventStrings.get(eventCode);
if (eventString != null) {
return getEventMethod(eventString);
} else {
return null;
}
}
/**
* INTERNAL:
*/
protected Method getEventMethod(String event) {
return m_methods.get(event);
}
/**
* INTERNAL:
*/
protected String getEventMethodName(String eventName) {
Method method = getEventMethod(eventName);
if (method != null) {
return method.getName();
} else {
return null;
}
}
/**
* INTERNAL:
*/
public Class getListenerClass() {
return m_listener.getClass();
}
/**
* INTERNAL:
*/
public Hashtable getMethods() {
return m_methods;
}
/**
* INTERNAL:
*/
public String getPostBuildMethodName() {
return getEventMethodName(POST_BUILD);
}
/**
* INTERNAL:
*/
public String getPostCloneMethodName() {
return getEventMethodName(POST_CLONE);
}
/**
* INTERNAL:
*/
public String getPostDeleteMethodName() {
return getEventMethodName(POST_DELETE);
}
/**
* INTERNAL:
*/
public String getPostInsertMethodName() {
return getEventMethodName(POST_INSERT);
}
/**
* INTERNAL:
*/
public String getPostRefreshMethodName() {
return getEventMethodName(POST_REFRESH);
}
/**
* INTERNAL:
*/
public String getPostUpdateMethodName() {
return getEventMethodName(POST_UPDATE);
}
/**
* INTERNAL:
*/
public String getPrePersistMethodName() {
return getEventMethodName(PRE_PERSIST);
}
/**
* INTERNAL:
*/
public String getPreRemoveMethodName() {
return getEventMethodName(PRE_REMOVE);
}
/**
* INTERNAL:
*/
public String getPreUpdateWithChangesMethodName() {
return getEventMethodName(PRE_UPDATE_WITH_CHANGES);
}
/**
* INTERNAL:
*/
public boolean hasCallbackMethods() {
return m_methods.size() > 0;
}
/**
* INTERNAL:
*/
public boolean hasOverriddenEventMethod(Method eventMethod, int eventCode) {
return hasOverriddenEventMethod(getEventMethod(eventCode), eventMethod);
}
/**
* INTERNAL:
*/
protected boolean hasOverriddenEventMethod(Method eventMethod1, Method eventMethod2) {
return (eventMethod1 != null && eventMethod1.getName().equals(eventMethod2.getName()));
}
/**
* INTERNAL:
*/
public boolean hasOverriddenEventMethod(Method eventMethod, String eventCode) {
return hasOverriddenEventMethod(getEventMethod(eventCode), eventMethod);
}
/**
* INTERNAL:
* Sub-classes should implement where necessary.
*/
public void initializeCallbackMethods(ClassLoader classLoader) {}
/**
* INTERNAL:
*/
protected void invokeMethod(Method method, Object onObject, Object[] objectList, DescriptorEvent event) {
//if (method != null && ! isSessionPostBuildEvent(event)) {
if (method != null) {
try {
if (PrivilegedAccessHelper.shouldUsePrivilegedAccess()){
try {
AccessController.doPrivileged(new PrivilegedMethodInvoker(method, onObject, objectList));
} catch (PrivilegedActionException exception) {
Exception throwableException = exception.getException();
if (throwableException instanceof IllegalAccessException) {
throw ValidationException.invalidCallbackMethod(onObject.getClass(), method.toString());
} else {
Throwable cause = throwableException.getCause();
if (cause instanceof RuntimeException) {
throw (RuntimeException) cause;
} else {
throw (Error) cause;
} }
}
} else {
PrivilegedAccessHelper.invokeMethod(method, onObject, objectList);
}
} catch (IllegalAccessException exception) {
// WIP throw a better exception string.
throw ValidationException.invalidCallbackMethod(onObject.getClass(), method.toString());
} catch (InvocationTargetException e) {
Throwable cause = e.getCause();
if (cause instanceof RuntimeException) {
throw (RuntimeException) cause;
} else {
throw (Error) cause;
}
}
}
}
/**
* INTERNAL:
*/
protected void invokeMethod(String event, DescriptorEvent descriptorEvent) {
Object[] objectList = { descriptorEvent.getSource() };
invokeMethod(getEventMethod(event), m_listener, objectList, descriptorEvent);
}
/**
* INTERNAL:
*/
public boolean isEntityClassListener() {
return false;
}
/**
* INTERNAL:
* Return true is listener has a lifecycle callback method that is
* overridden in a subclass.
*/
public boolean isOverriddenEvent(DescriptorEvent event, Vector eventManagers) {
int eventCode = event.getEventCode();
if (! m_overriddenEvents.containsKey(eventCode)) {
m_overriddenEvents.put(eventCode, false); // default
Method eventMethod = getEventMethod(eventCode);
if (eventMethod != null) {
for (DescriptorEventManager eventManager : (Vector<DescriptorEventManager>) eventManagers) {
MetadataEntityListener childListener = (MetadataEntityListener) eventManager.getEntityEventListener();
// We can't override ourself ...
if (childListener == this) {
break;
} else {
if (childListener.hasOverriddenEventMethod(eventMethod, eventCode)) {
m_overriddenEvents.put(eventCode, true);
break; // stop looking
}
}
}
}
}
return m_overriddenEvents.get(eventCode);
}
/**
* INTERNAL:
*/
protected boolean isSessionPostBuildEvent(DescriptorEvent event) {
if (((String) m_eventStrings.get(event.getEventCode())).equals(POST_BUILD)) {
return ! event.getSession().isUnitOfWork();
}
return false;
}
/**
* INTERNAL:
* Checks if the user already set this call back method via XML. We
* need to check because the set methods on the superclass will throw
* an exception when multiple methods are added for the callback.
*/
protected boolean noCallbackMethodAlreadySetFor(String event, Method method) {
Method cbMethod = (Method) getMethods().get(event);
if (cbMethod == null) {
return true;
} else {
return ! cbMethod.getName().equals(method.getName());
}
}
/**
* INTERNAL:
*/
public void postBuild(DescriptorEvent event) {
invokeMethod(POST_BUILD, event);
}
/**
* INTERNAL:
*/
public void postClone(DescriptorEvent event) {
invokeMethod(POST_CLONE, event);
}
/**
* INTERNAL:
*/
public void postDelete(DescriptorEvent event) {
invokeMethod(POST_DELETE, event);
}
/**
* INTERNAL:
*/
public void postInsert(DescriptorEvent event) {
invokeMethod(POST_INSERT, event);
}
/**
* INTERNAL:
*/
public void postRefresh(DescriptorEvent event) {
invokeMethod(POST_REFRESH, event);
}
/**
* INTERNAL:
*/
public void postUpdate(DescriptorEvent event) {
invokeMethod(POST_UPDATE, event);
}
/**
* INTERNAL:
*/
public void prePersist(DescriptorEvent event) {
invokeMethod(PRE_PERSIST, event);
}
/**
* INTERNAL:
*/
public void preRemove(DescriptorEvent event) {
invokeMethod(PRE_REMOVE, event);
}
/**
* INTERNAL:
*/
public void preUpdateWithChanges(DescriptorEvent event) {
invokeMethod(PRE_UPDATE_WITH_CHANGES, event);
}
/**
* INTERNAL:
*/
public void setEntityClass(Class entityClass) {
m_entityClass = entityClass;
}
/**
* INTERNAL:
*/
public void setListener(Object listener) {
m_listener = listener;
}
/**
* INTERNAL:
*/
public void setPostBuildMethod(Method method) {
addEventMethod(POST_BUILD, method);
}
/**
* INTERNAL:
*/
public void setPostCloneMethod(Method method) {
addEventMethod(POST_CLONE, method);
}
/**
* INTERNAL:
*/
public void setPostDeleteMethod(Method method) {
addEventMethod(POST_DELETE, method);
}
/**
* INTERNAL:
*/
public void setPostInsertMethod(Method method) {
addEventMethod(POST_INSERT, method);
}
/**
* INTERNAL:
*/
public void setPostRefreshMethod(Method method) {
addEventMethod(POST_REFRESH, method);
}
/**
* INTERNAL:
*/
public void setPostUpdateMethod(Method method) {
addEventMethod(POST_UPDATE, method);
}
/**
* INTERNAL:
*/
public void setPrePersistMethod(Method method) {
addEventMethod(PRE_PERSIST, method);
}
/**
* INTERNAL:
*/
public void setPreRemoveMethod(Method method) {
addEventMethod(PRE_REMOVE, method);
}
/**
* INTERNAL:
*/
public void setPreUpdateWithChangesMethod(Method method) {
addEventMethod(PRE_UPDATE_WITH_CHANGES, method);
}
/**
* INTERNAL:
*/
protected void validateMethod(Method method) {
int numberOfParameters = method.getParameterTypes().length;
if (numberOfParameters == 1 && method.getParameterTypes()[0].isAssignableFrom(m_entityClass)) {
// So far so good, now check the method modifiers.
validateMethodModifiers(method);
} else {
Class parameterClass = (numberOfParameters == 0) ? null : method.getParameterTypes()[0];
throw ValidationException.invalidEntityListenerCallbackMethodArguments(m_entityClass, parameterClass, m_listener.getClass(), method.getName());
}
}
/**
* INTERNAL:
*/
protected void validateMethodModifiers(Method method) {
int modifiers = method.getModifiers();
if (Modifier.isStatic(modifiers) || Modifier.isFinal(modifiers)) {
throw ValidationException.invalidCallbackMethodModifier(getListenerClass(), method.getName());
}
}
}
|
