opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/AbstractIdentifiablePayload.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.cluster.datastore.persisted;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.base.MoreObjects;
  14 import com.google.common.io.ByteStreams;
  15 import java.io.DataInput;
  16 import java.io.Externalizable;
  17 import java.io.IOException;
  18 import java.io.ObjectInput;
  19 import java.io.ObjectOutput;
  20 import java.io.Serializable;
  21 import java.util.function.Function;
  22 import org.apache.commons.lang3.SerializationUtils;
  23 import org.eclipse.jdt.annotation.NonNull;
  24 import org.opendaylight.controller.cluster.raft.messages.IdentifiablePayload;
  25 import org.opendaylight.yangtools.concepts.Identifiable;
  26 import org.opendaylight.yangtools.concepts.Identifier;
  27
  28 /**
  29  * Abstract base class for {@link IdentifiablePayload}s which hold a single {@link Identifier}.
  30  *
  31  * @author Robert Varga
  32  */
  33 public abstract class AbstractIdentifiablePayload<T extends Identifier> extends IdentifiablePayload<T>
  34         implements Serializable {
  35     protected abstract static class AbstractProxy<T extends Identifier> implements Externalizable {
  36         private static final long serialVersionUID = 1L;
  37
  38         private byte[] serialized;
  39         private T identifier;
  40
  41         public AbstractProxy() {
  42             // For Externalizable
  43         }
  44
  45         protected AbstractProxy(final byte[] serialized) {
  46             this.serialized = requireNonNull(serialized);
  47         }
  48
  49         @Override
  50         public final void writeExternal(final ObjectOutput out) throws IOException {
  51             out.writeInt(serialized.length);
  52             out.write(serialized);
  53         }
  54
  55         @Override
  56         public final void readExternal(final ObjectInput in) throws IOException {
  57             final int length = in.readInt();
  58             serialized = new byte[length];
  59             in.readFully(serialized);
  60             identifier = verifyNotNull(readIdentifier(ByteStreams.newDataInput(serialized)));
  61         }
  62
  63         protected final Object readResolve() {
  64             return verifyNotNull(createObject(identifier, serialized));
  65         }
  66
  67         protected abstract @NonNull T readIdentifier(@NonNull DataInput in) throws IOException;
  68
  69         @SuppressWarnings("checkstyle:hiddenField")
  70         protected abstract @NonNull Identifiable<T> createObject(@NonNull T identifier, byte @NonNull[] serialized);
  71     }
  72
  73     private static final long serialVersionUID = 1L;
  74
  75     private final byte @NonNull [] serialized;
  76     private final @NonNull T identifier;
  77
  78     AbstractIdentifiablePayload(final @NonNull T identifier, final byte @NonNull[] serialized) {
  79         this.identifier = requireNonNull(identifier);
  80         this.serialized = requireNonNull(serialized);
  81     }
  82
  83     @Override
  84     public final T getIdentifier() {
  85         return identifier;
  86     }
  87
  88     @Override
  89     public final int size() {
  90         return serialized.length;
  91     }
  92
  93     @Override
  94     public final int serializedSize() {
  95         // TODO: this is not entirely accurate, as the serialization stream has additional overheads:
  96         //       - 3 bytes for each block of data <256 bytes
  97         //       - 5 bytes for each block of data >=256 bytes
  98         //       - each block of data is limited to 1024 bytes as per serialization spec
  99         return size() + externalizableProxySize();
 100     }
 101
 102     @Override
 103     public final String toString() {
 104         return MoreObjects.toStringHelper(this).add("identifier", identifier).add("size", size()).toString();
 105     }
 106
 107     @Override
 108     protected final Object writeReplace() {
 109         return verifyNotNull(externalizableProxy(serialized));
 110     }
 111
 112     @SuppressWarnings("checkstyle:hiddenField")
 113     protected abstract @NonNull AbstractProxy<T> externalizableProxy(byte @NonNull[] serialized);
 114
 115     protected abstract int externalizableProxySize();
 116
 117     protected static final int externalizableProxySize(final Function<byte[], ? extends AbstractProxy<?>> constructor) {
 118         return SerializationUtils.serialize(constructor.apply(new byte[0])).length;
 119     }
 120 }