restconf/restconf-common/src/main/java/org/opendaylight/restconf/common/errors/RestconfDocumentedException.java

   1 /*
   2  * Copyright (c) 2014 Brocade Communications 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.restconf.common.errors;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.collect.ImmutableList;
  13 import java.util.ArrayList;
  14 import java.util.Collection;
  15 import java.util.List;
  16 import javax.ws.rs.WebApplicationException;
  17 import javax.ws.rs.core.Response.Status;
  18 import org.eclipse.jdt.annotation.NonNull;
  19 import org.eclipse.jdt.annotation.Nullable;
  20 import org.opendaylight.restconf.common.errors.RestconfError.ErrorTag;
  21 import org.opendaylight.yangtools.yang.common.ErrorType;
  22 import org.opendaylight.yangtools.yang.common.OperationFailedException;
  23 import org.opendaylight.yangtools.yang.common.RpcError;
  24 import org.opendaylight.yangtools.yang.common.YangError;
  25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  26 import org.opendaylight.yangtools.yang.data.api.codec.YangInvalidValueException;
  27
  28 /**
  29  * Unchecked exception to communicate error information, as defined in the ietf restcong draft, to be sent to the
  30  * client.
  31  *
  32  * <p>
  33  * See also <a href="https://tools.ietf.org/html/draft-bierman-netconf-restconf-02">RESTCONF</a>
  34  *
  35  * @author Devin Avery
  36  * @author Thomas Pantelis
  37  */
  38 public class RestconfDocumentedException extends WebApplicationException {
  39
  40     private static final long serialVersionUID = 1L;
  41
  42     private final ImmutableList<RestconfError> errors;
  43     private final Status status;
  44
  45     /**
  46      * Constructs an instance with an error message. The error type defaults to APPLICATION and the error tag defaults
  47      * to OPERATION_FAILED.
  48      *
  49      * @param message
  50      *            A string which provides a plain text string describing the error.
  51      */
  52     public RestconfDocumentedException(final String message) {
  53         this(message, ErrorType.APPLICATION, RestconfError.ErrorTag.OPERATION_FAILED);
  54     }
  55
  56     /**
  57      * Constructs an instance with an error message, error type, error tag and exception cause.
  58      *
  59      * @param message
  60      *            A string which provides a plain text string describing the error.
  61      * @param errorType
  62      *            The enumerated type indicating the layer where the error occurred.
  63      * @param errorTag
  64      *            The enumerated tag representing a more specific error cause.
  65      * @param cause
  66      *            The underlying exception cause.
  67      */
  68     public RestconfDocumentedException(final String message, final ErrorType errorType, final ErrorTag errorTag,
  69                                        final Throwable cause) {
  70         this(cause, new RestconfError(errorType, errorTag, message, null, cause.getMessage(), null));
  71     }
  72
  73     /**
  74      * Constructs an instance with an error message, error type, and error tag.
  75      *
  76      * @param message
  77      *            A string which provides a plain text string describing the error.
  78      * @param errorType
  79      *            The enumerated type indicating the layer where the error occurred.
  80      * @param errorTag
  81      *            The enumerated tag representing a more specific error cause.
  82      */
  83     public RestconfDocumentedException(final String message, final ErrorType errorType, final ErrorTag errorTag) {
  84         this(null, new RestconfError(errorType, errorTag, message));
  85     }
  86
  87     /**
  88      * Constructs an instance with an error message, error type, error tag and error path.
  89      *
  90      * @param message
  91      *            A string which provides a plain text string describing the error.
  92      * @param errorType
  93      *            The enumerated type indicating the layer where the error occurred.
  94      * @param errorTag
  95      *            The enumerated tag representing a more specific error cause.
  96      * @param errorPath
  97      *            The instance identifier representing error path
  98      */
  99     public RestconfDocumentedException(final String message, final ErrorType errorType, final ErrorTag errorTag,
 100                                        final YangInstanceIdentifier errorPath) {
 101         this(null, new RestconfError(errorType, errorTag, message, errorPath));
 102     }
 103
 104     /**
 105      * Constructs an instance with an error message and exception cause.
 106      * The underlying exception is included in the error-info.
 107      *
 108      * @param message
 109      *            A string which provides a plain text string describing the error.
 110      * @param cause
 111      *            The underlying exception cause.
 112      */
 113     public RestconfDocumentedException(final String message, final Throwable cause) {
 114         this(cause, new RestconfError(ErrorType.APPLICATION, RestconfError.ErrorTag.OPERATION_FAILED,
 115                 message, null, cause.getMessage(), null));
 116     }
 117
 118     /**
 119      * Constructs an instance with the given error.
 120      */
 121     public RestconfDocumentedException(final RestconfError error) {
 122         this(null, error);
 123     }
 124
 125     /**
 126      * Constructs an instance with the given errors.
 127      */
 128     public RestconfDocumentedException(final String message, final Throwable cause, final List<RestconfError> errors) {
 129         // FIXME: We override getMessage so supplied message is lost for any public access
 130         // this was lost also in original code.
 131         super(cause);
 132         if (!errors.isEmpty()) {
 133             this.errors = ImmutableList.copyOf(errors);
 134         } else {
 135             this.errors = ImmutableList.of(new RestconfError(ErrorType.APPLICATION,
 136                     RestconfError.ErrorTag.OPERATION_FAILED, message));
 137         }
 138
 139         status = null;
 140     }
 141
 142     /**
 143      * Constructs an instance with the given RpcErrors.
 144      */
 145     public RestconfDocumentedException(final String message, final Throwable cause,
 146                                        final Collection<? extends RpcError> rpcErrors) {
 147         this(message, cause, convertToRestconfErrors(rpcErrors));
 148     }
 149
 150     /**
 151      * Constructs an instance with an HTTP status and no error information.
 152      *
 153      * @param status
 154      *            the HTTP status.
 155      */
 156     public RestconfDocumentedException(final Status status) {
 157         errors = ImmutableList.of();
 158         this.status = requireNonNull(status, "Status can't be null");
 159     }
 160
 161     public RestconfDocumentedException(final Throwable cause, final RestconfError error) {
 162         super(cause, error.getErrorTag().getStatusCode());
 163         errors = ImmutableList.of(error);
 164         status = null;
 165     }
 166
 167     public static RestconfDocumentedException decodeAndThrow(final String message,
 168             final OperationFailedException cause) {
 169         for (final RpcError error : cause.getErrorList()) {
 170             if (error.getErrorType() == RpcError.ErrorType.TRANSPORT
 171                     && error.getTag().equals(ErrorTag.RESOURCE_DENIED.getTagValue())) {
 172                 throw new RestconfDocumentedException(error.getMessage(), ErrorType.TRANSPORT,
 173                     ErrorTag.RESOURCE_DENIED_TRANSPORT, cause);
 174             }
 175         }
 176         throw new RestconfDocumentedException(message, cause, cause.getErrorList());
 177     }
 178
 179     /**
 180      * Throw an instance of this exception if an expression evaluates to true. If the expression evaluates to false,
 181      * this method does nothing.
 182      *
 183      * @param expression Expression to be evaluated
 184      * @param errorType The enumerated type indicating the layer where the error occurred.
 185      * @param errorTag The enumerated tag representing a more specific error cause.
 186      * @param format Format string, according to {@link String#format(String, Object...)}.
 187      * @param args Format string arguments, according to {@link String#format(String, Object...)}
 188      * @throws RestconfDocumentedException if the expression evaluates to true.
 189      */
 190     public static void throwIf(final boolean expression, final ErrorType errorType, final ErrorTag errorTag,
 191             final @NonNull String format, final Object... args) {
 192         if (expression) {
 193             throw new RestconfDocumentedException(String.format(format, args), errorType, errorTag);
 194         }
 195     }
 196
 197     /**
 198      * Throw an instance of this exception if an expression evaluates to true. If the expression evaluates to false,
 199      * this method does nothing.
 200      *
 201      * @param expression Expression to be evaluated
 202      * @param message error message
 203      * @param errorType The enumerated type indicating the layer where the error occurred.
 204      * @param errorTag The enumerated tag representing a more specific error cause.
 205      * @throws RestconfDocumentedException if the expression evaluates to true.
 206      */
 207     public static void throwIf(final boolean expression, final @NonNull String message,
 208             final ErrorType errorType, final ErrorTag errorTag) {
 209         if (expression) {
 210             throw new RestconfDocumentedException(message, errorType, errorTag);
 211         }
 212     }
 213
 214     /**
 215      * Throw an instance of this exception if an object is null. If the object is non-null, it will
 216      * be returned as the result of this method.
 217      *
 218      * @param obj Object reference to be checked
 219      * @param errorType The enumerated type indicating the layer where the error occurred.
 220      * @param errorTag The enumerated tag representing a more specific error cause.
 221      * @param format Format string, according to {@link String#format(String, Object...)}.
 222      * @param args Format string arguments, according to {@link String#format(String, Object...)}
 223      * @throws RestconfDocumentedException if the expression evaluates to true.
 224      */
 225     public static <T> @NonNull T throwIfNull(final @Nullable T obj, final ErrorType errorType, final ErrorTag errorTag,
 226             final @NonNull String format, final Object... args) {
 227         if (obj == null) {
 228             throw new RestconfDocumentedException(String.format(format, args), errorType, errorTag);
 229         }
 230         return obj;
 231     }
 232
 233     /**
 234      * Throw an instance of this exception if the specified exception has a {@link YangError} attachment.
 235      *
 236      * @param cause Proposed cause of a RestconfDocumented exception
 237      */
 238     public static void throwIfYangError(final Throwable cause) {
 239         if (cause instanceof YangError) {
 240             final YangError error = (YangError) cause;
 241             throw new RestconfDocumentedException(cause, new RestconfError(error.getErrorType().toNetconf(),
 242                 // FIXME: this is a special-case until we have YangError.getTag()
 243                 cause instanceof YangInvalidValueException ? ErrorTag.INVALID_VALUE : ErrorTag.MALFORMED_MESSAGE,
 244                     error.getErrorMessage().orElse(null), error.getErrorAppTag().orElse(null)));
 245         }
 246     }
 247
 248     private static List<RestconfError> convertToRestconfErrors(final Collection<? extends RpcError> rpcErrors) {
 249         final List<RestconfError> errorList = new ArrayList<>();
 250         if (rpcErrors != null) {
 251             for (RpcError rpcError : rpcErrors) {
 252                 errorList.add(new RestconfError(rpcError));
 253             }
 254         }
 255
 256         return errorList;
 257     }
 258
 259     public List<RestconfError> getErrors() {
 260         return errors;
 261     }
 262
 263     public Status getStatus() {
 264         return status;
 265     }
 266
 267     @Override
 268     public String getMessage() {
 269         return "errors: " + errors + (status != null ? ", status: " + status : "");
 270     }
 271 }