Fix warnings/javadocs in sal-distributed-datastore
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / ShardRecoveryCoordinator.java
1 /*
2  * Copyright (c) 2014 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.datastore;
9
10 import com.google.common.base.Preconditions;
11 import com.google.common.base.Throwables;
12 import java.io.File;
13 import org.opendaylight.controller.cluster.datastore.persisted.ShardDataTreeSnapshot;
14 import org.opendaylight.controller.cluster.datastore.utils.NormalizedNodeXMLOutput;
15 import org.opendaylight.controller.cluster.raft.RaftActorRecoveryCohort;
16 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
17 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
18 import org.slf4j.Logger;
19
20 /**
21  * Coordinates persistence recovery of journal log entries and snapshots for a shard. Each snapshot
22  * and journal log entry batch are de-serialized and applied to their own write transaction
23  * instance in parallel on a thread pool for faster recovery time. However the transactions are
24  * committed to the data store in the order the corresponding snapshot or log batch are received
25  * to preserve data store integrity.
26  *
27  * @author Thomas Pantelis
28  */
29 class ShardRecoveryCoordinator implements RaftActorRecoveryCohort {
30     private final ShardDataTree store;
31     private final String shardName;
32     private final Logger log;
33     private final byte[] restoreFromSnapshot;
34
35     private boolean open;
36
37     ShardRecoveryCoordinator(final ShardDataTree store,  final byte[] restoreFromSnapshot, final String shardName,
38             final Logger log) {
39         this.store = Preconditions.checkNotNull(store);
40         this.shardName = Preconditions.checkNotNull(shardName);
41         this.log = Preconditions.checkNotNull(log);
42
43         this.restoreFromSnapshot = restoreFromSnapshot;
44     }
45
46     @Override
47     public void startLogRecoveryBatch(final int maxBatchSize) {
48         log.debug("{}: starting log recovery batch with max size {}", shardName, maxBatchSize);
49         open = true;
50     }
51
52     @Override
53     @SuppressWarnings("checkstyle:IllegalCatch")
54     public void appendRecoveredLogEntry(final Payload payload) {
55         Preconditions.checkState(open, "call startLogRecovery before calling appendRecoveredLogEntry");
56
57         try {
58             store.applyRecoveryPayload(payload);
59         } catch (Exception e) {
60             log.error("{}: failed to apply payload {}", shardName, payload, e);
61             throw new IllegalStateException(String.format("%s: Failed to apply recovery payload %s",
62                 shardName, payload), e);
63         }
64     }
65
66     /**
67      * Applies the current batched log entries to the data store.
68      */
69     @Override
70     public void applyCurrentLogRecoveryBatch() {
71         Preconditions.checkState(open, "call startLogRecovery before calling applyCurrentLogRecoveryBatch");
72         open = false;
73     }
74
75     private File writeRoot(final String kind, final NormalizedNode<?, ?> node) {
76         final File file = new File(System.getProperty("karaf.data", "."),
77             "failed-recovery-" + kind + "-" + shardName + ".xml");
78         NormalizedNodeXMLOutput.toFile(file, node);
79         return file;
80     }
81
82     /**
83      * Applies a recovered snapshot to the data store.
84      *
85      * @param snapshotBytes the serialized snapshot
86      */
87     @Override
88     @SuppressWarnings("checkstyle:IllegalCatch")
89     public void applyRecoverySnapshot(final byte[] snapshotBytes) {
90         log.debug("{}: Applying recovered snapshot", shardName);
91
92         final ShardDataTreeSnapshot snapshot;
93         try {
94             snapshot = ShardDataTreeSnapshot.deserialize(snapshotBytes);
95         } catch (Exception e) {
96             log.error("{}: failed to deserialize snapshot", shardName, e);
97             throw Throwables.propagate(e);
98         }
99
100         try {
101             store.applyRecoverySnapshot(snapshot);
102         } catch (Exception e) {
103             final File f = writeRoot("snapshot", snapshot.getRootNode().orElse(null));
104             throw new IllegalStateException(String.format(
105                     "%s: Failed to apply recovery snapshot %s. Node data was written to file %s",
106                     shardName, snapshot, f), e);
107         }
108     }
109
110     @Override
111     public byte[] getRestoreFromSnapshot() {
112         return restoreFromSnapshot;
113     }
114 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.