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  * <p>
  21  * This class is not final so concrete actor behavior implementations may subclass it and track more information about
  22  * the backend. The {@link #hashCode()} and {@link #equals(Object)} methods are made final to ensure subclasses compare
  23  * on object identity.
  24  *
  25  * @author Robert Varga
  26  */
  27 public class BackendInfo {
  28     private final ABIVersion version;
  29     private final ActorRef actor;
  30     private final int maxMessages;
  31     private final long sessionId;
  32     private final String name;
  33
  34     protected BackendInfo(final ActorRef actor, final String name, final long sessionId, final ABIVersion version,
  35             final int maxMessages) {
  36         this.version = Preconditions.checkNotNull(version);
  37         this.actor = Preconditions.checkNotNull(actor);
  38         this.name = Preconditions.checkNotNull(name);
  39         Preconditions.checkArgument(maxMessages > 0, "Maximum messages has to be positive, not %s", maxMessages);
  40         this.maxMessages = maxMessages;
  41         this.sessionId = sessionId;
  42     }
  43
  44     public final ActorRef getActor() {
  45         return actor;
  46     }
  47
  48     public final String getName() {
  49         return name;
  50     }
  51
  52     public final ABIVersion getVersion() {
  53         return version;
  54     }
  55
  56     public final int getMaxMessages() {
  57         return maxMessages;
  58     }
  59
  60     public final long getSessionId() {
  61         return sessionId;
  62     }
  63
  64     @Override
  65     public final int hashCode() {
  66         return super.hashCode();
  67     }
  68
  69     @Override
  70     public final boolean equals(final Object obj) {
  71         return super.equals(obj);
  72     }
  73
  74     @Override
  75     public final String toString() {
  76         return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
  77     }
  78
  79     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
  80         return toStringHelper.add("actor", actor).add("sessionId", sessionId).add("version", version)
  81                 .add("maxMessages", maxMessages);
  82     }
  83 }