/*
Milyn - Copyright (C) 2006
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License (version 2.1) as published by the Free Software
Foundation.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU Lesser General Public License for more details:
http://www.gnu.org/licenses/lgpl.txt
*/
package org.milyn.javabean;
import org.milyn.cdr.*;
import org.milyn.container.*;
import org.milyn.util.ClassUtil;
import java.util.*;
/**
* Java bean runtime info.
*
* @author <a href="mailto:tom.fennelly@gmail.com">tom.fennelly@gmail.com</a>
*/
public class BeanRuntimeInfo {
private static final String CONTEXT_KEY = BeanRuntimeInfo.class.getName() + "#CONTEXT_KEY";
/**
* The basic type that's created and populated for the associated bean.
*/
private Class<?> populateType;
/**
* The bean classification.
* <p/>
* We maintain this classification enum because it helps us avoid performing
* instanceof checks, which are cheap when the instance being checked is
* an instanceof, but is expensive if it's not.
*/
private Classification classification;
/**
* If the bean classification is an ARRAY_COLLECTION, this member specifies the
* actual array type.
*/
private Class<?> arrayType;
/**
* Bean type classification.
* <p/>
* We maintain this classification enum because it helps us avoid performing
* instanceof checks, which are cheap when the instance being checked is
* an instanceof, but expensive if it's not.
*/
public static enum Classification {
NON_COLLECTION,
ARRAY_COLLECTION,
COLLECTION_COLLECTION,
MAP_COLLECTION,
}
public BeanRuntimeInfo() {
}
public BeanRuntimeInfo(Class clazz) {
resolveBeanRuntimeInfo(clazz);
}
public BeanRuntimeInfo(String classname) {
resolveBeanRuntimeInfo(classname);
}
public static void recordBeanRuntimeInfo(String beanId, BeanRuntimeInfo beanRuntimeInfo, ApplicationContext appContext) {
Map<String, BeanRuntimeInfo> runtimeInfoMap = getRuntimeInfoMap(appContext);
BeanRuntimeInfo existingBeanConfig = runtimeInfoMap.get(beanId);
if(existingBeanConfig != null && !beanRuntimeInfo.equals(existingBeanConfig)) {
throw new SmooksConfigurationException("Multiple configurations present with beanId='" + beanId + "', but the bean runtime infos are not equal i.e bean classes etc are different. Use a different beanId and the 'setOnMethod' config if needed.");
}
runtimeInfoMap.put(beanId, beanRuntimeInfo);
}
public static BeanRuntimeInfo getBeanRuntimeInfo(String beanId, ApplicationContext appContext) {
Map<String, BeanRuntimeInfo> runtimeInfoMap = getRuntimeInfoMap(appContext);
return runtimeInfoMap.get(beanId);
}
public void setClassification(Class<?> clazz) {
// We maintain a targetType enum because it helps us avoid performing
// instanceof checks, which are cheap when the instance being checked is
// an instanceof, but is expensive if it's not....
if(Map.class.isAssignableFrom(clazz)) {
this.setClassification(Classification.MAP_COLLECTION);
} else if(Collection.class.isAssignableFrom(clazz)) {
this.setClassification(Classification.COLLECTION_COLLECTION);
} else {
this.setClassification(Classification.NON_COLLECTION);
}
}
public static BeanRuntimeInfo getBeanRuntimeInfo(String beanId, String beanClassName, ApplicationContext appContext) {
Map<String, BeanRuntimeInfo> runtimeInfoMap = getRuntimeInfoMap(appContext);
BeanRuntimeInfo beanRuntimeInfo = runtimeInfoMap.get(beanId);
if(beanRuntimeInfo == null) {
beanRuntimeInfo = new BeanRuntimeInfo(beanClassName);
recordBeanRuntimeInfo(beanId, beanRuntimeInfo, appContext);
}
return beanRuntimeInfo;
}
/**
* Resolve the Javabean runtime class.
* <p/>
* Also performs some checks on the bean.
*
* @param beanClass The beanClass name.
* @return The bean runtime class instance.
*/
private void resolveBeanRuntimeInfo(String beanClass) {
Class<?> clazz;
// If it's an array, we use a List and extract an array from it on the
// visitAfter event....
if(beanClass.endsWith("[]")) {
this.setClassification(BeanRuntimeInfo.Classification.ARRAY_COLLECTION);
String arrayTypeName = beanClass.substring(0, beanClass.length() - 2);
try {
this.setArrayType(ClassUtil.forName(arrayTypeName, getClass()));
} catch (ClassNotFoundException e) {
throw new SmooksConfigurationException("Invalid Smooks bean configuration. Bean class " + arrayTypeName + " not on classpath.");
}
this.setPopulateType(ArrayList.class);
} else {
try {
clazz = ClassUtil.forName(beanClass, getClass());
} catch (ClassNotFoundException e) {
throw new SmooksConfigurationException("Invalid Smooks bean configuration. Bean class " + beanClass + " not on classpath.");
}
this.setPopulateType(clazz);
this.setClassification(clazz);
// check for a default constructor.
try {
clazz.getConstructor();
} catch (NoSuchMethodException e) {
throw new SmooksConfigurationException("Invalid Smooks bean configuration. Bean class " + beanClass + " doesn't have a public default constructor.");
}
}
}
private void resolveBeanRuntimeInfo(Class clazz) {
// If it's an array, we use a List and extract an array from it on the
// visitAfter event....
if(clazz.isArray()) {
this.setClassification(BeanRuntimeInfo.Classification.ARRAY_COLLECTION);
this.setArrayType(clazz.getComponentType());
this.setPopulateType(ArrayList.class);
} else {
this.setPopulateType(clazz);
this.setClassification(clazz);
// check for a default constructor.
try {
clazz.getConstructor();
} catch (NoSuchMethodException e) {
throw new SmooksConfigurationException("Invalid Smooks bean configuration. Bean class " + clazz.getName() + " doesn't have a public default constructor.");
}
}
}
@SuppressWarnings("unchecked")
private static Map<String, BeanRuntimeInfo> getRuntimeInfoMap(ApplicationContext appContext) {
Map<String, BeanRuntimeInfo> runtimeInfoMap = (Map<String, BeanRuntimeInfo>) appContext.getAttribute(CONTEXT_KEY);
if(runtimeInfoMap == null) {
runtimeInfoMap = new HashMap<String, BeanRuntimeInfo>();
appContext.setAttribute(CONTEXT_KEY, runtimeInfoMap);
}
return runtimeInfoMap;
}
public Class<?> getPopulateType() {
return populateType;
}
public void setPopulateType(Class<?> populateType) {
this.populateType = populateType;
}
public Classification getClassification() {
return classification;
}
public void setClassification(Classification classification) {
this.classification = classification;
}
public Class<?> getArrayType() {
return arrayType;
}
public void setArrayType(Class<?> arrayType) {
this.arrayType = arrayType;
}
@Override
public boolean equals(Object obj) {
if(obj == null) {
return false;
}
if(obj == this) {
return true;
}
if(!(obj instanceof BeanRuntimeInfo)) {
return false;
}
BeanRuntimeInfo beanInfo = (BeanRuntimeInfo) obj;
if(beanInfo.getArrayType() != getArrayType()) {
return false;
}
if(beanInfo.getClassification() != getClassification()) {
return false;
}
if(beanInfo.getPopulateType() != getPopulateType()) {
return false;
}
return true;
}
public String toString() {
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append("Classification: " + classification);
stringBuilder.append(", Populate Type: : " + populateType.getName());
if(arrayType != null) {
stringBuilder.append(", Array Type: " + arrayType.getName());
}
return stringBuilder.toString();
}
}