opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/concepts/MemberName.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 static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Verify.verifyNotNull;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import com.google.common.base.MoreObjects;
  15 import com.google.common.base.Strings;
  16 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  17 import java.io.DataInput;
  18 import java.io.DataOutput;
  19 import java.io.Externalizable;
  20 import java.io.IOException;
  21 import java.io.ObjectInput;
  22 import java.io.ObjectOutput;
  23 import java.nio.charset.StandardCharsets;
  24 import org.eclipse.jdt.annotation.NonNull;
  25 import org.opendaylight.yangtools.concepts.WritableIdentifier;
  26
  27 /**
  28  * Type-safe encapsulation of a cluster member name.
  29  */
  30 public final class MemberName implements Comparable<MemberName>, WritableIdentifier {
  31     interface SerialForm extends Externalizable {
  32         @NonNull MemberName name();
  33
  34         void setName(@NonNull MemberName name);
  35
  36         @java.io.Serial
  37         Object readResolve();
  38
  39         @Override
  40         default void writeExternal(final ObjectOutput out) throws IOException {
  41             final var serialized = name().getSerialized();
  42             out.writeInt(serialized.length);
  43             out.write(serialized);
  44         }
  45
  46         @Override
  47         default void readExternal(final ObjectInput in) throws IOException {
  48             final var serialized = new byte[in.readInt()];
  49             in.readFully(serialized);
  50             // TODO: consider caching instances here
  51             setName(new MemberName(new String(serialized, StandardCharsets.UTF_8), serialized));
  52         }
  53     }
  54
  55     private static final class Proxy implements SerialForm {
  56         @java.io.Serial
  57         private static final long serialVersionUID = 1L;
  58
  59         private MemberName name;
  60
  61         // checkstyle flags the public modifier as redundant however it is explicitly needed for Java serialization to
  62         // be able to create instances via reflection.
  63         @SuppressWarnings("checkstyle:RedundantModifier")
  64         public Proxy() {
  65             // For Externalizable
  66         }
  67
  68         Proxy(final MemberName name) {
  69             this.name = requireNonNull(name);
  70         }
  71
  72         @Override
  73         public MemberName name() {
  74             return verifyNotNull(name);
  75         }
  76
  77         @Override
  78         public void setName(final MemberName name) {
  79             this.name = requireNonNull(name);
  80         }
  81
  82         @Override
  83         public Object readResolve() {
  84             return name();
  85         }
  86     }
  87
  88     @java.io.Serial
  89     private static final long serialVersionUID = 1L;
  90
  91     private final @NonNull String name;
  92
  93     @SuppressFBWarnings(value = "VO_VOLATILE_REFERENCE_TO_ARRAY",
  94             justification = "The array elements are non-volatile but we don't access them.")
  95     private volatile byte[] serialized;
  96
  97     private MemberName(final String name) {
  98         this.name = requireNonNull(name);
  99     }
 100
 101     MemberName(final String name, final byte[] serialized) {
 102         this(name);
 103         this.serialized = verifyNotNull(serialized);
 104     }
 105
 106     public static @NonNull MemberName forName(final String name) {
 107         checkArgument(!Strings.isNullOrEmpty(name));
 108         // TODO: consider caching instances here
 109         return new MemberName(name);
 110     }
 111
 112     public static @NonNull MemberName readFrom(final DataInput in) throws IOException {
 113         final byte[] serialized = new byte[in.readInt()];
 114         in.readFully(serialized);
 115         return new MemberName(new String(serialized, StandardCharsets.UTF_8));
 116     }
 117
 118     @Override
 119     public void writeTo(final DataOutput out) throws IOException {
 120         final byte[] local = getSerialized();
 121         out.writeInt(local.length);
 122         out.write(local);
 123     }
 124
 125     public @NonNull String getName() {
 126         return name;
 127     }
 128
 129     public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.cds.types.rev191024
 130         .@NonNull MemberName toYang() {
 131         return new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.cds.types.rev191024
 132                 .MemberName(name);
 133     }
 134
 135     @Override
 136     public int hashCode() {
 137         return name.hashCode();
 138     }
 139
 140     @Override
 141     public boolean equals(final Object obj) {
 142         return this == obj || obj instanceof MemberName && name.equals(((MemberName)obj).name);
 143     }
 144
 145     @Override
 146     public int compareTo(final MemberName obj) {
 147         return this == obj ? 0 : name.compareTo(obj.name);
 148     }
 149
 150     @Override
 151     public String toString() {
 152         return MoreObjects.toStringHelper(MemberName.class).add("name", name).toString();
 153     }
 154
 155     private byte[] getSerialized() {
 156         byte[] local = serialized;
 157         if (local == null) {
 158             local = name.getBytes(StandardCharsets.UTF_8);
 159             serialized = local;
 160         }
 161         return local;
 162     }
 163
 164     @java.io.Serial
 165     Object writeReplace() {
 166         return new Proxy(this);
 167     }
 168 }