Fix FindBugs warnings in sal-akk-raft
[controller.git] / opendaylight / md-sal / cds-access-api / src / main / java / org / opendaylight / controller / cluster / access / concepts / FrontendIdentifier.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.concepts;
9
10 import com.google.common.annotations.Beta;
11 import com.google.common.base.Preconditions;
12 import java.io.DataInput;
13 import java.io.DataOutput;
14 import java.io.Externalizable;
15 import java.io.IOException;
16 import java.io.ObjectInput;
17 import java.io.ObjectOutput;
18 import java.util.Objects;
19 import org.opendaylight.yangtools.concepts.WritableIdentifier;
20
21 /**
22  * A cluster-wide unique identifier of a frontend type located at a cluster member.
23  *
24  * @author Robert Varga
25  */
26 @Beta
27 public final class FrontendIdentifier implements WritableIdentifier {
28     private static final class Proxy implements Externalizable {
29         private static final long serialVersionUID = 1L;
30         private MemberName memberName;
31         private FrontendType clientType;
32
33         public Proxy() {
34             // Needed for Externalizable
35         }
36
37         Proxy(final MemberName memberName, final FrontendType clientType) {
38             this.memberName = Preconditions.checkNotNull(memberName);
39             this.clientType = Preconditions.checkNotNull(clientType);
40         }
41
42         @Override
43         public void writeExternal(final ObjectOutput out) throws IOException {
44             memberName.writeTo(out);
45             clientType.writeTo(out);
46         }
47
48         @Override
49         public void readExternal(final ObjectInput in) throws IOException {
50             memberName = MemberName.readFrom(in);
51             clientType = FrontendType.readFrom(in);
52         }
53
54         private Object readResolve() {
55             return new FrontendIdentifier(memberName, clientType);
56         }
57     }
58
59     private static final long serialVersionUID = 1L;
60     private final MemberName memberName;
61     private final FrontendType clientType;
62
63     FrontendIdentifier(final MemberName memberName, final FrontendType clientType) {
64         this.clientType = Preconditions.checkNotNull(clientType);
65         this.memberName = Preconditions.checkNotNull(memberName);
66     }
67
68     public static FrontendIdentifier create(final MemberName memberName, final FrontendType clientType) {
69         return new FrontendIdentifier(memberName, clientType);
70     }
71
72     public static FrontendIdentifier readFrom(final DataInput in) throws IOException {
73         final MemberName memberName = MemberName.readFrom(in);
74         final FrontendType clientType = FrontendType.readFrom(in);
75         return new FrontendIdentifier(memberName, clientType);
76     }
77
78     @Override
79     public void writeTo(final DataOutput out) throws IOException {
80         memberName.writeTo(out);
81         clientType.writeTo(out);
82     }
83
84     public FrontendType getClientType() {
85         return clientType;
86     }
87
88     public MemberName getMemberName() {
89         return memberName;
90     }
91
92     @Override
93     public int hashCode() {
94         return Objects.hash(memberName, clientType);
95     }
96
97     @Override
98     public boolean equals(final Object o) {
99         if (this == o) {
100             return true;
101         }
102         if (!(o instanceof FrontendIdentifier)) {
103             return false;
104         }
105
106         final FrontendIdentifier other = (FrontendIdentifier) o;
107         return memberName.equals(other.memberName) && clientType.equals(other.clientType);
108     }
109
110     public String toPersistentId() {
111         return memberName.getName() + "-frontend-" + clientType.getName();
112     }
113
114     @Override
115     public String toString() {
116         return toPersistentId();
117     }
118
119     private Object writeReplace() {
120         return new Proxy(memberName, clientType);
121     }
122 }