package org.opendaylight.controller.cluster.datastore;
import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.primitives.Primitives;
import java.beans.BeanInfo;
import java.beans.MethodDescriptor;
import java.beans.PropertyDescriptor;
import java.lang.reflect.Constructor;
+import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
+import java.util.AbstractMap.SimpleImmutableEntry;
import java.util.ArrayList;
-import java.util.Collections;
-import java.util.Comparator;
-import java.util.Dictionary;
+import java.util.Collection;
import java.util.HashMap;
+import java.util.List;
import java.util.Map;
+import java.util.Map.Entry;
import java.util.Set;
+import javax.annotation.concurrent.GuardedBy;
import org.apache.commons.lang3.StringUtils;
-import org.apache.commons.lang3.text.WordUtils;
+import org.apache.commons.text.WordUtils;
import org.opendaylight.controller.cluster.datastore.DatastoreContext.Builder;
+import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
+import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.distributed.datastore.provider.rev140612.DataStoreProperties;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.distributed.datastore.provider.rev140612.DataStorePropertiesContainer;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class DatastoreContextIntrospector {
private static final Logger LOG = LoggerFactory.getLogger(DatastoreContextIntrospector.class);
- private static final Map<String, Class<?>> dataStorePropTypes = new HashMap<>();
+ private static final Map<String, Entry<Class<?>, Method>> DATA_STORE_PROP_INFO = new HashMap<>();
- private static final Map<Class<?>, Constructor<?>> constructors = new HashMap<>();
+ private static final Map<Class<?>, Constructor<?>> CONSTRUCTORS = new HashMap<>();
- private static final Map<Class<?>, Method> yangTypeGetters = new HashMap<>();
+ private static final Map<Class<?>, Method> YANG_TYPE_GETTERS = new HashMap<>();
- private static final Map<String, Method> builderSetters = new HashMap<>();
+ private static final Map<String, Method> BUILDER_SETTERS = new HashMap<>();
static {
try {
introspectDatastoreContextBuilder();
introspectDataStoreProperties();
introspectPrimitiveTypes();
- } catch (IntrospectionException e) {
+ } catch (final IntrospectionException e) {
LOG.error("Error initializing DatastoreContextIntrospector", e);
}
}
* constructor that takes a single String argument. For primitive wrappers, this constructor
* converts from a String representation.
*/
+ // Disables "Either log or rethrow this exception" sonar warning
+ @SuppressWarnings("squid:S1166")
private static void introspectPrimitiveTypes() {
-
- Set<Class<?>> primitives = ImmutableSet.<Class<?>>builder().addAll(
+ final Set<Class<?>> primitives = ImmutableSet.<Class<?>>builder().addAll(
Primitives.allWrapperTypes()).add(String.class).build();
- for(Class<?> primitive: primitives) {
+ for (final Class<?> primitive: primitives) {
try {
processPropertyType(primitive);
- } catch (Exception e) {
+ } catch (final NoSuchMethodException e) {
// Ignore primitives that can't be constructed from a String, eg Character and Void.
+ } catch (SecurityException | IntrospectionException e) {
+ LOG.error("Error introspect primitive type {}", primitive, e);
}
}
}
* the methods that return Builder.
*/
private static void introspectDatastoreContextBuilder() {
- for(Method method: Builder.class.getMethods()) {
- if(Builder.class.equals(method.getReturnType())) {
- builderSetters.put(method.getName(), method);
+ for (final Method method: Builder.class.getMethods()) {
+ if (Builder.class.equals(method.getReturnType())) {
+ BUILDER_SETTERS.put(method.getName(), method);
}
}
}
* the appropriate constructor that we will use.
*/
private static void introspectDataStoreProperties() throws IntrospectionException {
- BeanInfo beanInfo = Introspector.getBeanInfo(DataStoreProperties.class);
- for(PropertyDescriptor desc: beanInfo.getPropertyDescriptors()) {
- processDataStoreProperty(desc.getName(), desc.getPropertyType());
+ final BeanInfo beanInfo = Introspector.getBeanInfo(DataStoreProperties.class);
+ for (final PropertyDescriptor desc: beanInfo.getPropertyDescriptors()) {
+ processDataStoreProperty(desc.getName(), desc.getPropertyType(), desc.getReadMethod());
}
// Getter methods that return Boolean and start with "is" instead of "get" aren't recognized as
// properties and thus aren't returned from getPropertyDescriptors. A getter starting with
// "is" is only supported if it returns primitive boolean. So we'll check for these via
// getMethodDescriptors.
- for(MethodDescriptor desc: beanInfo.getMethodDescriptors()) {
- String methodName = desc.getName();
- if(Boolean.class.equals(desc.getMethod().getReturnType()) && methodName.startsWith("is")) {
- String propertyName = WordUtils.uncapitalize(methodName.substring(2));
- processDataStoreProperty(propertyName, Boolean.class);
+ for (final MethodDescriptor desc: beanInfo.getMethodDescriptors()) {
+ final String methodName = desc.getName();
+ if (Boolean.class.equals(desc.getMethod().getReturnType()) && methodName.startsWith("is")) {
+ final String propertyName = WordUtils.uncapitalize(methodName.substring(2));
+ processDataStoreProperty(propertyName, Boolean.class, desc.getMethod());
}
}
}
/**
* Processes a property defined on the DataStoreProperties interface.
*/
- private static void processDataStoreProperty(String name, Class<?> propertyType) {
- Preconditions.checkArgument(builderSetters.containsKey(name), String.format(
- "DataStoreProperties property \"%s\" does not have corresponding setter in DatastoreContext.Builder", name));
+ @SuppressWarnings("checkstyle:IllegalCatch")
+ private static void processDataStoreProperty(final String name, final Class<?> propertyType, Method readMethod) {
+ Preconditions.checkArgument(BUILDER_SETTERS.containsKey(name), String.format(
+ "DataStoreProperties property \"%s\" does not have corresponding setter in DatastoreContext.Builder",
+ name));
try {
processPropertyType(propertyType);
- dataStorePropTypes.put(name, propertyType);
- } catch (Exception e) {
+ DATA_STORE_PROP_INFO.put(name, new SimpleImmutableEntry<>(propertyType, readMethod));
+ } catch (final Exception e) {
LOG.error("Error finding constructor for type {}", propertyType, e);
}
}
* Finds the appropriate constructor for the specified type that we will use to construct
* instances.
*/
- private static void processPropertyType(Class<?> propertyType) throws Exception {
- Class<?> wrappedType = Primitives.wrap(propertyType);
- if(constructors.containsKey(wrappedType)) {
+ private static void processPropertyType(final Class<?> propertyType)
+ throws NoSuchMethodException, SecurityException, IntrospectionException {
+ final Class<?> wrappedType = Primitives.wrap(propertyType);
+ if (CONSTRUCTORS.containsKey(wrappedType)) {
return;
}
// If the type is a primitive (or String type), we look for the constructor that takes a
// single String argument, which, for primitives, validates and converts from a String
// representation which is the form we get on ingress.
- if(propertyType.isPrimitive() || Primitives.isWrapperType(propertyType) ||
- propertyType.equals(String.class))
- {
- constructors.put(wrappedType, propertyType.getConstructor(String.class));
+ if (propertyType.isPrimitive() || Primitives.isWrapperType(propertyType) || propertyType.equals(String.class)) {
+ CONSTRUCTORS.put(wrappedType, propertyType.getConstructor(String.class));
} else {
// This must be a yang-defined type. We need to find the constructor that takes a
// primitive as the only argument. This will be used to construct instances to perform
// validation (eg range checking). The yang-generated types have a couple single-argument
// constructors but the one we want has the bean ConstructorProperties annotation.
- for(Constructor<?> ctor: propertyType.getConstructors()) {
- ConstructorProperties ctorPropsAnnotation = ctor.getAnnotation(ConstructorProperties.class);
- if(ctor.getParameterTypes().length == 1 && ctorPropsAnnotation != null) {
+ for (final Constructor<?> ctor: propertyType.getConstructors()) {
+ final ConstructorProperties ctorPropsAnnotation = ctor.getAnnotation(ConstructorProperties.class);
+ if (ctor.getParameterTypes().length == 1 && ctorPropsAnnotation != null) {
findYangTypeGetter(propertyType, ctorPropsAnnotation.value()[0]);
- constructors.put(propertyType, ctor);
+ CONSTRUCTORS.put(propertyType, ctor);
break;
}
}
/**
* Finds the getter method on a yang-generated type for the specified property name.
*/
- private static void findYangTypeGetter(Class<?> type, String propertyName)
- throws Exception {
- for(PropertyDescriptor desc: Introspector.getBeanInfo(type).getPropertyDescriptors()) {
- if(desc.getName().equals(propertyName)) {
- yangTypeGetters.put(type, desc.getReadMethod());
+ private static void findYangTypeGetter(final Class<?> type, final String propertyName)
+ throws IntrospectionException {
+ for (final PropertyDescriptor desc: Introspector.getBeanInfo(type).getPropertyDescriptors()) {
+ if (desc.getName().equals(propertyName)) {
+ YANG_TYPE_GETTERS.put(type, desc.getReadMethod());
return;
}
}
- throw new IllegalArgumentException(String.format(
+ throw new IntrospectionException(String.format(
"Getter method for constructor property %s not found for YANG type %s",
propertyName, type));
}
+ @GuardedBy(value = "this")
private DatastoreContext context;
+ @GuardedBy(value = "this")
+ private Map<String, Object> currentProperties;
+
+ public DatastoreContextIntrospector(final DatastoreContext context,
+ final BindingNormalizedNodeSerializer bindingSerializer) {
+ final QName qname = BindingReflections.findQName(DataStorePropertiesContainer.class);
+ final DataStorePropertiesContainer defaultPropsContainer = (DataStorePropertiesContainer)
+ bindingSerializer.fromNormalizedNode(bindingSerializer.toYangInstanceIdentifier(
+ InstanceIdentifier.builder(DataStorePropertiesContainer.class).build()),
+ ImmutableNodes.containerNode(qname)).getValue();
+
+ final Builder builder = DatastoreContext.newBuilderFrom(context);
+ for (Entry<String, Entry<Class<?>, Method>> entry: DATA_STORE_PROP_INFO.entrySet()) {
+ Object value;
+ try {
+ value = entry.getValue().getValue().invoke(defaultPropsContainer);
+ } catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
+ LOG.error("Error obtaining default value for property {}", entry.getKey(), e);
+ value = null;
+ }
+
+ if (value != null) {
+ convertValueAndInvokeSetter(entry.getKey(), value, builder);
+ }
+ }
- public DatastoreContextIntrospector(DatastoreContext context) {
- this.context = context;
+ this.context = builder.build();
}
- public DatastoreContext getContext() {
+ public synchronized DatastoreContext getContext() {
return context;
}
+ public DatastoreContextFactory newContextFactory() {
+ return new DatastoreContextFactory(this);
+ }
+
+ public synchronized DatastoreContext getShardDatastoreContext(final String forShardName) {
+ if (currentProperties == null) {
+ return context;
+ }
+
+ final Builder builder = DatastoreContext.newBuilderFrom(context);
+ final String dataStoreTypePrefix = context.getDataStoreName() + '.';
+ final String shardNamePrefix = forShardName + '.';
+
+ final List<String> keys = getSortedKeysByDatastoreType(currentProperties.keySet(), dataStoreTypePrefix);
+
+ for (String key: keys) {
+ final Object value = currentProperties.get(key);
+ if (key.startsWith(dataStoreTypePrefix)) {
+ key = key.replaceFirst(dataStoreTypePrefix, "");
+ }
+
+ if (key.startsWith(shardNamePrefix)) {
+ key = key.replaceFirst(shardNamePrefix, "");
+ convertValueAndInvokeSetter(key, value.toString(), builder);
+ }
+ }
+
+ return builder.build();
+ }
+
/**
* Applies the given properties to the cached DatastoreContext and yields a new DatastoreContext
- * instance which can be obtained via {@link getContext}.
+ * instance which can be obtained via {@link #getContext()}.
*
* @param properties the properties to apply
* @return true if the cached DatastoreContext was updated, false otherwise.
*/
- public boolean update(Dictionary<String, Object> properties) {
- if(properties == null || properties.isEmpty()) {
+ public synchronized boolean update(final Map<String, Object> properties) {
+ currentProperties = null;
+ if (properties == null || properties.isEmpty()) {
return false;
}
- Builder builder = DatastoreContext.newBuilderFrom(context);
-
- final String dataStoreTypePrefix = context.getDataStoreType() + '.';
+ LOG.debug("In update: properties: {}", properties);
- // Sort the property keys by putting the names prefixed with the data store type last. This
- // is done so data store specific settings are applied after global settings.
- ArrayList<String> keys = Collections.list(properties.keys());
- Collections.sort(keys, new Comparator<String>() {
- @Override
- public int compare(String key1, String key2) {
- return key1.startsWith(dataStoreTypePrefix) ? 1 :
- key2.startsWith(dataStoreTypePrefix) ? -1 : key1.compareTo(key2);
- }
- });
+ final ImmutableMap.Builder<String, Object> mapBuilder = ImmutableMap.<String, Object>builder();
- boolean updated = false;
- for(String key: keys) {
- Object value = properties.get(key);
- try {
- // If the key is prefixed with the data store type, strip it off.
- if(key.startsWith(dataStoreTypePrefix)) {
- key = key.replaceFirst(dataStoreTypePrefix, "");
- }
+ final Builder builder = DatastoreContext.newBuilderFrom(context);
- key = convertToCamelCase(key);
+ final String dataStoreTypePrefix = context.getDataStoreName() + '.';
- // Convert the value to the right type.
- value = convertValue(key, value);
- if(value == null) {
- continue;
- }
+ final List<String> keys = getSortedKeysByDatastoreType(properties.keySet(), dataStoreTypePrefix);
- LOG.debug("Converted value for property {}: {} ({})",
- key, value, value.getClass().getSimpleName());
+ boolean updated = false;
+ for (String key: keys) {
+ final Object value = properties.get(key);
+ mapBuilder.put(key, value);
- // Call the setter method on the Builder instance.
- Method setter = builderSetters.get(key);
- setter.invoke(builder, constructorValueRecursively(
- Primitives.wrap(setter.getParameterTypes()[0]), value.toString()));
+ // If the key is prefixed with the data store type, strip it off.
+ if (key.startsWith(dataStoreTypePrefix)) {
+ key = key.replaceFirst(dataStoreTypePrefix, "");
+ }
+ if (convertValueAndInvokeSetter(key, value.toString(), builder)) {
updated = true;
-
- } catch (Exception e) {
- LOG.error("Error converting value ({}) for property {}", value, key, e);
}
}
- if(updated) {
+ currentProperties = mapBuilder.build();
+
+ if (updated) {
context = builder.build();
}
return updated;
}
- private String convertToCamelCase(String inString) {
+ private static ArrayList<String> getSortedKeysByDatastoreType(final Collection<String> inKeys,
+ final String dataStoreTypePrefix) {
+ // Sort the property keys by putting the names prefixed with the data store type last. This
+ // is done so data store specific settings are applied after global settings.
+ final ArrayList<String> keys = new ArrayList<>(inKeys);
+ keys.sort((key1, key2) -> key1.startsWith(dataStoreTypePrefix) ? 1 :
+ key2.startsWith(dataStoreTypePrefix) ? -1 : key1.compareTo(key2));
+ return keys;
+ }
+
+ @SuppressWarnings("checkstyle:IllegalCatch")
+ private boolean convertValueAndInvokeSetter(final String inKey, final Object inValue, final Builder builder) {
+ final String key = convertToCamelCase(inKey);
+
+ try {
+ // Convert the value to the right type.
+ final Object value = convertValue(key, inValue);
+ if (value == null) {
+ return false;
+ }
+
+ LOG.debug("Converted value for property {}: {} ({})",
+ key, value, value.getClass().getSimpleName());
+
+ // Call the setter method on the Builder instance.
+ final Method setter = BUILDER_SETTERS.get(key);
+ setter.invoke(builder, constructorValueRecursively(
+ Primitives.wrap(setter.getParameterTypes()[0]), value.toString()));
+
+ return true;
+ } catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException
+ | InstantiationException e) {
+ LOG.error("Error converting value ({}) for property {}", inValue, key, e);
+ }
+
+ return false;
+ }
+
+ private static String convertToCamelCase(final String inString) {
String str = inString.trim();
- if(StringUtils.contains(str, '-') || StringUtils.contains(str, ' ')) {
+ if (StringUtils.contains(str, '-') || StringUtils.contains(str, ' ')) {
str = inString.replace('-', ' ');
str = WordUtils.capitalizeFully(str);
str = StringUtils.deleteWhitespace(str);
return StringUtils.uncapitalize(str);
}
- private Object convertValue(String name, Object from) throws Exception {
- Class<?> propertyType = dataStorePropTypes.get(name);
- if(propertyType == null) {
+ private Object convertValue(final String name, final Object from)
+ throws InstantiationException, IllegalAccessException, IllegalArgumentException, InvocationTargetException {
+ final Entry<Class<?>, Method> propertyInfo = DATA_STORE_PROP_INFO.get(name);
+ if (propertyInfo == null) {
LOG.debug("Property not found for {}", name);
return null;
}
+ final Class<?> propertyType = propertyInfo.getKey();
+
LOG.debug("Type for property {}: {}, converting value {} ({})",
name, propertyType.getSimpleName(), from, from.getClass().getSimpleName());
// Recurse the chain of constructors depth-first to get the resulting value. Eg, if the
// property type is the yang-generated NonZeroUint32Type, it's constructor takes a Long so
// we have to first construct a Long instance from the input value.
- Object converted = constructorValueRecursively(propertyType, from.toString());
+ Object converted = constructorValueRecursively(propertyType, from);
// If the converted type is a yang-generated type, call the getter to obtain the actual value.
- Method getter = yangTypeGetters.get(converted.getClass());
- if(getter != null) {
+ final Method getter = YANG_TYPE_GETTERS.get(converted.getClass());
+ if (getter != null) {
converted = getter.invoke(converted);
}
return converted;
}
- private Object constructorValueRecursively(Class<?> toType, Object fromValue) throws Exception {
- LOG.debug("convertValueRecursively - toType: {}, fromValue {} ({})",
+ private Object constructorValueRecursively(final Class<?> toType, final Object fromValue)
+ throws InstantiationException, IllegalAccessException, IllegalArgumentException, InvocationTargetException {
+ LOG.trace("convertValueRecursively - toType: {}, fromValue {} ({})",
toType.getSimpleName(), fromValue, fromValue.getClass().getSimpleName());
- Constructor<?> ctor = constructors.get(toType);
+ if (toType.equals(fromValue.getClass())) {
+ return fromValue;
+ }
+
+ final Constructor<?> ctor = CONSTRUCTORS.get(toType);
- LOG.debug("Found {}", ctor);
+ LOG.trace("Found {}", ctor);
- if(ctor == null) {
+ if (ctor == null) {
throw new IllegalArgumentException(String.format("Constructor not found for type %s", toType));
}
Object value = fromValue;
- // Since the original input type is a String, once we find a constructor that takes a String
- // argument, we're done recursing.
- if(!ctor.getParameterTypes()[0].equals(String.class)) {
+ // Once we find a constructor that takes the original type as an argument, we're done recursing.
+ if (!ctor.getParameterTypes()[0].equals(fromValue.getClass())) {
value = constructorValueRecursively(ctor.getParameterTypes()[0], fromValue);
}
Code Review / controller.git / blobdiff