opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/concepts/RequestException.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 static java.util.Objects.requireNonNull;
  11
  12 import java.io.Serial;
  13 import org.eclipse.jdt.annotation.NonNull;
  14
  15 /**
  16  * A failure cause behind a {@link RequestFailure} to process a {@link Request}.
  17  */
  18 public abstract class RequestException extends Exception {
  19     @Serial
  20     private static final long serialVersionUID = 1L;
  21
  22     protected RequestException(final @NonNull String message) {
  23         super(requireNonNull(message));
  24     }
  25
  26     protected RequestException(final @NonNull String message, final @NonNull Throwable cause) {
  27         super(requireNonNull(message), requireNonNull(cause));
  28     }
  29
  30     public abstract boolean isRetriable();
  31
  32     /**
  33      * Unwraps the underlying failure. This method is overridden only in {@link RuntimeRequestException}.
  34      *
  35      * @return Underlying cause of the failure if exception is a {@link RuntimeRequestException}, or the exception
  36      *         itself.
  37      */
  38     public Throwable unwrap() {
  39         return this;
  40     }
  41 }