opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/commands/ConnectClientRequest.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 static java.util.Objects.requireNonNull;
  11
  12 import akka.actor.ActorRef;
  13 import com.google.common.base.MoreObjects.ToStringHelper;
  14 import java.io.DataInput;
  15 import java.io.IOException;
  16 import java.io.ObjectInput;
  17 import java.io.ObjectOutput;
  18 import org.opendaylight.controller.cluster.access.ABIVersion;
  19 import org.opendaylight.controller.cluster.access.concepts.ClientIdentifier;
  20 import org.opendaylight.controller.cluster.access.concepts.Request;
  21 import org.opendaylight.controller.cluster.access.concepts.RequestException;
  22
  23 /**
  24  * Request to connect a frontend instance to the backend. It carries basic information about the frontend:
  25  * - its coordinates in {@link #getReplyTo()}.
  26  * - its minimum supported ABI version
  27  * - its maximum supported ABI version
  28  *
  29  * <p>
  30  * It also includes request stream sequencing information.
  31  */
  32 public final class ConnectClientRequest extends Request<ClientIdentifier, ConnectClientRequest> {
  33     interface SerialForm extends Request.SerialForm<ClientIdentifier, ConnectClientRequest> {
  34         @Override
  35         default ConnectClientRequest readExternal(final ObjectInput in, final ClientIdentifier target,
  36                 final long sequence, final ActorRef replyTo) throws IOException {
  37             return new ConnectClientRequest(target, sequence, replyTo, ABIVersion.inexactReadFrom(in),
  38                 ABIVersion.inexactReadFrom(in));
  39         }
  40
  41         @Override
  42         default ClientIdentifier readTarget(final DataInput in) throws IOException {
  43             return ClientIdentifier.readFrom(in);
  44         }
  45
  46         @Override
  47         default void writeExternal(final ObjectOutput out, final ConnectClientRequest msg) throws IOException {
  48             Request.SerialForm.super.writeExternal(out, msg);
  49             msg.getMinVersion().writeTo(out);
  50             msg.getMaxVersion().writeTo(out);
  51         }
  52     }
  53
  54     @java.io.Serial
  55     private static final long serialVersionUID = 1L;
  56
  57     private final ABIVersion minVersion;
  58     private final ABIVersion maxVersion;
  59
  60     ConnectClientRequest(final ClientIdentifier identifier, final long txSequence, final ActorRef replyTo,
  61             final ABIVersion minVersion, final ABIVersion maxVersion) {
  62         super(identifier, txSequence, replyTo);
  63         this.minVersion = requireNonNull(minVersion);
  64         this.maxVersion = requireNonNull(maxVersion);
  65     }
  66
  67     public ConnectClientRequest(final ClientIdentifier identifier, final ActorRef replyTo, final ABIVersion minVersion,
  68             final ABIVersion maxVersion) {
  69         this(identifier, 0, replyTo, minVersion, maxVersion);
  70     }
  71
  72     private ConnectClientRequest(final ConnectClientRequest request, final ABIVersion version) {
  73         super(request, version);
  74         minVersion = request.minVersion;
  75         maxVersion = request.maxVersion;
  76     }
  77
  78     public ABIVersion getMinVersion() {
  79         return minVersion;
  80     }
  81
  82     public ABIVersion getMaxVersion() {
  83         return maxVersion;
  84     }
  85
  86     @Override
  87     public ConnectClientFailure toRequestFailure(final RequestException cause) {
  88         return new ConnectClientFailure(getTarget(), getSequence(), cause);
  89     }
  90
  91     @Override
  92     protected SerialForm externalizableProxy(final ABIVersion version) {
  93         return new CCR(this);
  94     }
  95
  96     @Override
  97     protected ConnectClientRequest cloneAsVersion(final ABIVersion version) {
  98         return new ConnectClientRequest(this, version);
  99     }
 100
 101     @Override
 102     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 103         return super.addToStringAttributes(toStringHelper).add("minVersion", minVersion).add("maxVersion", maxVersion);
 104     }
 105 }