opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/ReadyLocalTransactionSerializer.java

   1 /*
   2  * Copyright (c) 2015 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.messages;
   9
  10 import akka.serialization.JSerializer;
  11 import com.google.common.base.Optional;
  12 import com.google.common.base.Preconditions;
  13 import java.util.ArrayDeque;
  14 import java.util.Deque;
  15 import javax.annotation.Nonnull;
  16 import org.apache.commons.lang3.SerializationUtils;
  17 import org.opendaylight.controller.cluster.datastore.DataStoreVersions;
  18 import org.opendaylight.controller.cluster.datastore.modification.DeleteModification;
  19 import org.opendaylight.controller.cluster.datastore.modification.MergeModification;
  20 import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
  21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  23 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  24 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModificationCursor;
  25
  26 /**
  27  * Specialized message transformer, which transforms a {@link ReadyLocalTransaction}
  28  * into a {@link BatchedModifications} message. This serializer needs to be plugged
  29  * into akka serialization to allow forwarding of ReadyLocalTransaction to remote
  30  * shards.
  31  */
  32 public final class ReadyLocalTransactionSerializer extends JSerializer {
  33     @Override
  34     public int identifier() {
  35         return 97439437;
  36     }
  37
  38     @Override
  39     public boolean includeManifest() {
  40         return false;
  41     }
  42
  43     @Override
  44     public byte[] toBinary(final Object obj) {
  45         Preconditions.checkArgument(obj instanceof ReadyLocalTransaction, "Unsupported object type %s", obj.getClass());
  46         final ReadyLocalTransaction msg = (ReadyLocalTransaction) obj;
  47         final BatchedModifications batched = new BatchedModifications(msg.getTransactionID(),
  48                 DataStoreVersions.CURRENT_VERSION, "");
  49         batched.setDoCommitOnReady(msg.isDoCommitOnReady());
  50         batched.setReady(true);
  51
  52         msg.getModification().applyToCursor(new BatchedCursor(batched));
  53
  54         return SerializationUtils.serialize(batched);
  55     }
  56
  57     @Override
  58     public Object fromBinaryJava(final byte[] bytes, final Class<?> clazz) {
  59         return SerializationUtils.deserialize(bytes);
  60     }
  61
  62     private static final class BatchedCursor implements DataTreeModificationCursor {
  63         private final Deque<YangInstanceIdentifier> stack = new ArrayDeque<>();
  64         private final BatchedModifications message;
  65
  66         BatchedCursor(final BatchedModifications message) {
  67             this.message = Preconditions.checkNotNull(message);
  68             stack.push(YangInstanceIdentifier.EMPTY);
  69         }
  70
  71         @Override
  72         public void delete(final PathArgument child) {
  73             message.addModification(new DeleteModification(stack.peek().node(child)));
  74         }
  75
  76         @Override
  77         public void merge(final PathArgument child, final NormalizedNode<?, ?> data) {
  78             message.addModification(new MergeModification(stack.peek().node(child), data));
  79         }
  80
  81         @Override
  82         public void write(final PathArgument child, final NormalizedNode<?, ?> data) {
  83             message.addModification(new WriteModification(stack.peek().node(child), data));
  84         }
  85
  86         @Override
  87         public void enter(@Nonnull final PathArgument child) {
  88             stack.push(stack.peek().node(child));
  89         }
  90
  91         @Override
  92         public void enter(@Nonnull final PathArgument... path) {
  93             for (PathArgument arg : path) {
  94                 enter(arg);
  95             }
  96         }
  97
  98         @Override
  99         public void enter(@Nonnull final Iterable<PathArgument> path) {
 100             for (PathArgument arg : path) {
 101                 enter(arg);
 102             }
 103         }
 104
 105         @Override
 106         public void exit() {
 107             stack.pop();
 108         }
 109
 110         @Override
 111         public void exit(final int depth) {
 112             Preconditions.checkArgument(depth < stack.size(), "Stack holds only %s elements, cannot exit %s levels", stack.size(), depth);
 113             for (int i = 0; i < depth; ++i) {
 114                 stack.pop();
 115             }
 116         }
 117
 118         @Override
 119         public Optional<NormalizedNode<?, ?>> readNode(@Nonnull final PathArgument child) {
 120             throw new UnsupportedOperationException("Not implemented");
 121         }
 122
 123         @Override
 124         public void close() {
 125             // No-op
 126         }
 127     }
 128 }