/* * Copyright (c) 2024 PANTHEON.tech, s.r.o. 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.restconf.server.api; import static java.util.Objects.requireNonNull; import java.io.IOException; import java.io.NotSerializableException; import java.io.ObjectInputStream; import java.io.ObjectOutputStream; import java.io.ObjectStreamException; import org.eclipse.jdt.annotation.NonNullByDefault; import org.eclipse.jdt.annotation.Nullable; import org.opendaylight.restconf.api.ErrorMessage; import org.opendaylight.restconf.common.errors.RestconfDocumentedException; import org.opendaylight.restconf.common.errors.RestconfError; import org.opendaylight.yangtools.yang.common.ErrorTag; import org.opendaylight.yangtools.yang.common.ErrorType; /** * A server-side processing exception, reporting a single {@link ServerError}. This exception is not serializable on * purpose. */ @NonNullByDefault public final class ServerException extends Exception { @java.io.Serial private static final long serialVersionUID = 0L; private final ServerError error; private ServerException(final String message, final ServerError error, final @Nullable Throwable cause) { super(message, cause); this.error = requireNonNull(error); } public ServerException(final String message) { this(ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED, requireNonNull(message)); } public ServerException(final String format, final Object @Nullable ... args) { this(ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED, format, args); } public ServerException(final Throwable cause) { this(ErrorType.APPLICATION, errorTagOf(cause), cause); } public ServerException(final String message, final @Nullable Throwable cause) { this(ErrorType.APPLICATION, errorTagOf(cause), requireNonNull(message), cause); } public ServerException(final ErrorType type, final ErrorTag tag, final String message) { this(type, tag, message, (Throwable) null); } public ServerException(final ErrorType type, final ErrorTag tag, final Throwable cause) { this(cause.toString(), new ServerError(type, tag, new ErrorMessage(cause.getMessage()), null, null, null), cause); } public ServerException(final ErrorType type, final ErrorTag tag, final String message, final @Nullable Throwable cause) { this(requireNonNull(message), new ServerError(type, tag, new ErrorMessage(message), null, null, errorInfoOf(cause)), cause); } public ServerException(final ErrorType type, final ErrorTag tag, final String format, final Object @Nullable ... args) { this(type, tag, format.formatted(args)); } public ServerException(final ErrorType type, final ErrorTag tag, final ServerErrorPath path, final String message) { this(message, new ServerError(type, tag, new ErrorMessage(message), null, requireNonNull(path), null), null); } /** * Return the reported {@link ServerError}. * * @return the reported {@link ServerError} */ public ServerError error() { return error; } @Deprecated public RestconfDocumentedException toLegacy() { final var message = error.message(); final var info = error.info(); final var path = error.path(); if (path != null) { return new RestconfDocumentedException(this, new RestconfError(error.type(), error.tag(), message != null ? message.elementBody() : null, error.appTag(), info != null ? info.elementBody() : null, path.path()), path.databind().modelContext()); } else { return new RestconfDocumentedException(this, new RestconfError(error.type(), error.tag(), message != null ? message.elementBody() : null, error.appTag(), info != null ? info.elementBody() : null, null)); } } @java.io.Serial private void readObjectNoData() throws ObjectStreamException { throw new NotSerializableException(); } @java.io.Serial private void readObject(final ObjectInputStream stream) throws IOException, ClassNotFoundException { throw new NotSerializableException(); } @java.io.Serial private void writeObject(final ObjectOutputStream stream) throws IOException { throw new NotSerializableException(); } private static @Nullable ServerErrorInfo errorInfoOf(final @Nullable Throwable cause) { if (cause != null) { final var message = cause.getMessage(); if (message != null) { return new ServerErrorInfo(message); } } return null; } private static ErrorTag errorTagOf(final @Nullable Throwable cause) { if (cause instanceof UnsupportedOperationException) { return ErrorTag.OPERATION_NOT_SUPPORTED; } else if (cause instanceof IllegalArgumentException) { return ErrorTag.INVALID_VALUE; } else { return ErrorTag.OPERATION_FAILED; } } }