opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/ShardDataTreeSnapshotMetadata.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 com.google.common.base.Verify;
  11 import java.io.Externalizable;
  12 import java.io.Serializable;
  13 import javax.annotation.Nonnull;
  14
  15 /**
  16  * Base class for various bits of metadata attached to a {@link MetadataShardDataTreeSnapshot}. This class is not
  17  * an interface because we want to make sure all subclasses implement the externalizable proxy pattern, for which
  18  * we need to force {@link #writeReplace()} to be abstract. We do that by making it final and exposing a protected
  19  * {@link #externalizableProxy()} method.
  20  *
  21  * <p>
  22  * All concrete subclasses of this class should be final so as to form a distinct set of possible metadata. Since
  23  * metadata is serialized along with {@link MetadataShardDataTreeSnapshot}, this set is part of the serialization format
  24  * guarded by {@link PayloadVersion}.
  25  *
  26  * <p>
  27  * If a new metadata type is introduced or a type is removed, {@link PayloadVersion} needs to be bumped to ensure
  28  * compatibility.
  29  *
  30  * @author Robert Varga
  31  */
  32 public abstract class ShardDataTreeSnapshotMetadata<T extends ShardDataTreeSnapshotMetadata<T>>
  33         implements Serializable {
  34     private static final long serialVersionUID = 1L;
  35
  36     ShardDataTreeSnapshotMetadata() {
  37         // Prevent subclassing from outside of this package
  38     }
  39
  40     final Object writeReplace() {
  41         return Verify.verifyNotNull(externalizableProxy(), "Null externalizable proxy from %s", getClass());
  42     }
  43
  44     /**
  45      * Return an Externalizable proxy.
  46      *
  47      * @return Externalizable proxy, may not be null
  48      */
  49     protected abstract @Nonnull Externalizable externalizableProxy();
  50
  51     public abstract Class<T> getType();
  52 }