2 * Copyright (c) 2015 Brocade Communications Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.datastore.persisted;
10 import com.google.common.base.Preconditions;
11 import com.google.common.collect.ImmutableList;
12 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
13 import java.io.Serializable;
14 import java.util.List;
15 import javax.annotation.Nonnull;
16 import javax.annotation.Nullable;
19 * Stores a snapshot of the internal state of a data store.
21 * @author Thomas Pantelis
23 public class DatastoreSnapshot implements Serializable {
24 private static final long serialVersionUID = 1L;
26 private final String type;
27 private final byte[] shardManagerSnapshot;
28 private final List<ShardSnapshot> shardSnapshots;
30 @SuppressFBWarnings(value = "EI_EXPOSE_REP2", justification = "Stores a reference to an externally mutable byte[] "
31 + "object but this is OK since this class is merely a DTO and does not process byte[] internally. "
32 + "Also it would be inefficient to create a return copy as the byte[] could be large.")
33 public DatastoreSnapshot(@Nonnull String type, @Nullable byte[] shardManagerSnapshot,
34 @Nonnull List<ShardSnapshot> shardSnapshots) {
35 this.type = Preconditions.checkNotNull(type);
36 this.shardManagerSnapshot = shardManagerSnapshot;
37 this.shardSnapshots = ImmutableList.copyOf(Preconditions.checkNotNull(shardSnapshots));
41 public String getType() {
45 @SuppressFBWarnings(value = "EI_EXPOSE_REP", justification = "Exposes a mutable object stored in a field but "
46 + "this is OK since this class is merely a DTO and does not process byte[] internally. "
47 + "Also it would be inefficient to create a return copy as the byte[] could be large.")
49 public byte[] getShardManagerSnapshot() {
50 return shardManagerSnapshot;
54 public List<ShardSnapshot> getShardSnapshots() {
55 return shardSnapshots;
58 public static class ShardSnapshot implements Serializable {
59 private static final long serialVersionUID = 1L;
61 private final String name;
62 private final byte[] snapshot;
64 public ShardSnapshot(@Nonnull String name, @Nonnull byte[] snapshot) {
65 this.name = Preconditions.checkNotNull(name);
66 this.snapshot = Preconditions.checkNotNull(snapshot);
70 public String getName() {
74 @SuppressFBWarnings(value = "EI_EXPOSE_REP", justification = "Exposes a mutable object stored in a field but "
75 + "this is OK since this class is merely a DTO and does not process byte[] internally. "
76 + "Also it would be inefficient to create a return copy as the byte[] could be large.")
78 public byte[] getSnapshot() {