diff options
Diffstat (limited to 'framework/src/onos/utils/misc/src/main/java/org/onlab/util/KryoNamespace.java')
| -rw-r--r-- | framework/src/onos/utils/misc/src/main/java/org/onlab/util/KryoNamespace.java | 437 |
1 files changed, 0 insertions, 437 deletions
diff --git a/framework/src/onos/utils/misc/src/main/java/org/onlab/util/KryoNamespace.java b/framework/src/onos/utils/misc/src/main/java/org/onlab/util/KryoNamespace.java deleted file mode 100644 index 9977e35d..00000000 --- a/framework/src/onos/utils/misc/src/main/java/org/onlab/util/KryoNamespace.java +++ /dev/null @@ -1,437 +0,0 @@ -/* - * Copyright 2014-2015 Open Networking Laboratory - * - * 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 org.onlab.util; - -import java.io.InputStream; -import java.io.OutputStream; -import java.nio.ByteBuffer; -import java.util.ArrayList; -import java.util.List; - -import org.apache.commons.lang3.tuple.Pair; - -import com.esotericsoftware.kryo.Kryo; -import com.esotericsoftware.kryo.Serializer; -import com.esotericsoftware.kryo.io.ByteBufferInput; -import com.esotericsoftware.kryo.io.ByteBufferOutput; -import com.esotericsoftware.kryo.io.Input; -import com.esotericsoftware.kryo.pool.KryoCallback; -import com.esotericsoftware.kryo.pool.KryoFactory; -import com.esotericsoftware.kryo.pool.KryoPool; -import com.google.common.base.MoreObjects; -import com.google.common.collect.ImmutableList; - -/** - * Pool of Kryo instances, with classes pre-registered. - */ -//@ThreadSafe -public final class KryoNamespace implements KryoFactory, KryoPool { - - /** - * Default buffer size used for serialization. - * - * @see #serialize(Object) - */ - public static final int DEFAULT_BUFFER_SIZE = 4096; - public static final int MAX_BUFFER_SIZE = 100 * 1000 * 1000; - - /** - * ID to use if this KryoNamespace does not define registration id. - */ - public static final int FLOATING_ID = -1; - - /** - * Smallest ID free to use for user defined registrations. - */ - public static final int INITIAL_ID = 11; - - - private final KryoPool pool = new KryoPool.Builder(this) - .softReferences() - .build(); - - private final ImmutableList<RegistrationBlock> registeredBlocks; - - private final boolean registrationRequired; - - - /** - * KryoNamespace builder. - */ - //@NotThreadSafe - public static final class Builder { - - private int blockHeadId = INITIAL_ID; - private List<Pair<Class<?>, Serializer<?>>> types = new ArrayList<>(); - private List<RegistrationBlock> blocks = new ArrayList<>(); - private boolean registrationRequired = true; - - /** - * Builds a {@link KryoNamespace} instance. - * - * @return KryoNamespace - */ - public KryoNamespace build() { - if (!types.isEmpty()) { - blocks.add(new RegistrationBlock(this.blockHeadId, types)); - } - return new KryoNamespace(blocks, registrationRequired).populate(1); - } - - /** - * Sets the next Kryo registration Id for following register entries. - * - * @param id Kryo registration Id - * @return this - * - * @see Kryo#register(Class, Serializer, int) - */ - public Builder nextId(final int id) { - if (!types.isEmpty()) { - blocks.add(new RegistrationBlock(this.blockHeadId, types)); - types = new ArrayList<>(); - } - this.blockHeadId = id; - return this; - } - - /** - * Registers classes to be serialized using Kryo default serializer. - * - * @param expectedTypes list of classes - * @return this - */ - public Builder register(final Class<?>... expectedTypes) { - for (Class<?> clazz : expectedTypes) { - types.add(Pair.of(clazz, null)); - } - return this; - } - - /** - * Registers a class and it's serializer. - * - * @param classes list of classes to register - * @param serializer serializer to use for the class - * @return this - */ - public Builder register(Serializer<?> serializer, final Class<?>... classes) { - for (Class<?> clazz : classes) { - types.add(Pair.of(clazz, serializer)); - } - return this; - } - - private Builder register(RegistrationBlock block) { - if (block.begin() != FLOATING_ID) { - // flush pending types - nextId(block.begin()); - blocks.add(block); - nextId(block.begin() + block.types().size()); - } else { - // flush pending types - final int addedBlockBegin = blockHeadId + types.size(); - nextId(addedBlockBegin); - blocks.add(new RegistrationBlock(addedBlockBegin, block.types())); - nextId(addedBlockBegin + block.types().size()); - } - return this; - } - - /** - * Registers all the class registered to given KryoNamespace. - * - * @param ns KryoNamespace - * @return this - */ - public Builder register(final KryoNamespace ns) { - for (RegistrationBlock block : ns.registeredBlocks) { - this.register(block); - } - return this; - } - - /** - * Sets the registrationRequired flag. - * - * @param registrationRequired Kryo's registrationRequired flag - * @return this - * - * @see Kryo#setRegistrationRequired(boolean) - */ - public Builder setRegistrationRequired(boolean registrationRequired) { - this.registrationRequired = registrationRequired; - return this; - } - } - - /** - * Creates a new {@link KryoNamespace} builder. - * - * @return builder - */ - public static Builder newBuilder() { - return new Builder(); - } - - /** - * Creates a Kryo instance pool. - * - * @param registeredTypes types to register - * @param registrationRequired - */ - private KryoNamespace(final List<RegistrationBlock> registeredTypes, boolean registrationRequired) { - this.registeredBlocks = ImmutableList.copyOf(registeredTypes); - this.registrationRequired = registrationRequired; - } - - /** - * Populates the Kryo pool. - * - * @param instances to add to the pool - * @return this - */ - public KryoNamespace populate(int instances) { - - for (int i = 0; i < instances; ++i) { - release(create()); - } - return this; - } - - /** - * Serializes given object to byte array using Kryo instance in pool. - * <p> - * Note: Serialized bytes must be smaller than {@link #MAX_BUFFER_SIZE}. - * - * @param obj Object to serialize - * @return serialized bytes - */ - public byte[] serialize(final Object obj) { - return serialize(obj, DEFAULT_BUFFER_SIZE); - } - - /** - * Serializes given object to byte array using Kryo instance in pool. - * - * @param obj Object to serialize - * @param bufferSize maximum size of serialized bytes - * @return serialized bytes - */ - public byte[] serialize(final Object obj, final int bufferSize) { - ByteBufferOutput out = new ByteBufferOutput(bufferSize, MAX_BUFFER_SIZE); - try { - Kryo kryo = borrow(); - try { - kryo.writeClassAndObject(out, obj); - out.flush(); - return out.toBytes(); - } finally { - release(kryo); - } - } finally { - out.release(); - } - } - - /** - * Serializes given object to byte buffer using Kryo instance in pool. - * - * @param obj Object to serialize - * @param buffer to write to - */ - public void serialize(final Object obj, final ByteBuffer buffer) { - ByteBufferOutput out = new ByteBufferOutput(buffer); - Kryo kryo = borrow(); - try { - kryo.writeClassAndObject(out, obj); - out.flush(); - } finally { - release(kryo); - } - } - - /** - * Serializes given object to OutputStream using Kryo instance in pool. - * - * @param obj Object to serialize - * @param stream to write to - */ - public void serialize(final Object obj, final OutputStream stream) { - serialize(obj, stream, DEFAULT_BUFFER_SIZE); - } - - /** - * Serializes given object to OutputStream using Kryo instance in pool. - * - * @param obj Object to serialize - * @param stream to write to - * @param bufferSize size of the buffer in front of the stream - */ - public void serialize(final Object obj, final OutputStream stream, final int bufferSize) { - ByteBufferOutput out = new ByteBufferOutput(stream, bufferSize); - Kryo kryo = borrow(); - try { - kryo.writeClassAndObject(out, obj); - out.flush(); - } finally { - release(kryo); - } - } - - /** - * Deserializes given byte array to Object using Kryo instance in pool. - * - * @param bytes serialized bytes - * @param <T> deserialized Object type - * @return deserialized Object - */ - public <T> T deserialize(final byte[] bytes) { - Input in = new Input(bytes); - Kryo kryo = borrow(); - try { - @SuppressWarnings("unchecked") - T obj = (T) kryo.readClassAndObject(in); - return obj; - } finally { - release(kryo); - } - } - - /** - * Deserializes given byte buffer to Object using Kryo instance in pool. - * - * @param buffer input with serialized bytes - * @param <T> deserialized Object type - * @return deserialized Object - */ - public <T> T deserialize(final ByteBuffer buffer) { - ByteBufferInput in = new ByteBufferInput(buffer); - Kryo kryo = borrow(); - try { - @SuppressWarnings("unchecked") - T obj = (T) kryo.readClassAndObject(in); - return obj; - } finally { - release(kryo); - } - } - - /** - * Deserializes given InputStream to an Object using Kryo instance in pool. - * - * @param stream input stream - * @param <T> deserialized Object type - * @return deserialized Object - */ - public <T> T deserialize(final InputStream stream) { - return deserialize(stream, DEFAULT_BUFFER_SIZE); - } - - /** - * Deserializes given InputStream to an Object using Kryo instance in pool. - * - * @param stream input stream - * @param <T> deserialized Object type - * @return deserialized Object - * @param bufferSize size of the buffer in front of the stream - */ - public <T> T deserialize(final InputStream stream, final int bufferSize) { - ByteBufferInput in = new ByteBufferInput(stream, bufferSize); - Kryo kryo = borrow(); - try { - @SuppressWarnings("unchecked") - T obj = (T) kryo.readClassAndObject(in); - return obj; - } finally { - release(kryo); - } - } - - /** - * Creates a Kryo instance. - * - * @return Kryo instance - */ - @Override - public Kryo create() { - Kryo kryo = new Kryo(); - kryo.setRegistrationRequired(registrationRequired); - for (RegistrationBlock block : registeredBlocks) { - int id = block.begin(); - if (id == FLOATING_ID) { - id = kryo.getNextRegistrationId(); - } - for (Pair<Class<?>, Serializer<?>> entry : block.types()) { - final Serializer<?> serializer = entry.getRight(); - if (serializer == null) { - kryo.register(entry.getLeft(), id++); - } else { - kryo.register(entry.getLeft(), serializer, id++); - } - } - } - return kryo; - } - - @Override - public Kryo borrow() { - return pool.borrow(); - } - - @Override - public void release(Kryo kryo) { - pool.release(kryo); - } - - @Override - public <T> T run(KryoCallback<T> callback) { - return pool.run(callback); - } - - @Override - public String toString() { - return MoreObjects.toStringHelper(getClass()) - .add("registeredBlocks", registeredBlocks) - .toString(); - } - - static final class RegistrationBlock { - private final int begin; - private final ImmutableList<Pair<Class<?>, Serializer<?>>> types; - - public RegistrationBlock(int begin, List<Pair<Class<?>, Serializer<?>>> types) { - this.begin = begin; - this.types = ImmutableList.copyOf(types); - } - - public int begin() { - return begin; - } - - public ImmutableList<Pair<Class<?>, Serializer<?>>> types() { - return types; - } - - @Override - public String toString() { - return MoreObjects.toStringHelper(getClass()) - .add("begin", begin) - .add("types", types) - .toString(); - } - } -} |