opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/concepts/Request.java

   1 /*
   2  * Copyright (c) 2016, 2017 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.concepts;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import akka.actor.ActorRef;
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.base.MoreObjects.ToStringHelper;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.controller.cluster.access.ABIVersion;
  17 import org.opendaylight.yangtools.concepts.WritableIdentifier;
  18
  19 /**
  20  * A request message concept. Upon receipt of this message, the recipient will respond with either
  21  * a {@link RequestSuccess} or a {@link RequestFailure} message.
  22  *
  23  * @author Robert Varga
  24  *
  25  * @param <T> Target identifier type
  26  * @param <C> Message type
  27  */
  28 @Beta
  29 public abstract class Request<T extends WritableIdentifier, C extends Request<T, C>> extends Message<T, C> {
  30     private static final long serialVersionUID = 1L;
  31     private final @NonNull ActorRef replyTo;
  32
  33     protected Request(final @NonNull T target, final long sequence, final @NonNull ActorRef replyTo) {
  34         super(target, sequence);
  35         this.replyTo = requireNonNull(replyTo);
  36     }
  37
  38     protected Request(final @NonNull C request, final @NonNull ABIVersion version) {
  39         super(request, version);
  40         this.replyTo = requireNonNull(request.getReplyTo());
  41     }
  42
  43     /**
  44      * Return the return address where responses to this request should be directed to.
  45      *
  46      * @return Original requestor
  47      */
  48     public final @NonNull ActorRef getReplyTo() {
  49         return replyTo;
  50     }
  51
  52     /**
  53      * Return a {@link RequestFailure} for this request, caused by a {@link RequestException}.
  54      *
  55      * @param cause Failure cause
  56      * @return {@link RequestFailure} corresponding to this request
  57      */
  58     public abstract @NonNull RequestFailure<T, ?> toRequestFailure(@NonNull RequestException cause);
  59
  60     @Override
  61     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
  62         return super.addToStringAttributes(toStringHelper).add("replyTo", replyTo);
  63     }
  64
  65     @Override
  66     protected abstract AbstractRequestProxy<T, C> externalizableProxy(ABIVersion version);
  67 }