opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/concepts/RequestFailure.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.concepts;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.base.MoreObjects.ToStringHelper;
  12 import com.google.common.base.Preconditions;
  13 import javax.annotation.Nonnull;
  14 import org.opendaylight.controller.cluster.access.ABIVersion;
  15 import org.opendaylight.yangtools.concepts.WritableIdentifier;
  16
  17 /**
  18  * A failure response to a {@link Request}. Contains a {@link RequestException} detailing the cause for this failure.
  19  *
  20  * @author Robert Varga
  21  *
  22  * @param <T> Target identifier type
  23  * @param <C> Message class
  24  */
  25 @Beta
  26 public abstract class RequestFailure<T extends WritableIdentifier, C extends RequestFailure<T, C>>
  27         extends Response<T, C> {
  28     private static final long serialVersionUID = 1L;
  29     private final RequestException cause;
  30
  31     protected RequestFailure(@Nonnull final C failure, @Nonnull final ABIVersion version) {
  32         super(failure, version);
  33         this.cause = Preconditions.checkNotNull(failure.getCause());
  34     }
  35
  36     protected RequestFailure(@Nonnull final T target, final long sequence, @Nonnull final RequestException cause) {
  37         super(target, sequence);
  38         this.cause = Preconditions.checkNotNull(cause);
  39     }
  40
  41     /**
  42      * Return the failure cause.
  43      *
  44      * @return Failure cause.
  45      */
  46     @Nonnull
  47     public final RequestException getCause() {
  48         return cause;
  49     }
  50
  51     /**
  52      * Return an indication of whether this a hard failure. Hard failures must not be retried but need to be treated
  53      * as authoritative response to a request.
  54      *
  55      * @return True if this represents a hard failure, false otherwise.
  56      */
  57     public final boolean isHardFailure() {
  58         return !cause.isRetriable();
  59     }
  60
  61     @Override
  62     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
  63         return super.addToStringAttributes(toStringHelper).add("cause", cause);
  64     }
  65
  66     @Override
  67     protected abstract AbstractRequestFailureProxy<T, C> externalizableProxy(@Nonnull ABIVersion version);
  68 }