opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/client/messages/GetSnapshotReply.java

   1 /*
   2  * Copyright (c) 2015 Brocade Communications 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.raft.client.messages;
   9
  10 import com.google.common.base.Preconditions;
  11 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  12 import javax.annotation.Nonnull;
  13
  14 /**
  15  * Reply to GetSnapshot that returns a serialized Snapshot instance.
  16  *
  17  * @author Thomas Pantelis
  18  */
  19 public class GetSnapshotReply {
  20     private final String id;
  21     private final byte[] snapshot;
  22
  23     public GetSnapshotReply(@Nonnull String id, @Nonnull byte[] snapshot) {
  24         this.id = Preconditions.checkNotNull(id);
  25         this.snapshot = Preconditions.checkNotNull(snapshot);
  26     }
  27
  28     @Nonnull
  29     public String getId() {
  30         return id;
  31     }
  32
  33     @SuppressFBWarnings(value = "EI_EXPOSE_REP", justification = "Exposes a mutable object stored in a field but "
  34             + "this is OK since this class is merely a DTO and does not process the byte[] internally. "
  35             + "Also it would be inefficient to create a return copy as the byte[] could be large.")
  36     @Nonnull
  37     public byte[] getSnapshot() {
  38         return snapshot;
  39     }
  40
  41     @Override
  42     public String toString() {
  43         return "GetSnapshotReply [id=" + id + ", snapshot.length=" + snapshot.length + "]";
  44     }
  45 }