VIVO-120 improve the error messages from OperationUtils.cloneBean()
Add unit tests for the method and restructure the logic so a failure to create the clone is treated as seriously as a failure to load it with values. Previously a failure to create resulted in a null return (with a log message) while a failure to load resulted in an exception (with a log message).
This commit is contained in:
j2blake
parent
9ec06f224e
commit
a19227188b
2 changed files with 574 additions and 137 deletions
|
|
@ -1,7 +1,7 @@
|
|||
/* $This file is distributed under the terms of the license in /doc/license.txt$ */
|
||||
|
||||
package edu.cornell.mannlib.vedit.util;
|
||||
|
||||
package edu.cornell.mannlib.vedit.util;
|
||||
|
||||
import java.lang.reflect.InvocationTargetException;
|
||||
import java.lang.reflect.Method;
|
||||
|
||||
|
|
@ -9,139 +9,145 @@ import org.apache.commons.logging.Log;
|
|||
import org.apache.commons.logging.LogFactory;
|
||||
|
||||
import edu.cornell.mannlib.vedit.beans.EditProcessObject;
|
||||
|
||||
|
||||
public class OperationUtils{
|
||||
|
||||
private static final Log log = LogFactory.getLog(OperationUtils.class.getName());
|
||||
|
||||
public static void beanSetAndValidate(Object newObj, String field, String value, EditProcessObject epo){
|
||||
Class cls = (epo.getBeanClass() != null) ? epo.getBeanClass() : newObj.getClass();
|
||||
Class[] paramList = new Class[1];
|
||||
paramList[0] = String.class;
|
||||
boolean isInt = false;
|
||||
boolean isBoolean = false;
|
||||
Method setterMethod = null;
|
||||
try {
|
||||
setterMethod = cls.getMethod("set"+field,paramList);
|
||||
} catch (NoSuchMethodException e) {
|
||||
//let's try int
|
||||
paramList[0] = int.class;
|
||||
try {
|
||||
setterMethod = cls.getMethod("set"+field,paramList);
|
||||
isInt = true;
|
||||
} catch (NoSuchMethodException f) {
|
||||
//let's try boolean
|
||||
paramList[0]=boolean.class;
|
||||
try {
|
||||
setterMethod = cls.getMethod("set"+field,paramList);
|
||||
isBoolean = true;
|
||||
log.debug("found boolean field "+field);
|
||||
} catch (NoSuchMethodException g) {
|
||||
log.error("beanSet could not find an appropriate String, int, or boolean setter method for "+field);
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
Object[] arglist = new Object[1];
|
||||
if (isInt)
|
||||
arglist[0] = Integer.decode(value);
|
||||
else if (isBoolean)
|
||||
arglist[0] = (value.equalsIgnoreCase("TRUE"));
|
||||
else
|
||||
arglist[0] = value;
|
||||
try {
|
||||
setterMethod.invoke(newObj,arglist);
|
||||
} catch (Exception e) {
|
||||
log.error("Couldn't invoke method");
|
||||
log.error(e.getMessage());
|
||||
log.error(field+" "+arglist[0]);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Takes a bean and clones it using reflection.
|
||||
* Any fields without standard getter/setter methods will not be copied.
|
||||
* @param bean
|
||||
* @return
|
||||
*/
|
||||
public static Object cloneBean (Object bean) {
|
||||
return cloneBean(bean, bean.getClass(), bean.getClass());
|
||||
}
|
||||
|
||||
/**
|
||||
* Takes a bean and clones it using reflection.
|
||||
* Any fields without standard getter/setter methods will not be copied.
|
||||
* @param bean
|
||||
* @return
|
||||
*/
|
||||
public static Object cloneBean (Object bean, Class beanClass, Class iface){
|
||||
Object newBean = null;
|
||||
try {
|
||||
newBean = beanClass.newInstance();
|
||||
Method[] beanMeths = iface.getMethods();
|
||||
for (int i=0; i<beanMeths.length ; ++i) {
|
||||
Method beanMeth = beanMeths[i];
|
||||
String methName = beanMeth.getName();
|
||||
if (methName.startsWith("get")
|
||||
&& beanMeth.getParameterTypes().length == 0 ) {
|
||||
String fieldName = methName.substring(3,methName.length());
|
||||
Class returnType = beanMeth.getReturnType();
|
||||
try {
|
||||
Class[] args = new Class[1];
|
||||
args[0] = returnType;
|
||||
Method setterMethod = iface.getMethod("set"+fieldName,args);
|
||||
try {
|
||||
Object fieldVal = beanMeth.invoke(bean,(Object[])null);
|
||||
try {
|
||||
Object[] setArgs = new Object[1];
|
||||
setArgs[0] = fieldVal;
|
||||
setterMethod.invoke(newBean,setArgs);
|
||||
} catch (IllegalAccessException iae) {
|
||||
log.error(OperationUtils.class.getName() +
|
||||
".cloneBean() " +
|
||||
" encountered IllegalAccessException " +
|
||||
" invoking " +
|
||||
setterMethod.getName(), iae);
|
||||
throw new RuntimeException(iae);
|
||||
} catch (InvocationTargetException ite) {
|
||||
log.error(OperationUtils.class.getName() +
|
||||
".cloneBean() " +
|
||||
" encountered InvocationTargetException"
|
||||
+ " invoking "
|
||||
+ setterMethod.getName(), ite);
|
||||
throw new RuntimeException(ite);
|
||||
}
|
||||
} catch (IllegalAccessException iae) {
|
||||
log.error(OperationUtils.class.getName() +
|
||||
".cloneBean() encountered " +
|
||||
" IllegalAccessException invoking " +
|
||||
beanMeths[i].getName(), iae);
|
||||
throw new RuntimeException(iae);
|
||||
} catch (InvocationTargetException ite) {
|
||||
log.error(OperationUtils.class.getName() +
|
||||
".cloneBean() encountered " +
|
||||
" InvocationTargetException invoking " +
|
||||
beanMeths[i].getName(), ite);
|
||||
throw new RuntimeException(ite);
|
||||
} catch (IllegalArgumentException iae) {
|
||||
log.error(OperationUtils.class.getName() +
|
||||
".cloneBean() encountered " +
|
||||
" IllegalArgumentException invoking " +
|
||||
beanMeths[i].getName(), iae);
|
||||
throw new RuntimeException(iae);
|
||||
}
|
||||
} catch (NoSuchMethodException nsme){
|
||||
// ignore this field because there is no setter method
|
||||
}
|
||||
}
|
||||
}
|
||||
} catch (InstantiationException ie){
|
||||
log.error("edu.cornell.mannlib.vitro.edit.utils.OperationUtils.cloneBean("+bean.getClass().toString()+") could not instantiate new instance of bean.", ie);
|
||||
} catch (IllegalAccessException iae){
|
||||
log.error("edu.cornell.mannlib.vitro.edit.utils.OperationUtils.cloneBean("+bean.getClass().toString()+") encountered illegal access exception instantiating new bean.", iae);
|
||||
}
|
||||
return newBean;
|
||||
}
|
||||
|
||||
|
||||
public class OperationUtils {
|
||||
|
||||
private static final Log log = LogFactory.getLog(OperationUtils.class
|
||||
.getName());
|
||||
|
||||
public static void beanSetAndValidate(Object newObj, String field,
|
||||
String value, EditProcessObject epo) {
|
||||
Class<?> cls = (epo.getBeanClass() != null) ? epo.getBeanClass() : newObj
|
||||
.getClass();
|
||||
Class<?>[] paramList = new Class[1];
|
||||
paramList[0] = String.class;
|
||||
boolean isInt = false;
|
||||
boolean isBoolean = false;
|
||||
Method setterMethod = null;
|
||||
try {
|
||||
setterMethod = cls.getMethod("set" + field, paramList);
|
||||
} catch (NoSuchMethodException e) {
|
||||
// let's try int
|
||||
paramList[0] = int.class;
|
||||
try {
|
||||
setterMethod = cls.getMethod("set" + field, paramList);
|
||||
isInt = true;
|
||||
} catch (NoSuchMethodException f) {
|
||||
// let's try boolean
|
||||
paramList[0] = boolean.class;
|
||||
try {
|
||||
setterMethod = cls.getMethod("set" + field, paramList);
|
||||
isBoolean = true;
|
||||
log.debug("found boolean field " + field);
|
||||
} catch (NoSuchMethodException g) {
|
||||
log.error("beanSet could not find an appropriate String, int, or boolean setter method for "
|
||||
+ field);
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
Object[] arglist = new Object[1];
|
||||
if (isInt)
|
||||
arglist[0] = Integer.decode(value);
|
||||
else if (isBoolean)
|
||||
arglist[0] = (value.equalsIgnoreCase("TRUE"));
|
||||
else
|
||||
arglist[0] = value;
|
||||
try {
|
||||
setterMethod.invoke(newObj, arglist);
|
||||
} catch (Exception e) {
|
||||
log.error("Couldn't invoke method");
|
||||
log.error(e.getMessage());
|
||||
log.error(field + " " + arglist[0]);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Takes a bean and clones it using reflection. Any fields without standard
|
||||
* getter/setter methods will not be copied.
|
||||
*/
|
||||
public static Object cloneBean(Object bean) {
|
||||
if (bean == null) {
|
||||
throw new NullPointerException("bean may not be null.");
|
||||
}
|
||||
return cloneBean(bean, bean.getClass(), bean.getClass());
|
||||
}
|
||||
|
||||
/**
|
||||
* Takes a bean and clones it using reflection. Any fields without standard
|
||||
* getter/setter methods will not be copied.
|
||||
*/
|
||||
public static Object cloneBean(final Object bean, final Class<?> beanClass,
|
||||
final Class<?> iface) {
|
||||
if (bean == null) {
|
||||
throw new NullPointerException("bean may not be null.");
|
||||
}
|
||||
if (beanClass == null) {
|
||||
throw new NullPointerException("beanClass may not be null.");
|
||||
}
|
||||
if (iface == null) {
|
||||
throw new NullPointerException("iface may not be null.");
|
||||
}
|
||||
|
||||
class CloneBeanException extends RuntimeException {
|
||||
public CloneBeanException(String message, Throwable cause) {
|
||||
super(message + " <" + cause.getClass().getSimpleName()
|
||||
+ ">: bean=" + bean + ", beanClass="
|
||||
+ beanClass.getName() + ", iface=" + iface.getName(),
|
||||
cause);
|
||||
}
|
||||
}
|
||||
|
||||
Object newBean;
|
||||
try {
|
||||
newBean = beanClass.getConstructor().newInstance();
|
||||
} catch (NoSuchMethodException e) {
|
||||
throw new CloneBeanException("bean has no 'nullary' constructor.", e);
|
||||
} catch (InstantiationException e) {
|
||||
throw new CloneBeanException("tried to create instance of an abstract class.", e);
|
||||
} catch (IllegalAccessException e) {
|
||||
throw new CloneBeanException("bean constructor is not accessible.", e);
|
||||
} catch (InvocationTargetException e) {
|
||||
throw new CloneBeanException("bean constructor threw an exception.", e);
|
||||
} catch (Exception e) {
|
||||
throw new CloneBeanException("failed to instantiate a new bean.", e);
|
||||
}
|
||||
|
||||
for (Method beanMeth : iface.getMethods()) {
|
||||
String methName = beanMeth.getName();
|
||||
if (!methName.startsWith("get")) {
|
||||
continue;
|
||||
}
|
||||
if (beanMeth.getParameterTypes().length != 0) {
|
||||
continue;
|
||||
}
|
||||
String fieldName = methName.substring(3, methName.length());
|
||||
Class<?> returnType = beanMeth.getReturnType();
|
||||
|
||||
Method setterMethod;
|
||||
try {
|
||||
setterMethod = iface.getMethod("set" + fieldName, returnType);
|
||||
} catch (NoSuchMethodException nsme) {
|
||||
continue;
|
||||
}
|
||||
|
||||
Object fieldVal;
|
||||
try {
|
||||
fieldVal = beanMeth.invoke(bean, (Object[]) null);
|
||||
} catch (Exception e) {
|
||||
throw new CloneBeanException("failed to invoke " + beanMeth, e);
|
||||
}
|
||||
|
||||
try {
|
||||
Object[] setArgs = new Object[1];
|
||||
setArgs[0] = fieldVal;
|
||||
setterMethod.invoke(newBean, setArgs);
|
||||
} catch (Exception e) {
|
||||
throw new CloneBeanException(
|
||||
"failed to invoke " + setterMethod, e);
|
||||
}
|
||||
}
|
||||
return newBean;
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue