X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-rest-connector%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Frestconf%2Fimpl%2FRestconfError.java;h=544a144987a68a77f9ec14e3c22d77cf1962fae8;hb=75495f26e7718da7d6f9e0ad06af1caa2e3ebf08;hp=9220f8bd8ff3cc3d28bb9f54b0701be451623f44;hpb=b80124e3f7b11cf2f5e5bd4a6b033d855ff4d0d4;p=controller.git diff --git a/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/restconf/impl/RestconfError.java b/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/restconf/impl/RestconfError.java index 9220f8bd8f..544a144987 100644 --- a/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/restconf/impl/RestconfError.java +++ b/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/restconf/impl/RestconfError.java @@ -1,25 +1,23 @@ /* -* Copyright (c) 2014 Brocade Communications Systems, Inc. and others. All rights reserved. -* -* This program and the accompanying materials are made available under the -* terms of the Eclipse Public License v1.0 which accompanies this distribution, -* and is available at http://www.eclipse.org/legal/epl-v10.html -*/ + * Copyright (c) 2014 Brocade Communications Systems, Inc. and others. All rights reserved. + * + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + */ package org.opendaylight.controller.sal.restconf.impl; +import com.google.common.base.Preconditions; import java.io.PrintWriter; import java.io.StringWriter; - -import javax.ws.rs.core.Response.Status; - import org.opendaylight.yangtools.yang.common.RpcError; -import com.google.common.base.Preconditions; - /** * Encapsulates a restconf error as defined in the ietf restconf draft. * - *

Note: Enumerations defined within are provided by the ietf restconf draft. + *
+ *
+ * Note: Enumerations defined within are provided by the ietf restconf draft. * * @author Devin Avery * @see {@link https://tools.ietf.org/html/draft-bierman-netconf-restconf-02} @@ -40,42 +38,40 @@ public class RestconfError { return name().toLowerCase(); } - public static ErrorType valueOfCaseInsensitive( String value ) - { + public static ErrorType valueOfCaseInsensitive(String value) { try { - return ErrorType.valueOf( ErrorType.class, value.toUpperCase() ); - } - catch( IllegalArgumentException e ) { + return ErrorType.valueOf(ErrorType.class, value.toUpperCase()); + } catch (IllegalArgumentException e) { return APPLICATION; } } } public static enum ErrorTag { - IN_USE( "in-use", Status.fromStatusCode(409)), - INVALID_VALUE( "invalid-value", Status.fromStatusCode(400)), - TOO_BIG( "too-big", Status.fromStatusCode(413)), - MISSING_ATTRIBUTE( "missing-attribute", Status.fromStatusCode(400)), - BAD_ATTRIBUTE( "bad-attribute", Status.fromStatusCode(400)), - UNKNOWN_ATTRIBUTE( "unknown-attribute", Status.fromStatusCode(400)), - BAD_ELEMENT( "bad-element", Status.fromStatusCode(400)), - UNKNOWN_ELEMENT( "unknown-element", Status.fromStatusCode(400)), - UNKNOWN_NAMESPACE( "unknown-namespace", Status.fromStatusCode(400)), - ACCESS_DENIED( "access-denied", Status.fromStatusCode(403)), - LOCK_DENIED( "lock-denied", Status.fromStatusCode(409)), - RESOURCE_DENIED( "resource-denied", Status.fromStatusCode(409)), - ROLLBACK_FAILED( "rollback-failed", Status.fromStatusCode(500)), - DATA_EXISTS( "data-exists", Status.fromStatusCode(409)), - DATA_MISSING( "data-missing", Status.fromStatusCode(409)), - OPERATION_NOT_SUPPORTED( "operation-not-supported", Status.fromStatusCode(501)), - OPERATION_FAILED( "operation-failed", Status.fromStatusCode(500)), - PARTIAL_OPERATION( "partial-operation", Status.fromStatusCode(500)), - MALFORMED_MESSAGE( "malformed-message", Status.fromStatusCode(400)); + IN_USE("in-use", 409 /* Conflict */), + INVALID_VALUE("invalid-value", 400 /* Bad Request */), + TOO_BIG("too-big", 413 /* Request Entity Too Large */), + MISSING_ATTRIBUTE("missing-attribute", 400 /* Bad Request */), + BAD_ATTRIBUTE("bad-attribute", 400 /* Bad Request */), + UNKNOWN_ATTRIBUTE("unknown-attribute", 400 /* Bad Request */), + BAD_ELEMENT("bad-element", 400 /* Bad Request */), + UNKNOWN_ELEMENT("unknown-element", 400 /* Bad Request */), + UNKNOWN_NAMESPACE("unknown-namespace", 400 /* Bad Request */), + ACCESS_DENIED("access-denied", 403 /* Forbidden */), + LOCK_DENIED("lock-denied", 409 /* Conflict */), + RESOURCE_DENIED("resource-denied", 409 /* Conflict */), + ROLLBACK_FAILED("rollback-failed", 500 /* INTERNAL_SERVER_ERROR */), + DATA_EXISTS("data-exists", 409 /* Conflict */), + DATA_MISSING("data-missing", 404 /* Resource Not Found */), + OPERATION_NOT_SUPPORTED("operation-not-supported", 501 /* Not Implemented */), + OPERATION_FAILED("operation-failed", 500 /* INTERNAL_SERVER_ERROR */), + PARTIAL_OPERATION("partial-operation", 500 /* INTERNAL_SERVER_ERROR */), + MALFORMED_MESSAGE("malformed-message", 400 /* Bad Request */); private final String tagValue; - private final Status statusCode; + private final int statusCode; - ErrorTag(final String tagValue, final Status statusCode) { + ErrorTag(final String tagValue, final int statusCode) { this.tagValue = tagValue; this.statusCode = statusCode; } @@ -84,17 +80,15 @@ public class RestconfError { return this.tagValue.toLowerCase(); } - public static ErrorTag valueOfCaseInsensitive( String value ) - { + public static ErrorTag valueOfCaseInsensitive(String value) { try { - return ErrorTag.valueOf( ErrorTag.class, value.toUpperCase().replaceAll( "-","_" ) ); - } - catch( IllegalArgumentException e ) { + return ErrorTag.valueOf(ErrorTag.class, value.toUpperCase().replaceAll("-", "_")); + } catch (IllegalArgumentException e) { return OPERATION_FAILED; } } - public Status getStatusCode() { + public int getStatusCode() { return statusCode; } } @@ -104,53 +98,63 @@ public class RestconfError { private final String errorInfo; private final String errorAppTag; private final String errorMessage; - //TODO: Add in the error-path concept as defined in the ietf draft. - static String toErrorInfo( Throwable cause ) { + // TODO: Add in the error-path concept as defined in the ietf draft. + + static String toErrorInfo(Throwable cause) { StringWriter writer = new StringWriter(); - cause.printStackTrace( new PrintWriter( writer ) ); + cause.printStackTrace(new PrintWriter(writer)); return writer.toString(); } /** * Constructs a RestConfError * - * @param errorType The enumerated type indicating the layer where the error occurred. - * @param errorTag The enumerated tag representing a more specific error cause. - * @param errorMessage A string which provides a plain text string describing the error. + * @param errorType + * The enumerated type indicating the layer where the error occurred. + * @param errorTag + * The enumerated tag representing a more specific error cause. + * @param errorMessage + * A string which provides a plain text string describing the error. */ public RestconfError(ErrorType errorType, ErrorTag errorTag, String errorMessage) { - this( errorType, errorTag, errorMessage, null ); + this(errorType, errorTag, errorMessage, null); } /** * Constructs a RestConfError object. * - * @param errorType The enumerated type indicating the layer where the error occurred. - * @param errorTag The enumerated tag representing a more specific error cause. - * @param errorMessage A string which provides a plain text string describing the error. - * @param errorAppTag A string which represents an application-specific error tag that further - * specifies the error cause. + * @param errorType + * The enumerated type indicating the layer where the error occurred. + * @param errorTag + * The enumerated tag representing a more specific error cause. + * @param errorMessage + * A string which provides a plain text string describing the error. + * @param errorAppTag + * A string which represents an application-specific error tag that further specifies the error cause. */ - public RestconfError(ErrorType errorType, ErrorTag errorTag, String errorMessage, - String errorAppTag) { - this( errorType, errorTag, errorMessage, errorAppTag, null ); + public RestconfError(ErrorType errorType, ErrorTag errorTag, String errorMessage, String errorAppTag) { + this(errorType, errorTag, errorMessage, errorAppTag, null); } /** * Constructs a RestConfError object. * - * @param errorType The enumerated type indicating the layer where the error occurred. - * @param errorTag The enumerated tag representing a more specific error cause. - * @param errorMessage A string which provides a plain text string describing the error. - * @param errorAppTag A string which represents an application-specific error tag that further - * specifies the error cause. - * @param errorInfo A string, formatted as XML, which contains additional error information. + * @param errorType + * The enumerated type indicating the layer where the error occurred. + * @param errorTag + * The enumerated tag representing a more specific error cause. + * @param errorMessage + * A string which provides a plain text string describing the error. + * @param errorAppTag + * A string which represents an application-specific error tag that further specifies the error cause. + * @param errorInfo + * A string, formatted as XML, which contains additional error information. */ - public RestconfError(ErrorType errorType, ErrorTag errorTag, String errorMessage, - String errorAppTag, String errorInfo) { - Preconditions.checkNotNull( errorType, "Error type is required for RestConfError" ); - Preconditions.checkNotNull( errorTag, "Error tag is required for RestConfError"); + public RestconfError(ErrorType errorType, ErrorTag errorTag, String errorMessage, String errorAppTag, + String errorInfo) { + Preconditions.checkNotNull(errorType, "Error type is required for RestConfError"); + Preconditions.checkNotNull(errorTag, "Error tag is required for RestConfError"); this.errorType = errorType; this.errorTag = errorTag; this.errorMessage = errorMessage; @@ -161,28 +165,25 @@ public class RestconfError { /** * Constructs a RestConfError object from an RpcError. */ - public RestconfError( RpcError rpcError ) { + public RestconfError(RpcError rpcError) { - this.errorType = rpcError.getErrorType() == null ? ErrorType.APPLICATION : - ErrorType.valueOfCaseInsensitive( rpcError.getErrorType().name() ); + this.errorType = rpcError.getErrorType() == null ? ErrorType.APPLICATION : ErrorType + .valueOfCaseInsensitive(rpcError.getErrorType().name()); - this.errorTag = rpcError.getTag() == null ? ErrorTag.OPERATION_FAILED : - ErrorTag.valueOfCaseInsensitive( rpcError.getTag().toString() ); + this.errorTag = rpcError.getTag() == null ? ErrorTag.OPERATION_FAILED : ErrorTag + .valueOfCaseInsensitive(rpcError.getTag().toString()); this.errorMessage = rpcError.getMessage(); this.errorAppTag = rpcError.getApplicationTag(); String errorInfo = null; - if( rpcError.getInfo() == null ) { - if( rpcError.getCause() != null ) { - errorInfo = toErrorInfo( rpcError.getCause() ); - } - else if( rpcError.getSeverity() != null ) { - errorInfo = "" + rpcError.getSeverity().toString().toLowerCase() + - ""; + if (rpcError.getInfo() == null) { + if (rpcError.getCause() != null) { + errorInfo = toErrorInfo(rpcError.getCause()); + } else if (rpcError.getSeverity() != null) { + errorInfo = "" + rpcError.getSeverity().toString().toLowerCase() + ""; } - } - else { + } else { errorInfo = rpcError.getInfo(); } @@ -211,8 +212,7 @@ public class RestconfError { @Override public String toString() { - return "error-type: " + errorType.getErrorTypeTag() - + ", error-tag: " + errorTag.getTagValue() + ", " + return "error-type: " + errorType.getErrorTypeTag() + ", error-tag: " + errorTag.getTagValue() + ", " + (errorAppTag != null ? "error-app-tag: " + errorAppTag + ", " : "") + (errorMessage != null ? "error-message: " + errorMessage : "") + (errorInfo != null ? "error-info: " + errorInfo + ", " : "") + "]";