X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-distributed-datastore%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2FDatastoreContextIntrospector.java;h=a6f5f019307097835d3bc699ccb723da737d0e97;hp=3ca64210bea11986689765fdeee5936f2ba99bc3;hb=b65e66f7b1bafb0d0c5fbe1c569835eb890f672a;hpb=3927509ec3ecfa32a51b725d2b7155d425f5b877 diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/DatastoreContextIntrospector.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/DatastoreContextIntrospector.java index 3ca64210be..a6f5f01930 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/DatastoreContextIntrospector.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/DatastoreContextIntrospector.java @@ -7,7 +7,9 @@ */ package org.opendaylight.controller.cluster.datastore; -import com.google.common.base.Preconditions; +import static com.google.common.base.Preconditions.checkArgument; + +import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableSet; import com.google.common.primitives.Primitives; import java.beans.BeanInfo; @@ -17,18 +19,27 @@ import java.beans.Introspector; 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 java.util.function.Function; import org.apache.commons.lang3.StringUtils; -import org.apache.commons.lang3.text.WordUtils; +import org.apache.commons.text.WordUtils; +import org.checkerframework.checker.lock.qual.GuardedBy; import org.opendaylight.controller.cluster.datastore.DatastoreContext.Builder; 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.common.Uint16; +import org.opendaylight.yangtools.yang.common.Uint32; +import org.opendaylight.yangtools.yang.common.Uint64; +import org.opendaylight.yangtools.yang.common.Uint8; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -40,20 +51,28 @@ import org.slf4j.LoggerFactory; public class DatastoreContextIntrospector { private static final Logger LOG = LoggerFactory.getLogger(DatastoreContextIntrospector.class); - private static final Map> dataStorePropTypes = new HashMap<>(); + private static final Map, Method>> DATA_STORE_PROP_INFO = new HashMap<>(); + + private static final Map, Constructor> CONSTRUCTORS = new HashMap<>(); - private static final Map, Constructor> constructors = new HashMap<>(); + private static final Map, Method> YANG_TYPE_GETTERS = new HashMap<>(); - private static final Map, Method> yangTypeGetters = new HashMap<>(); + private static final Map BUILDER_SETTERS = new HashMap<>(); - private static final Map builderSetters = new HashMap<>(); + private static final ImmutableMap, Function> UINT_FACTORIES = + ImmutableMap., Function>builder() + .put(Uint8.class, Uint8::valueOf) + .put(Uint16.class, Uint16::valueOf) + .put(Uint32.class, Uint32::valueOf) + .put(Uint64.class, Uint64::valueOf) + .build(); static { try { introspectDatastoreContextBuilder(); introspectDataStoreProperties(); introspectPrimitiveTypes(); - } catch (IntrospectionException e) { + } catch (final IntrospectionException e) { LOG.error("Error initializing DatastoreContextIntrospector", e); } } @@ -63,15 +82,18 @@ public class DatastoreContextIntrospector { * 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> primitives = ImmutableSet.>builder().addAll( + final Set> primitives = ImmutableSet.>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); } } } @@ -83,9 +105,9 @@ public class DatastoreContextIntrospector { * 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); } } } @@ -97,20 +119,20 @@ public class DatastoreContextIntrospector { * 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()); } } } @@ -118,13 +140,16 @@ public class DatastoreContextIntrospector { /** * 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, + final Method readMethod) { + checkArgument(BUILDER_SETTERS.containsKey(name), + "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); } } @@ -133,29 +158,28 @@ public class DatastoreContextIntrospector { * 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.getParameterCount() == 1 && ctorPropsAnnotation != null) { findYangTypeGetter(propertyType, ctorPropsAnnotation.value()[0]); - constructors.put(propertyType, ctor); + CONSTRUCTORS.put(propertyType, ctor); break; } } @@ -165,99 +189,168 @@ public class DatastoreContextIntrospector { /** * 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 currentProperties; + + public DatastoreContextIntrospector(final DatastoreContext context, + final DataStorePropertiesContainer defaultPropsContainer) { + + final Builder builder = DatastoreContext.newBuilderFrom(context); + for (Entry, 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; + } - public DatastoreContextIntrospector(DatastoreContext context) { - this.context = context; + if (value != null) { + convertValueAndInvokeSetter(entry.getKey(), value, builder); + } + } + + 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 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 properties) { - if(properties == null || properties.isEmpty()) { + public synchronized boolean update(final Map properties) { + currentProperties = null; + if (properties == null || properties.isEmpty()) { return false; } - Builder builder = DatastoreContext.newBuilderFrom(context); + LOG.debug("In update: properties: {}", properties); - final String dataStoreTypePrefix = context.getDataStoreType() + '.'; + final ImmutableMap.Builder mapBuilder = ImmutableMap.builder(); - // 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 keys = Collections.list(properties.keys()); - Collections.sort(keys, new Comparator() { - @Override - public int compare(String key1, String key2) { - return key1.startsWith(dataStoreTypePrefix) ? 1 : - key2.startsWith(dataStoreTypePrefix) ? -1 : key1.compareTo(key2); - } - }); + final Builder builder = DatastoreContext.newBuilderFrom(context); - 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 String dataStoreTypePrefix = context.getDataStoreName() + '.'; - key = convertToCamelCase(key); - - // Convert the value to the right type. - value = convertValue(key, value); - if(value == null) { - continue; - } + final List 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 getSortedKeysByDatastoreType(final Collection 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 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); @@ -266,47 +359,59 @@ public class DatastoreContextIntrospector { 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, 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; + } - LOG.debug("Found {}", ctor); + final Constructor ctor = CONSTRUCTORS.get(toType); + if (ctor == null) { + if (fromValue instanceof String) { + final Function factory = UINT_FACTORIES.get(toType); + if (factory != null) { + return factory.apply((String) fromValue); + } + } - if(ctor == null) { throw new IllegalArgumentException(String.format("Constructor not found for type %s", toType)); } + LOG.trace("Found {}", ctor); 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); }