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 org.opendaylight.controller.cluster.access.ABIVersion;
  15 import org.opendaylight.controller.cluster.access.concepts.AbstractRequestProxy;
  16 import org.opendaylight.controller.cluster.access.concepts.ClientIdentifier;
  17 import org.opendaylight.controller.cluster.access.concepts.Request;
  18 import org.opendaylight.controller.cluster.access.concepts.RequestException;
  19
  20 /**
  21  * Request to connect a frontend instance to the backend. It carries basic information about the frontend:
  22  * - its coordinates in {@link #getReplyTo()}.
  23  * - its minimum supported ABI version
  24  * - its maximum supported ABI version
  25  *
  26  * <p>
  27  * It also includes request stream sequencing information.
  28  */
  29 public final class ConnectClientRequest extends Request<ClientIdentifier, ConnectClientRequest> {
  30     private static final long serialVersionUID = 1L;
  31
  32     private final ABIVersion minVersion;
  33     private final ABIVersion maxVersion;
  34
  35     ConnectClientRequest(final ClientIdentifier identifier, final long txSequence, final ActorRef replyTo,
  36             final ABIVersion minVersion, final ABIVersion maxVersion) {
  37         super(identifier, txSequence, replyTo);
  38         this.minVersion = requireNonNull(minVersion);
  39         this.maxVersion = requireNonNull(maxVersion);
  40     }
  41
  42     public ConnectClientRequest(final ClientIdentifier identifier, final ActorRef replyTo, final ABIVersion minVersion,
  43             final ABIVersion maxVersion) {
  44         this(identifier, 0, replyTo, minVersion, maxVersion);
  45     }
  46
  47     private ConnectClientRequest(final ConnectClientRequest request, final ABIVersion version) {
  48         super(request, version);
  49         minVersion = request.minVersion;
  50         maxVersion = request.maxVersion;
  51     }
  52
  53     public ABIVersion getMinVersion() {
  54         return minVersion;
  55     }
  56
  57     public ABIVersion getMaxVersion() {
  58         return maxVersion;
  59     }
  60
  61     @Override
  62     public ConnectClientFailure toRequestFailure(final RequestException cause) {
  63         return new ConnectClientFailure(getTarget(), getSequence(), cause);
  64     }
  65
  66     @Override
  67     protected AbstractRequestProxy<ClientIdentifier, ConnectClientRequest> externalizableProxy(
  68             final ABIVersion version) {
  69         return new ConnectClientRequestProxyV1(this);
  70     }
  71
  72     @Override
  73     protected ConnectClientRequest cloneAsVersion(final ABIVersion version) {
  74         return new ConnectClientRequest(this, version);
  75     }
  76
  77     @Override
  78     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
  79         return super.addToStringAttributes(toStringHelper).add("minVersion", minVersion).add("maxVersion", maxVersion);
  80     }
  81 }