2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.access.commands;
10 import akka.actor.ActorRef;
11 import com.google.common.annotations.Beta;
12 import com.google.common.base.MoreObjects.ToStringHelper;
13 import com.google.common.base.Preconditions;
14 import javax.annotation.Nonnull;
15 import org.opendaylight.controller.cluster.access.ABIVersion;
16 import org.opendaylight.controller.cluster.access.concepts.AbstractRequestProxy;
17 import org.opendaylight.controller.cluster.access.concepts.ClientIdentifier;
18 import org.opendaylight.controller.cluster.access.concepts.Request;
19 import org.opendaylight.controller.cluster.access.concepts.RequestException;
22 * Request to connect a frontend instance to the backend. It carries basic information about the frontend:
23 * - its coordinates in {@link #getReplyTo()}.
24 * - its minimum supported ABI version
25 * - its maximum supported ABI version
28 * It also includes request stream sequencing information.
30 * @author Robert Varga
33 public final class ConnectClientRequest extends Request<ClientIdentifier, ConnectClientRequest> {
34 private static final long serialVersionUID = 1L;
36 private final ABIVersion minVersion;
37 private final ABIVersion maxVersion;
39 ConnectClientRequest(final ClientIdentifier identifier, final long txSequence, final ActorRef replyTo,
40 final ABIVersion minVersion, final ABIVersion maxVersion) {
41 super(identifier, txSequence, replyTo);
42 this.minVersion = Preconditions.checkNotNull(minVersion);
43 this.maxVersion = Preconditions.checkNotNull(maxVersion);
46 public ConnectClientRequest(final ClientIdentifier identifier, final ActorRef replyTo, final ABIVersion minVersion,
47 final ABIVersion maxVersion) {
48 this(identifier, 0, replyTo, minVersion, maxVersion);
51 private ConnectClientRequest(final ConnectClientRequest request, final ABIVersion version) {
52 super(request, version);
53 this.minVersion = request.minVersion;
54 this.maxVersion = request.maxVersion;
57 public ABIVersion getMinVersion() {
61 public ABIVersion getMaxVersion() {
66 public ConnectClientFailure toRequestFailure(final RequestException cause) {
67 return new ConnectClientFailure(getTarget(), getSequence(), cause);
71 protected AbstractRequestProxy<ClientIdentifier, ConnectClientRequest> externalizableProxy(
72 final ABIVersion version) {
73 return new ConnectClientRequestProxyV1(this);
77 protected ConnectClientRequest cloneAsVersion(final ABIVersion version) {
78 return new ConnectClientRequest(this, version);
83 protected ToStringHelper addToStringAttributes(@Nonnull final ToStringHelper toStringHelper) {
84 return super.addToStringAttributes(toStringHelper).add("minVersion", minVersion).add("maxVersion", maxVersion);