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