opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/BackendInfo.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.client;
   9
  10 import akka.actor.ActorRef;
  11 import com.google.common.base.MoreObjects;
  12 import com.google.common.base.MoreObjects.ToStringHelper;
  13 import com.google.common.base.Preconditions;
  14 import org.opendaylight.controller.cluster.access.ABIVersion;
  15
  16 /**
  17  * Basic information about how to talk to the backend. ClientActorBehavior uses this information to dispatch requests
  18  * to the backend.
  19  *
  20  * This class is not final so concrete actor behavior implementations may subclass it and track more information about
  21  * the backend. The {@link #hashCode()} and {@link #equals(Object)} methods are made final to ensure subclasses compare
  22  * on identity.
  23  *
  24  * @author Robert Varga
  25  */
  26 public class BackendInfo {
  27     private final ABIVersion version;
  28     private final ActorRef actor;
  29     private final int maxMessages;
  30     private final long sessionId;
  31
  32     protected BackendInfo(final ActorRef actor, final long sessionId, final ABIVersion version, final int maxMessages) {
  33         this.version = Preconditions.checkNotNull(version);
  34         this.actor = Preconditions.checkNotNull(actor);
  35         Preconditions.checkArgument(maxMessages > 0, "Maximum messages has to be positive, not %s", maxMessages);
  36         this.maxMessages = maxMessages;
  37         this.sessionId = sessionId;
  38     }
  39
  40     public final ActorRef getActor() {
  41         return actor;
  42     }
  43
  44     public final ABIVersion getVersion() {
  45         return version;
  46     }
  47
  48     public final int getMaxMessages() {
  49         return maxMessages;
  50     }
  51
  52     public final long getSessionId() {
  53         return sessionId;
  54     }
  55
  56     @Override
  57     public final int hashCode() {
  58         return super.hashCode();
  59     }
  60
  61     @Override
  62     public final boolean equals(final Object obj) {
  63         return super.equals(obj);
  64     }
  65
  66     @Override
  67     public final String toString() {
  68         return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
  69     }
  70
  71     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
  72         return toStringHelper.add("actor", actor).add("sessionId", sessionId).add("version", version)
  73                 .add("maxMessages", maxMessages);
  74     }
  75 }