Fix CS warnings in cds-access-api and enable enforcement
[controller.git] / opendaylight / md-sal / cds-access-api / src / main / java / org / opendaylight / controller / cluster / access / commands / ConnectClientSuccessProxyV1.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 akka.actor.ActorSelection;
12 import akka.serialization.JavaSerializer;
13 import akka.serialization.Serialization;
14 import java.io.DataInput;
15 import java.io.IOException;
16 import java.io.ObjectInput;
17 import java.io.ObjectOutput;
18 import java.util.ArrayList;
19 import java.util.List;
20 import java.util.Optional;
21 import org.opendaylight.controller.cluster.access.concepts.AbstractSuccessProxy;
22 import org.opendaylight.controller.cluster.access.concepts.ClientIdentifier;
23
24 /**
25  * Externalizable proxy for use with {@link ConnectClientSuccess}. It implements the initial (Boron) serialization
26  * format.
27  *
28  * @author Robert Varga
29  */
30 final class ConnectClientSuccessProxyV1 extends AbstractSuccessProxy<ClientIdentifier, ConnectClientSuccess> {
31     private static final long serialVersionUID = 1L;
32
33     private List<ActorSelection> alternates;
34     private ActorRef backend;
35     private int maxMessages;
36
37     // checkstyle flags the public modifier as redundant however it is explicitly needed for Java serialization to
38     // be able to create instances via reflection.
39     @SuppressWarnings("checkstyle:RedundantModifier")
40     public ConnectClientSuccessProxyV1() {
41         // For Externalizable
42     }
43
44     ConnectClientSuccessProxyV1(final ConnectClientSuccess success) {
45         super(success);
46         this.alternates = success.getAlternates();
47         this.backend = success.getBackend();
48         this.maxMessages = success.getMaxMessages();
49         // We are ignoring the DataTree, it is not serializable anyway
50     }
51
52     @Override
53     public void writeExternal(final ObjectOutput out) throws IOException {
54         super.writeExternal(out);
55
56         out.writeObject(Serialization.serializedActorPath(backend));
57         out.writeInt(maxMessages);
58
59         out.writeInt(alternates.size());
60         for (ActorSelection b : alternates) {
61             out.writeObject(b.toSerializationFormat());
62         }
63     }
64
65     @Override
66     public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
67         super.readExternal(in);
68
69         backend = JavaSerializer.currentSystem().value().provider().resolveActorRef((String) in.readObject());
70         maxMessages = in.readInt();
71
72         final int alternatesSize = in.readInt();
73         alternates = new ArrayList<>(alternatesSize);
74         for (int i = 0; i < alternatesSize; ++i) {
75             alternates.add(ActorSelection.apply(ActorRef.noSender(), (String)in.readObject()));
76         }
77     }
78
79     @Override
80     protected ConnectClientSuccess createSuccess(final ClientIdentifier target, final long sequence) {
81         return new ConnectClientSuccess(target, sequence, backend, alternates, Optional.empty(), maxMessages);
82     }
83
84     @Override
85     protected ClientIdentifier readTarget(final DataInput in) throws IOException {
86         return ClientIdentifier.readFrom(in);
87     }
88 }