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 org.eclipse.jdt.annotation.NonNull;
  22 import org.opendaylight.controller.cluster.raft.messages.IdentifiablePayload;
  23 import org.opendaylight.yangtools.concepts.Identifiable;
  24 import org.opendaylight.yangtools.concepts.Identifier;
  25
  26 /**
  27  * Abstract base class for {@link IdentifiablePayload}s which hold a single {@link Identifier}.
  28  *
  29  * @author Robert Varga
  30  */
  31 public abstract class AbstractIdentifiablePayload<T extends Identifier> extends IdentifiablePayload<T>
  32         implements Serializable {
  33     protected abstract static class AbstractProxy<T extends Identifier> implements Externalizable {
  34         private static final long serialVersionUID = 1L;
  35
  36         private byte[] serialized;
  37         private T identifier;
  38
  39         public AbstractProxy() {
  40             // For Externalizable
  41         }
  42
  43         protected AbstractProxy(final byte[] serialized) {
  44             this.serialized = requireNonNull(serialized);
  45         }
  46
  47         @Override
  48         public final void writeExternal(final ObjectOutput out) throws IOException {
  49             out.writeInt(serialized.length);
  50             out.write(serialized);
  51         }
  52
  53         @Override
  54         public final void readExternal(final ObjectInput in) throws IOException {
  55             final int length = in.readInt();
  56             serialized = new byte[length];
  57             in.readFully(serialized);
  58             identifier = verifyNotNull(readIdentifier(ByteStreams.newDataInput(serialized)));
  59         }
  60
  61         protected final Object readResolve() {
  62             return verifyNotNull(createObject(identifier, serialized));
  63         }
  64
  65         protected abstract @NonNull T readIdentifier(@NonNull DataInput in) throws IOException;
  66
  67         @SuppressWarnings("checkstyle:hiddenField")
  68         protected abstract @NonNull Identifiable<T> createObject(@NonNull T identifier, byte @NonNull[] serialized);
  69     }
  70
  71     private static final long serialVersionUID = 1L;
  72
  73     private final byte @NonNull [] serialized;
  74     private final @NonNull T identifier;
  75
  76     AbstractIdentifiablePayload(final @NonNull T identifier, final byte @NonNull[] serialized) {
  77         this.identifier = requireNonNull(identifier);
  78         this.serialized = requireNonNull(serialized);
  79     }
  80
  81     @Override
  82     public final T getIdentifier() {
  83         return identifier;
  84     }
  85
  86     @Override
  87     public final int size() {
  88         return serialized.length;
  89     }
  90
  91     @Override
  92     public final String toString() {
  93         return MoreObjects.toStringHelper(this).add("identifier", identifier).add("size", size()).toString();
  94     }
  95
  96     @Override
  97     protected final Object writeReplace() {
  98         return verifyNotNull(externalizableProxy(serialized));
  99     }
 100
 101     @SuppressWarnings("checkstyle:hiddenField")
 102     protected abstract @NonNull AbstractProxy<T> externalizableProxy(byte @NonNull[] serialized);
 103 }