From c70fcc07dd643654f8c436c5ea4ff8d81bf51603 Mon Sep 17 00:00:00 2001 From: Jan Srnicek Date: Thu, 24 Nov 2016 08:47:31 +0100 Subject: HONEYCOMB-289 - Type-aware support for DumpCacheManager Standard cache key factory made type-aware Added checking for type of returned data from cache Change-Id: Ie4d31a9d2b0d25c4b2f4ea66be98060f449007b6 Signed-off-by: Jan Srnicek --- .../translate/util/read/cache/CacheKeyFactory.java | 7 ++ .../util/read/cache/DumpCacheManager.java | 40 +++++-- .../util/read/cache/IdentifierCacheKeyFactory.java | 122 ------------------- .../cache/TypeAwareIdentifierCacheKeyFactory.java | 132 +++++++++++++++++++++ 4 files changed, 172 insertions(+), 129 deletions(-) delete mode 100644 infra/translate-utils/src/main/java/io/fd/honeycomb/translate/util/read/cache/IdentifierCacheKeyFactory.java create mode 100644 infra/translate-utils/src/main/java/io/fd/honeycomb/translate/util/read/cache/TypeAwareIdentifierCacheKeyFactory.java (limited to 'infra/translate-utils/src/main') diff --git a/infra/translate-utils/src/main/java/io/fd/honeycomb/translate/util/read/cache/CacheKeyFactory.java b/infra/translate-utils/src/main/java/io/fd/honeycomb/translate/util/read/cache/CacheKeyFactory.java index 1b444ba3c..bf4659e89 100644 --- a/infra/translate-utils/src/main/java/io/fd/honeycomb/translate/util/read/cache/CacheKeyFactory.java +++ b/infra/translate-utils/src/main/java/io/fd/honeycomb/translate/util/read/cache/CacheKeyFactory.java @@ -27,5 +27,12 @@ public interface CacheKeyFactory { /** * Construct key accordingly to provided {@code InstanceIdentifier} */ + @Nonnull String createKey(@Nonnull final InstanceIdentifier actualContextIdentifier); + + /** + * Returns type of data, for which is this factory creating keys + */ + @Nonnull + Class getCachedDataType(); } diff --git a/infra/translate-utils/src/main/java/io/fd/honeycomb/translate/util/read/cache/DumpCacheManager.java b/infra/translate-utils/src/main/java/io/fd/honeycomb/translate/util/read/cache/DumpCacheManager.java index f1b265dec..adcd32e0c 100644 --- a/infra/translate-utils/src/main/java/io/fd/honeycomb/translate/util/read/cache/DumpCacheManager.java +++ b/infra/translate-utils/src/main/java/io/fd/honeycomb/translate/util/read/cache/DumpCacheManager.java @@ -17,6 +17,8 @@ package io.fd.honeycomb.translate.util.read.cache; import static com.google.common.base.Preconditions.checkNotNull; +import static com.google.common.base.Preconditions.checkState; +import static java.util.Objects.nonNull; import com.google.common.base.Optional; import io.fd.honeycomb.translate.ModificationCache; @@ -41,11 +43,13 @@ public final class DumpCacheManager { private final EntityDumpExecutor dumpExecutor; private final EntityDumpPostProcessingFunction postProcessor; private final CacheKeyFactory cacheKeyFactory; + private final Class acceptOnly; private DumpCacheManager(DumpCacheManagerBuilder builder) { this.dumpExecutor = builder.dumpExecutor; this.postProcessor = builder.postProcessingFunction; this.cacheKeyFactory = builder.cacheKeyFactory; + this.acceptOnly = builder.acceptOnly; } /** @@ -79,6 +83,12 @@ public final class DumpCacheManager { cache.put(entityKey, dump); return Optional.of(dump); } else { + // if specified, check whether data returned from cache can be used as result of this dump manager + // used as a secondary check if cache does not have any data of different type stored under the same key + checkState(acceptOnly.isInstance(dump), + "This dump manager accepts only %s as data, but %s was returned from cache", + acceptOnly, dump.getClass()); + LOG.debug("Cached instance of dump was found for KEY[{}]", entityKey); return Optional.of(dump); } @@ -86,18 +96,14 @@ public final class DumpCacheManager { public static final class DumpCacheManagerBuilder { - private static final CacheKeyFactory DEFAULT_CACHE_KEY_FACTORY_INSTANCE = new IdentifierCacheKeyFactory(); - private EntityDumpExecutor dumpExecutor; private EntityDumpPostProcessingFunction postProcessingFunction; private CacheKeyFactory cacheKeyFactory; + private Class acceptOnly; public DumpCacheManagerBuilder() { // for cases when user does not set specific post-processor postProcessingFunction = new NoopDumpPostProcessingFunction(); - - //use no additional scopes version by default - cacheKeyFactory = DEFAULT_CACHE_KEY_FACTORY_INSTANCE; } public DumpCacheManagerBuilder withExecutor(@Nonnull final EntityDumpExecutor executor) { @@ -111,17 +117,37 @@ public final class DumpCacheManager { return this; } + /** + * Key providing unique(type-aware) keys. + */ public DumpCacheManagerBuilder withCacheKeyFactory(@Nonnull final CacheKeyFactory cacheKeyFactory) { this.cacheKeyFactory = cacheKeyFactory; return this; } + /** + * If modification returns object of different type that this, throw exception to prevent processing data + * of different type. + */ + public DumpCacheManagerBuilder acceptOnly(@Nonnull final Class acceptOnly) { + this.acceptOnly = acceptOnly; + return this; + } + public DumpCacheManager build() { checkNotNull(dumpExecutor, "Dump executor cannot be null"); checkNotNull(postProcessingFunction, "Dump post-processor cannot be null cannot be null, default implementation is used when not set explicitly"); - checkNotNull(cacheKeyFactory, - "Cache key factory cannot be null, default non-extended implementation is used when not set explicitly"); + + if (acceptOnly != null) { + cacheKeyFactory = new TypeAwareIdentifierCacheKeyFactory(acceptOnly); + } else if (cacheKeyFactory != null) { + acceptOnly = cacheKeyFactory.getCachedDataType(); + } else { + throw new IllegalStateException( + "Invalid combination - either acceptOnly type must be defined[defined=" + nonNull(acceptOnly) + + "], or type-aware cache key factory[defined=" + nonNull(cacheKeyFactory) + "]"); + } return new DumpCacheManager<>(this); } diff --git a/infra/translate-utils/src/main/java/io/fd/honeycomb/translate/util/read/cache/IdentifierCacheKeyFactory.java b/infra/translate-utils/src/main/java/io/fd/honeycomb/translate/util/read/cache/IdentifierCacheKeyFactory.java deleted file mode 100644 index 51f47e137..000000000 --- a/infra/translate-utils/src/main/java/io/fd/honeycomb/translate/util/read/cache/IdentifierCacheKeyFactory.java +++ /dev/null @@ -1,122 +0,0 @@ -/* - * Copyright (c) 2016 Cisco and/or its affiliates. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package io.fd.honeycomb.translate.util.read.cache; - -import static com.google.common.base.Preconditions.checkArgument; -import static com.google.common.base.Preconditions.checkNotNull; -import static org.opendaylight.yangtools.yang.binding.InstanceIdentifier.IdentifiableItem; - -import java.util.Collections; -import java.util.Set; -import java.util.stream.Collectors; -import java.util.stream.StreamSupport; -import javax.annotation.Nonnull; -import org.opendaylight.yangtools.yang.binding.DataObject; -import org.opendaylight.yangtools.yang.binding.Identifiable; -import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; - -/** - * Factory providing cache keys to easier switching between scopes of caching - */ -public final class IdentifierCacheKeyFactory implements CacheKeyFactory { - - private static final String KEY_PARTS_SEPARATOR = "|"; - - // should be Set>>, but that's not possible for wildcards - private final Set> additionalKeyTypes; - - /** - * Construct simple cache key factory - */ - public IdentifierCacheKeyFactory() { - this(Collections.emptySet()); - } - - /** - * @param additionalKeyTypes Additional types from path of cached type, that are specifying scope - */ - public IdentifierCacheKeyFactory(@Nonnull final Set> additionalKeyTypes) { - // verify that all are non-null and identifiable - this.additionalKeyTypes = checkNotNull(additionalKeyTypes, "Additional key types can't be null").stream() - .map(IdentifierCacheKeyFactory::verifyNotNull) - .map(IdentifierCacheKeyFactory::verifyIsIdentifiable) - .collect(Collectors.toSet()); - } - - @Override - public String createKey(@Nonnull final InstanceIdentifier actualContextIdentifier) { - - checkNotNull(actualContextIdentifier, "Cannot construct key for null InstanceIdentifier"); - - // easiest case when only simple key is needed - if (additionalKeyTypes.isEmpty()) { - return actualContextIdentifier.getTargetType().toString(); - } - - checkArgument(isUniqueKeyConstructable(actualContextIdentifier), - "Unable to construct unique key, required key types : %s, provided paths : %s", additionalKeyTypes, - actualContextIdentifier.getPathArguments()); - - return String - .join(KEY_PARTS_SEPARATOR, additionalKeys(actualContextIdentifier), - actualContextIdentifier.getTargetType().toString()); - } - - /** - * Verifies that all requested key parts have keys - */ - private boolean isUniqueKeyConstructable(final InstanceIdentifier actualContextIdentifier) { - return StreamSupport.stream(actualContextIdentifier.getPathArguments().spliterator(), false) - .filter(this::isAdditionalScope) - .filter(this::isIdentifiable) - .count() == additionalKeyTypes.size(); - } - - private boolean isAdditionalScope(final InstanceIdentifier.PathArgument pathArgument) { - return additionalKeyTypes.contains(pathArgument.getType()); - } - - private boolean isIdentifiable(final InstanceIdentifier.PathArgument pathArgument) { - return pathArgument instanceof IdentifiableItem; - } - - - private String additionalKeys(final InstanceIdentifier actualContextIdentifier) { - return StreamSupport.stream(actualContextIdentifier.getPathArguments().spliterator(), false) - .filter(this::isAdditionalScope) - .filter(this::isIdentifiable) - .map(IdentifiableItem.class::cast) - .map(IdentifierCacheKeyFactory::bindKeyString) - .collect(Collectors.joining(KEY_PARTS_SEPARATOR)); - } - - private static String bindKeyString(IdentifiableItem identifiableItem) { - return String.format("%s[%s]", identifiableItem.getType().getTypeName(), identifiableItem.getKey()); - } - - private static Class verifyNotNull(final Class type) { - return checkNotNull(type, "Cannot use null as key"); - } - - /** - * Initial check if provided scope variables are identifiable aka. can be used to create unique cache key - */ - private static Class verifyIsIdentifiable(final Class type) { - checkArgument(Identifiable.class.isAssignableFrom(type), "Type %s is not Identifiable", type); - return type; - } -} diff --git a/infra/translate-utils/src/main/java/io/fd/honeycomb/translate/util/read/cache/TypeAwareIdentifierCacheKeyFactory.java b/infra/translate-utils/src/main/java/io/fd/honeycomb/translate/util/read/cache/TypeAwareIdentifierCacheKeyFactory.java new file mode 100644 index 000000000..ba4e7e493 --- /dev/null +++ b/infra/translate-utils/src/main/java/io/fd/honeycomb/translate/util/read/cache/TypeAwareIdentifierCacheKeyFactory.java @@ -0,0 +1,132 @@ +/* + * Copyright (c) 2016 Cisco and/or its affiliates. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.fd.honeycomb.translate.util.read.cache; + +import static com.google.common.base.Preconditions.checkArgument; +import static com.google.common.base.Preconditions.checkNotNull; +import static org.opendaylight.yangtools.yang.binding.InstanceIdentifier.IdentifiableItem; + +import java.util.Collections; +import java.util.Set; +import java.util.stream.Collectors; +import java.util.stream.StreamSupport; +import javax.annotation.Nonnull; +import org.opendaylight.yangtools.yang.binding.DataObject; +import org.opendaylight.yangtools.yang.binding.Identifiable; +import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; + +/** + * Factory providing cache keys to easier switching between scopes of caching + */ +public final class TypeAwareIdentifierCacheKeyFactory implements CacheKeyFactory { + + private static final String KEY_PARTS_SEPARATOR = "|"; + + // should be Set>>, but that's not possible for wildcards + private final Set> additionalKeyTypes; + // factory must be aware of type of data, to prevent creating same key for same identifier but different data + private final Class type; + + /** + * Construct simple cache key factory + */ + public TypeAwareIdentifierCacheKeyFactory(@Nonnull final Class type) { + this(type, Collections.emptySet()); + } + + /** + * @param additionalKeyTypes Additional types from path of cached type, that are specifying scope + */ + public TypeAwareIdentifierCacheKeyFactory(@Nonnull final Class type, + @Nonnull final Set> additionalKeyTypes) { + // verify that all are non-null and identifiable + this.type = checkNotNull(type, "Type cannot be null"); + this.additionalKeyTypes = checkNotNull(additionalKeyTypes, "Additional key types can't be null").stream() + .map(TypeAwareIdentifierCacheKeyFactory::verifyNotNull) + .map(TypeAwareIdentifierCacheKeyFactory::verifyIsIdentifiable) + .collect(Collectors.toSet()); + } + + private static String bindKeyString(IdentifiableItem identifiableItem) { + return String.format("%s[%s]", identifiableItem.getType().getTypeName(), identifiableItem.getKey()); + } + + private static Class verifyNotNull(final Class type) { + return checkNotNull(type, "Cannot use null as key"); + } + + /** + * Initial check if provided scope variables are identifiable aka. can be used to create unique cache key + */ + private static Class verifyIsIdentifiable(final Class type) { + checkArgument(Identifiable.class.isAssignableFrom(type), "Type %s is not Identifiable", type); + return type; + } + + @Override + public String createKey(@Nonnull final InstanceIdentifier actualContextIdentifier) { + + checkNotNull(actualContextIdentifier, "Cannot construct key for null InstanceIdentifier"); + + // easiest case when only simple key is needed + if (additionalKeyTypes.isEmpty()) { + return String + .join(KEY_PARTS_SEPARATOR, type.getTypeName(), actualContextIdentifier.getTargetType().toString()); + } + + checkArgument(isUniqueKeyConstructable(actualContextIdentifier), + "Unable to construct unique key, required key types : %s, provided paths : %s", additionalKeyTypes, + actualContextIdentifier.getPathArguments()); + + // joins unique key in form : type | additional keys | actual context + return String + .join(KEY_PARTS_SEPARATOR, type.getTypeName(), additionalKeys(actualContextIdentifier), + actualContextIdentifier.getTargetType().toString()); + } + + @Override + public Class getCachedDataType() { + return type; + } + + /** + * Verifies that all requested key parts have keys + */ + private boolean isUniqueKeyConstructable(final InstanceIdentifier actualContextIdentifier) { + return StreamSupport.stream(actualContextIdentifier.getPathArguments().spliterator(), false) + .filter(this::isAdditionalScope) + .filter(this::isIdentifiable) + .count() == additionalKeyTypes.size(); + } + + private boolean isAdditionalScope(final InstanceIdentifier.PathArgument pathArgument) { + return additionalKeyTypes.contains(pathArgument.getType()); + } + + private boolean isIdentifiable(final InstanceIdentifier.PathArgument pathArgument) { + return pathArgument instanceof IdentifiableItem; + } + + private String additionalKeys(final InstanceIdentifier actualContextIdentifier) { + return StreamSupport.stream(actualContextIdentifier.getPathArguments().spliterator(), false) + .filter(this::isAdditionalScope) + .filter(this::isIdentifiable) + .map(IdentifiableItem.class::cast) + .map(TypeAwareIdentifierCacheKeyFactory::bindKeyString) + .collect(Collectors.joining(KEY_PARTS_SEPARATOR)); + } +} -- cgit 1.2.3-korg