package org.opendaylight.yangtools.yang.data.codec.gson;
import com.google.common.annotations.Beta;
-import com.google.common.base.Optional;
-import com.google.common.base.Preconditions;
-import com.google.common.base.Stopwatch;
-import com.google.common.base.Verify;
-import com.google.common.cache.CacheBuilder;
-import com.google.common.cache.CacheLoader;
-import com.google.common.cache.LoadingCache;
-import java.util.ArrayList;
import java.util.List;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.yangtools.yang.common.QNameModule;
import org.opendaylight.yangtools.yang.data.impl.codec.AbstractIntegerStringCodec;
import org.opendaylight.yangtools.yang.data.impl.codec.BinaryStringCodec;
import org.opendaylight.yangtools.yang.data.impl.codec.BitsStringCodec;
import org.opendaylight.yangtools.yang.data.impl.codec.DecimalStringCodec;
import org.opendaylight.yangtools.yang.data.impl.codec.EnumStringCodec;
import org.opendaylight.yangtools.yang.data.impl.codec.StringStringCodec;
+import org.opendaylight.yangtools.yang.data.util.codec.AbstractCodecFactory;
import org.opendaylight.yangtools.yang.data.util.codec.CodecCache;
import org.opendaylight.yangtools.yang.data.util.codec.LazyCodecCache;
-import org.opendaylight.yangtools.yang.data.util.codec.NoopCodecCache;
-import org.opendaylight.yangtools.yang.data.util.codec.PrecomputedCodecCache;
-import org.opendaylight.yangtools.yang.data.util.codec.SharedCodecCache;
-import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
-import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
-import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
-import org.opendaylight.yangtools.yang.model.api.TypedSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
import org.opendaylight.yangtools.yang.model.api.type.BinaryTypeDefinition;
import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
import org.opendaylight.yangtools.yang.model.api.type.BooleanTypeDefinition;
import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
-import org.opendaylight.yangtools.yang.model.api.type.IntegerTypeDefinition;
-import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.Int16TypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.Int32TypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.Int64TypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.Int8TypeDefinition;
import org.opendaylight.yangtools.yang.model.api.type.StringTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.Uint16TypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.Uint32TypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.Uint64TypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.Uint8TypeDefinition;
import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
import org.opendaylight.yangtools.yang.model.api.type.UnknownTypeDefinition;
-import org.opendaylight.yangtools.yang.model.api.type.UnsignedIntegerTypeDefinition;
-import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
/**
* Factory for creating JSON equivalents of codecs. Each instance of this object is bound to
- * a particular {@link SchemaContext}, but can be reused by multiple {@link JSONNormalizedNodeStreamWriter}s.
- *
- * There are multiple implementations available, each with distinct thread-safety, CPU/memory trade-offs and reuse
- * characteristics. See {@link #getShared(SchemaContext)}, {@link #getPrecomputed(SchemaContext)},
- * {@link #createLazy(SchemaContext)} and {@link #createSimple(SchemaContext)} for details.
+ * a particular {@link EffectiveModelContext}, but can be reused by multiple {@link JSONNormalizedNodeStreamWriter}s.
*/
@Beta
-public final class JSONCodecFactory {
- private static final class EagerCacheLoader extends CacheLoader<SchemaContext, JSONCodecFactory> {
- @Override
- public JSONCodecFactory load(final SchemaContext key) {
- final Stopwatch sw = Stopwatch.createStarted();
- final LazyCodecCache<JSONCodec<?>> lazyCache = new LazyCodecCache<>();
- final JSONCodecFactory lazy = new JSONCodecFactory(key, lazyCache);
- final int visitedLeaves = requestCodecsForChildren(lazy, key);
- sw.stop();
-
- final PrecomputedCodecCache<JSONCodec<?>> cache = lazyCache.toPrecomputed();
- LOG.debug("{} leaf nodes resulted in {} simple and {} complex codecs in {}", visitedLeaves,
- cache.simpleSize(), cache.complexSize(), sw);
- return new JSONCodecFactory(key, cache);
- }
-
- private static int requestCodecsForChildren(final JSONCodecFactory lazy, final DataNodeContainer parent) {
- int ret = 0;
- for (DataSchemaNode child : parent.getChildNodes()) {
- if (child instanceof TypedSchemaNode) {
- lazy.codecFor((TypedSchemaNode) child);
- ++ret;
- } else if (child instanceof DataNodeContainer) {
- ret += requestCodecsForChildren(lazy, (DataNodeContainer) child);
- }
- }
-
- return ret;
- }
+public abstract class JSONCodecFactory extends AbstractCodecFactory<JSONCodec<?>> {
+ JSONCodecFactory(final @NonNull EffectiveModelContext context, final @NonNull CodecCache<JSONCodec<?>> cache) {
+ super(context, cache);
}
- private static final Logger LOG = LoggerFactory.getLogger(JSONCodecFactory.class);
-
- // Weak keys to retire the entry when SchemaContext goes away
- private static final LoadingCache<SchemaContext, JSONCodecFactory> PRECOMPUTED = CacheBuilder.newBuilder()
- .weakKeys().build(new EagerCacheLoader());
-
- // Weak keys to retire the entry when SchemaContext goes away and to force identity-based lookup
- private static final LoadingCache<SchemaContext, JSONCodecFactory> SHARED = CacheBuilder.newBuilder()
- .weakKeys().build(new CacheLoader<SchemaContext, JSONCodecFactory>() {
- @Override
- public JSONCodecFactory load(final SchemaContext key) {
- return new JSONCodecFactory(key, new SharedCodecCache<>());
- }
- });
-
-
- private final CodecCache<JSONCodec<?>> cache;
- private final SchemaContext schemaContext;
- private final JSONCodec<?> iidCodec;
-
- JSONCodecFactory(final SchemaContext context, final CodecCache<JSONCodec<?>> cache) {
- this.schemaContext = Preconditions.checkNotNull(context);
- this.cache = Preconditions.checkNotNull(cache);
- iidCodec = new JSONStringInstanceIdentifierCodec(context, this);
+ @Override
+ protected final JSONCodec<?> binaryCodec(final BinaryTypeDefinition type) {
+ return new QuotedJSONCodec<>(BinaryStringCodec.from(type));
}
- /**
- * Instantiate a new codec factory attached to a particular context.
- *
- * @param context SchemaContext to which the factory should be bound
- * @return A codec factory instance.
- *
- * @deprecated Use {@link #getShared(SchemaContext)} instead.
- */
- @Deprecated
- public static JSONCodecFactory create(final SchemaContext context) {
- return getShared(context);
+ @Override
+ protected final JSONCodec<?> booleanCodec(final BooleanTypeDefinition type) {
+ return new BooleanJSONCodec(BooleanStringCodec.from(type));
}
- /**
- * Get a thread-safe, eagerly-caching {@link JSONCodecFactory} for a SchemaContext. This method can, and will,
- * return the same instance as long as the associated SchemaContext is present. Returned object can be safely
- * used by multiple threads concurrently. If the SchemaContext instance does not have a cached instance
- * of {@link JSONCodecFactory}, it will be completely precomputed before this method will return.
- *
- * Choosing this implementation is appropriate when the memory overhead of keeping a full codec tree is not as
- * great a concern as predictable performance. When compared to the implementation returned by
- * {@link #getShared(SchemaContext)}, this implementation is expected to offer higher performance and have lower
- * peak memory footprint when most of the SchemaContext is actually in use.
- *
- * For call sites which do not want to pay the CPU cost of pre-computing this implementation, but still would like
- * to use it if is available (by being populated by some other caller), you can use
- * {@link #getPrecomputedIfAvailable(SchemaContext)}.
- *
- * @param context SchemaContext instance
- * @return A sharable {@link JSONCodecFactory}
- * @throws NullPointerException if context is null
- */
- public static JSONCodecFactory getPrecomputed(final SchemaContext context) {
- return PRECOMPUTED.getUnchecked(context);
+ @Override
+ protected final JSONCodec<?> bitsCodec(final BitsTypeDefinition type) {
+ return new QuotedJSONCodec<>(BitsStringCodec.from(type));
}
- /**
- * Get a thread-safe, eagerly-caching {@link JSONCodecFactory} for a SchemaContext, if it is available. This
- * method is a non-blocking equivalent of {@link #getPrecomputed(SchemaContext)} for use in code paths where
- * the potential of having to pre-compute the implementation is not acceptable. One such scenario is when the
- * code base wants to opportunistically take advantage of pre-computed version, but is okay with a fallback to
- * a different implementation.
- *
- * @param context SchemaContext instance
- * @return A sharable {@link JSONCodecFactory}, or absent if such an implementation is not available.
- * @throws NullPointerException if context is null
- */
- public static Optional<JSONCodecFactory> getPrecomputedIfAvailable(final SchemaContext context) {
- return Optional.fromNullable(PRECOMPUTED.getIfPresent(context));
+ @Override
+ protected final JSONCodec<?> decimalCodec(final DecimalTypeDefinition type) {
+ return wrapDecimalCodec(DecimalStringCodec.from(type));
}
- /**
- * Get a thread-safe, lazily-caching {@link JSONCodecFactory} for a SchemaContext. This method can, and will,
- * return the same instance as long as the associated SchemaContext is present or the factory is not invalidated
- * by memory pressure. Returned object can be safely used by multiple threads concurrently.
- *
- * Choosing this implementation is a safe default, as it will not incur prohibitive blocking, nor will it tie up
- * memory in face of pressure.
- *
- * @param context SchemaContext instance
- * @return A sharable {@link JSONCodecFactory}
- * @throws NullPointerException if context is null
- */
- public static JSONCodecFactory getShared(final SchemaContext context) {
- return SHARED.getUnchecked(context);
+ @Override
+ protected final JSONCodec<?> emptyCodec(final EmptyTypeDefinition type) {
+ return EmptyJSONCodec.INSTANCE;
}
- /**
- * Create a new thread-unsafe, lazily-caching {@link JSONCodecFactory} for a SchemaContext. This method will
- * return distinct objects every time it is invoked. Returned object may not be used from multiple threads
- * concurrently.
- *
- * This implementation is appropriate for one-off serialization from a single thread. It will aggressively cache
- * codecs for reuse and will tie them up in memory until the factory is freed.
- *
- * @param context SchemaContext instance
- * @return A non-sharable {@link JSONCodecFactory}
- * @throws NullPointerException if context is null
- */
- public static JSONCodecFactory createLazy(final SchemaContext context) {
- return new JSONCodecFactory(context, new LazyCodecCache<>());
+ @Override
+ protected final JSONCodec<?> enumCodec(final EnumTypeDefinition type) {
+ return new QuotedJSONCodec<>(EnumStringCodec.from(type));
}
- /**
- * Create a simplistic, thread-safe {@link JSONCodecFactory} for a {@link SchemaContext}. This method will return
- * distinct objects every time it is invoked. Returned object may be use from multiple threads concurrently.
- *
- * This implementation exists mostly for completeness only, as it does not perform any caching at all and each codec
- * is computed every time it is requested. This may be useful in extremely constrained environments, where memory
- * footprint is more critical than performance.
- *
- * @param context SchemaContext instance
- * @return A non-sharable {@link JSONCodecFactory}
- * @throws NullPointerException if context is null.
- */
- public static JSONCodecFactory createSimple(final SchemaContext context) {
- return new JSONCodecFactory(context, NoopCodecCache.getInstance());
+ @Override
+ protected final JSONCodec<?> identityRefCodec(final IdentityrefTypeDefinition type, final QNameModule module) {
+ return new IdentityrefJSONCodec(getEffectiveModelContext(), module);
}
- final JSONCodec<?> codecFor(final TypedSchemaNode schema) {
- /*
- * There are many trade-offs to be made here. We need the common case being as fast as possible while reusing
- * codecs as much as possible.
- *
- * This gives us essentially four classes of codecs:
- * - simple codecs, which are based on the type definition only
- * - complex codecs, which depend on both type definition and the leaf
- * - null codec, which does not depend on anything
- * - instance identifier codec, which is based on namespace mapping
- *
- * We assume prevalence is in above order and that caching is effective. We therefore
- */
- final TypeDefinition<?> type = schema.getType();
- JSONCodec<?> ret = cache.lookupSimple(type);
- if (ret != null) {
- LOG.trace("Type {} hit simple {}", type, ret);
- return ret;
- }
- ret = cache.lookupComplex(schema);
- if (ret != null) {
- LOG.trace("Type {} hit complex {}", type, ret);
- return ret;
- }
-
- // Dealing with simple types first...
- ret = getSimpleCodecFor(type);
- if (ret != null) {
- LOG.trace("Type {} miss simple {}", type, ret);
- return ret;
- }
-
- // ... and complex types afterwards
- ret = createComplexCodecFor(schema, type);
- LOG.trace("Type {} miss complex {}", type, ret);
- return cache.getComplex(schema, ret);
+ @Override
+ protected final JSONCodec<?> int8Codec(final Int8TypeDefinition type) {
+ return new NumberJSONCodec<>(AbstractIntegerStringCodec.from(type));
}
- final SchemaContext getSchemaContext() {
- return schemaContext;
+ @Override
+ protected final JSONCodec<?> int16Codec(final Int16TypeDefinition type) {
+ return new NumberJSONCodec<>(AbstractIntegerStringCodec.from(type));
}
- private JSONCodec<?> getSimpleCodecFor(final TypeDefinition<?> type) {
- if (type instanceof InstanceIdentifierTypeDefinition) {
- // FIXME: there really are two favors, as 'require-instance true' needs to be validated. In order to deal
- // with that, though, we need access to the current data store.
- return iidCodec;
- } else if (type instanceof EmptyTypeDefinition) {
- return EmptyJSONCodec.INSTANCE;
- } else if (type instanceof UnknownTypeDefinition) {
- return NullJSONCodec.INSTANCE;
- }
-
- // Now deal with simple types. Note we consider union composed of purely simple types a simple type itself.
- // The checks here are optimized for common types.
- final JSONCodec<?> ret;
- if (type instanceof StringTypeDefinition) {
- ret = new QuotedJSONCodec<>(StringStringCodec.from((StringTypeDefinition) type));
- } else if (type instanceof IntegerTypeDefinition) {
- ret = new NumberJSONCodec<>(AbstractIntegerStringCodec.from((IntegerTypeDefinition) type));
- } else if (type instanceof UnsignedIntegerTypeDefinition) {
- ret = new NumberJSONCodec<>(AbstractIntegerStringCodec.from((UnsignedIntegerTypeDefinition) type));
- } else if (type instanceof BooleanTypeDefinition) {
- ret = new BooleanJSONCodec(BooleanStringCodec.from((BooleanTypeDefinition) type));
- } else if (type instanceof DecimalTypeDefinition) {
- ret = new NumberJSONCodec<>(DecimalStringCodec.from((DecimalTypeDefinition) type));
- } else if (type instanceof EnumTypeDefinition) {
- ret = new QuotedJSONCodec<>(EnumStringCodec.from((EnumTypeDefinition) type));
- } else if (type instanceof BitsTypeDefinition) {
- ret = new QuotedJSONCodec<>(BitsStringCodec.from((BitsTypeDefinition) type));
- } else if (type instanceof UnionTypeDefinition) {
- final UnionTypeDefinition union = (UnionTypeDefinition) type;
- if (!isSimpleUnion(union)) {
- return null;
- }
- ret = createSimpleUnion(union);
- } else if (type instanceof BinaryTypeDefinition) {
- ret = new QuotedJSONCodec<>(BinaryStringCodec.from((BinaryTypeDefinition) type));
- } else {
- return null;
- }
-
- return cache.getSimple(type, Verify.verifyNotNull(ret));
+ @Override
+ protected final JSONCodec<?> int32Codec(final Int32TypeDefinition type) {
+ return new NumberJSONCodec<>(AbstractIntegerStringCodec.from(type));
}
- private JSONCodec<?> createComplexCodecFor(final TypedSchemaNode schema, final TypeDefinition<?> type) {
- if (type instanceof UnionTypeDefinition) {
- return createComplexUnion(schema, (UnionTypeDefinition) type);
- } else if (type instanceof LeafrefTypeDefinition) {
- final TypeDefinition<?> target = SchemaContextUtil.getBaseTypeForLeafRef((LeafrefTypeDefinition) type,
- schemaContext, schema);
- Verify.verifyNotNull(target, "Unable to find base type for leafref node %s type %s.", schema.getPath(),
- target);
+ @Override
+ protected final JSONCodec<?> int64Codec(final Int64TypeDefinition type) {
+ return wrapIntegerCodec(AbstractIntegerStringCodec.from(type));
+ }
- final JSONCodec<?> ret = getSimpleCodecFor(target);
- return ret != null ? ret : createComplexCodecFor(schema, target);
- } else if (type instanceof IdentityrefTypeDefinition) {
- return new JSONStringIdentityrefCodec(schemaContext, schema.getQName().getModule());
- } else {
- throw new IllegalArgumentException("Unsupported type " + type);
- }
+ @Override
+ protected final JSONCodec<?> stringCodec(final StringTypeDefinition type) {
+ return new QuotedJSONCodec<>(StringStringCodec.from(type));
}
- private static boolean isSimpleUnion(final UnionTypeDefinition union) {
- for (TypeDefinition<?> t : union.getTypes()) {
- if (t instanceof IdentityrefTypeDefinition || t instanceof LeafrefTypeDefinition
- || (t instanceof UnionTypeDefinition && !isSimpleUnion((UnionTypeDefinition) t))) {
- LOG.debug("Type {} has non-simple subtype", t);
- return false;
- }
- }
+ @Override
+ protected final JSONCodec<?> uint8Codec(final Uint8TypeDefinition type) {
+ return new NumberJSONCodec<>(AbstractIntegerStringCodec.from(type));
+ }
- LOG.debug("Type {} is simple", union);
- return true;
+ @Override
+ protected final JSONCodec<?> uint16Codec(final Uint16TypeDefinition type) {
+ return new NumberJSONCodec<>(AbstractIntegerStringCodec.from(type));
}
- private JSONCodec<?> createSimpleUnion(final UnionTypeDefinition union) {
- final List<TypeDefinition<?>> types = union.getTypes();
- final List<JSONCodec<?>> codecs = new ArrayList<>(types.size());
+ @Override
+ protected final JSONCodec<?> uint32Codec(final Uint32TypeDefinition type) {
+ return new NumberJSONCodec<>(AbstractIntegerStringCodec.from(type));
+ }
- for (TypeDefinition<?> type : types) {
- JSONCodec<?> codec = cache.lookupSimple(type);
- if (codec == null) {
- codec = Verify.verifyNotNull(getSimpleCodecFor(type), "Type %s did not resolve to a simple codec",
- type);
- }
+ @Override
+ protected final JSONCodec<?> uint64Codec(final Uint64TypeDefinition type) {
+ return wrapIntegerCodec(AbstractIntegerStringCodec.from(type));
+ }
- codecs.add(codec);
- }
+ @Override
+ protected final JSONCodec<?> unionCodec(final UnionTypeDefinition type, final List<JSONCodec<?>> codecs) {
+ return UnionJSONCodec.create(type, codecs);
+ }
- return UnionJSONCodec.create(union, codecs);
+ @Override
+ protected final JSONCodec<?> unknownCodec(final UnknownTypeDefinition type) {
+ return NullJSONCodec.INSTANCE;
}
- private UnionJSONCodec<?> createComplexUnion(final TypedSchemaNode schema, final UnionTypeDefinition union) {
- final List<TypeDefinition<?>> types = union.getTypes();
- final List<JSONCodec<?>> codecs = new ArrayList<>(types.size());
+ @Override
+ protected abstract JSONCodec<?> instanceIdentifierCodec(InstanceIdentifierTypeDefinition type);
+
+ // Returns a one-off factory for the purposes of normalizing an anydata tree.
+ //
+ // FIXME: 6.0.0: this is really ugly, as we should be able to tell if the new context is the same as ours and
+ // whether our cache is thread-safe -- in which case we should just return this.
+ // The supplier/cache/factory layout needs to be reworked so that this call ends up being equivalent
+ // to JSONCodecFactorySupplier.getShared() in case this factory is not thread safe.
+ //
+ // The above is not currently possible, as we cannot reference JSONCodecFactorySupplier from the
+ // factory due to that potentially creating a circular reference.
+ final JSONCodecFactory rebaseTo(final EffectiveModelContext newSchemaContext) {
+ return rebaseTo(newSchemaContext, new LazyCodecCache<>());
+ }
- for (TypeDefinition<?> type : types) {
- JSONCodec<?> codec = cache.lookupSimple(type);
- if (codec == null) {
- codec = getSimpleCodecFor(type);
- if (codec == null) {
- codec = createComplexCodecFor(schema, type);
- }
- }
+ abstract JSONCodecFactory rebaseTo(EffectiveModelContext newSchemaContext, CodecCache<JSONCodec<?>> newCache);
- codecs.add(Verify.verifyNotNull(codec, "Schema %s subtype %s has no codec", schema, type));
- }
+ abstract JSONCodec<?> wrapDecimalCodec(DecimalStringCodec decimalCodec);
- return UnionJSONCodec.create(union, codecs);
- }
+ abstract JSONCodec<?> wrapIntegerCodec(AbstractIntegerStringCodec<?, ?> integerCodec);
}
Code Review / yangtools.git / blobdiff