BUG-5280: introduce base Transaction request/success
[controller.git] / opendaylight / md-sal / cds-access-api / src / main / java / org / opendaylight / controller / cluster / access / commands / AbstractReadTransactionRequestProxyV1.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.access.commands;
9
10 import akka.actor.ActorRef;
11 import java.io.IOException;
12 import java.io.ObjectInput;
13 import java.io.ObjectOutput;
14 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
15 import org.opendaylight.controller.cluster.datastore.node.utils.stream.NormalizedNodeDataOutput;
16 import org.opendaylight.controller.cluster.datastore.node.utils.stream.NormalizedNodeInputOutput;
17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
18
19 /**
20  * Abstract base class for serialization proxies associated with {@link AbstractReadTransactionRequest}s. It implements
21  * the initial (Boron) serialization format.
22  *
23  * @author Robert Varga
24  *
25  * @param <T> Message type
26  */
27 abstract class AbstractReadTransactionRequestProxyV1<T extends AbstractReadTransactionRequest<T>> extends AbstractTransactionRequestProxy<T> {
28     private static final long serialVersionUID = 1L;
29     private YangInstanceIdentifier path;
30
31     AbstractReadTransactionRequestProxyV1() {
32         // For Externalizable
33     }
34
35     AbstractReadTransactionRequestProxyV1(final T request) {
36         super(request);
37     }
38
39     @Override
40     public final void writeExternal(final ObjectOutput out) throws IOException {
41         super.writeExternal(out);
42         try (NormalizedNodeDataOutput nnout = NormalizedNodeInputOutput.newDataOutput(out)) {
43             nnout.writeYangInstanceIdentifier(path);
44         }
45     }
46
47     @Override
48     public final void readExternal(final ObjectInput in) throws ClassNotFoundException, IOException {
49         super.readExternal(in);
50         path = NormalizedNodeInputOutput.newDataInput(in).readYangInstanceIdentifier();
51     }
52
53     @Override
54     protected final T createRequest(final TransactionIdentifier target, final long sequence, final long retry,
55             final ActorRef replyTo) {
56         return createReadRequest(target, sequence, retry, replyTo, path);
57     }
58
59     abstract T createReadRequest(TransactionIdentifier target, long sequence, long retry, ActorRef replyTo,
60             YangInstanceIdentifier path);
61 }