org.jgroups.conf.PropertyHelper Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
The newest version!
package org.jgroups.conf;
import org.jgroups.annotations.Property;
import org.jgroups.logging.Log;
import org.jgroups.logging.LogFactory;
import org.jgroups.stack.Configurator;
import org.jgroups.stack.Protocol;
import org.jgroups.util.StackType;
import org.jgroups.util.Util;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.Map;
import java.util.Objects;
/*
* A class of static methods for performing commonly used functions with @Property annotations.
*/
public final class PropertyHelper {
protected static final Log log=LogFactory.getLog(PropertyHelper.class);
private PropertyHelper() {
throw new InstantiationError("Must not instantiate this class");
}
public static String getPropertyName(Field field, Map props) throws IllegalArgumentException {
if(field == null) {
throw new IllegalArgumentException("Cannot get property name: field is null");
}
if(props == null) {
throw new IllegalArgumentException("Cannot get property name: properties map is null");
}
Property annotation=field.getAnnotation(Property.class);
if(annotation == null) {
throw new IllegalArgumentException("Cannot get property name for field " +
field.getName() + " which is not annotated with @Property");
}
String propertyName=field.getName();
if(props.containsKey(annotation.name())) {
propertyName=annotation.name();
boolean isDeprecated=!annotation.deprecatedMessage().isEmpty();
if(isDeprecated)
log.warn(Util.getMessage("Deprecated"), propertyName, annotation.deprecatedMessage());
}
return propertyName;
}
public static String getPropertyName(Method method) throws IllegalArgumentException {
if(method == null) {
throw new IllegalArgumentException("Cannot get property name: field is null");
}
Property annotation=method.getAnnotation(Property.class);
if(annotation == null) {
throw new IllegalArgumentException("Cannot get property name for method " +
method.getName() + " which is not annotated with @Property");
}
String propertyName=!annotation.name().isEmpty()? annotation.name() : method.getName();
propertyName=Util.methodNameToAttributeName(propertyName);
return propertyName;
}
public static Object getConvertedValue(Object obj, Field field, Map props, String prop,
boolean check_scope, StackType ip_version) throws Exception {
Objects.requireNonNull(obj, "cannot get converted value: obj is null");
Objects.requireNonNull(field, "cannot get converted value: field is null");
Objects.requireNonNull(props, "cannot get converted value: props is null");
Property annotation=field.getAnnotation(Property.class);
if(annotation == null)
throw new IllegalArgumentException("Cannot get property name for field " +
field.getName() + " which is not annotated with @Property");
String propertyName=getPropertyName(field, props);
String name=obj instanceof Protocol? ((Protocol)obj).getName() : obj.getClass().getName();
PropertyConverter propertyConverter=annotation.converter().getDeclaredConstructor().newInstance();
if(propertyConverter == null)
throw new Exception("Could not find property converter for field " + propertyName + " in " + name);
Object converted=null;
try {
String tmp=obj instanceof Protocol? ((Protocol)obj).getName() + "." + propertyName : propertyName;
converted=propertyConverter.convert(obj, field.getType(), tmp, prop, check_scope, ip_version);
}
catch(Exception e) {
throw new Exception("Conversion of " + propertyName + " in " + name + " with property value " + prop + " failed", e);
}
return converted;
}
public static Object getConvertedValue(Object obj, Field field, String value, boolean check_scope, StackType ip_version) throws Exception {
Objects.requireNonNull(obj, "cannot get converted value: obj is null");
Objects.requireNonNull(field, "cannot get converted value: field is null");
String propName=field.getName();
Property annotation=field.getAnnotation(Property.class);
if(annotation == null)
throw new IllegalArgumentException("cannot get property name for " + propName + " (not annotated with @Property)");
String name=obj instanceof Protocol? ((Protocol)obj).getName() : obj.getClass().getName();
PropertyConverter propertyConverter=annotation.converter().getDeclaredConstructor().newInstance();
if(propertyConverter == null)
throw new Exception("Could not find property converter for field " + propName + " in " + name);
Object converted=null;
try {
String tmp=obj instanceof Protocol? ((Protocol)obj).getName() + "." + propName : propName;
converted=propertyConverter.convert(obj, field.getType(), tmp, value, check_scope, ip_version);
}
catch(Exception e) {
throw new Exception("Conversion of " + name + "." + " with original property value " + value + " failed", e);
}
return converted;
}
public static Object getConvertedValue(Object obj, Method method, Map props, String prop,
boolean check_scope, StackType ip_version) throws Exception {
if(obj == null)
throw new IllegalArgumentException("Cannot get converted value: Object is null");
if(method == null)
throw new IllegalArgumentException("Cannot get converted value: Method is null");
if(!Configurator.isSetPropertyMethod(method, obj.getClass()))
throw new IllegalArgumentException("Cannot get converted value: Method is not set property method");
if(props == null)
throw new IllegalArgumentException("Cannot get converted value: Properties is null");
Property annotation=method.getAnnotation(Property.class);
if(annotation == null)
throw new IllegalArgumentException("Cannot get property name for method " +
method.getName() + ": not annotated with @Property");
String propertyName=getPropertyName(method);
String name=obj instanceof Protocol? ((Protocol)obj).getName() : obj.getClass().getName();
PropertyConverter propertyConverter=annotation.converter().getDeclaredConstructor().newInstance();
if(propertyConverter == null)
throw new Exception("Could not find property converter for method " + propertyName + " in " + name);
Object converted=null;
try {
String tmp=obj instanceof Protocol? ((Protocol)obj).getName() + "." + propertyName : propertyName;
converted=propertyConverter.convert(obj, method.getParameterTypes()[0], tmp, prop, check_scope, ip_version);
}
catch(Exception e) {
throw new Exception("Conversion of " + propertyName + " in " + name +
" with original property value " + prop + " failed. Exception is " + e, e);
}
return converted;
}
public static boolean usesDefaultConverter(Field field) throws IllegalArgumentException {
if(field == null)
throw new IllegalArgumentException("Cannot check converter: field is null");
Property annotation=field.getAnnotation(Property.class);
if(annotation == null)
throw new IllegalArgumentException("field " + field.getName() + " is not annotated with @Property");
return annotation.converter().equals(PropertyConverters.Default.class);
}
}