-
Notifications
You must be signed in to change notification settings - Fork 216
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added new DittoInternalErrorException and used whereever GatewayInter…
…nalErrorException was used without "gateway" scope * fixed handling of DittoRuntimeExceptions in AbstractPersistecenSupervisor Signed-off-by: Thomas Jaeckle <thomas.jaeckle@bosch.io>
- Loading branch information
Showing
26 changed files
with
238 additions
and
84 deletions.
There are no files selected for viewing
124 changes: 124 additions & 0 deletions
124
...org/eclipse/ditto/base/model/signals/commands/exceptions/DittoInternalErrorException.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
/* | ||
* Copyright (c) 2022 Contributors to the Eclipse Foundation | ||
* | ||
* See the NOTICE file(s) distributed with this work for additional | ||
* information regarding copyright ownership. | ||
* | ||
* This program and the accompanying materials are made available under the | ||
* terms of the Eclipse Public License 2.0 which is available at | ||
* http://www.eclipse.org/legal/epl-2.0 | ||
* | ||
* SPDX-License-Identifier: EPL-2.0 | ||
*/ | ||
package org.eclipse.ditto.base.model.signals.commands.exceptions; | ||
|
||
import java.net.URI; | ||
|
||
import javax.annotation.Nullable; | ||
import javax.annotation.concurrent.Immutable; | ||
import javax.annotation.concurrent.NotThreadSafe; | ||
|
||
import org.eclipse.ditto.base.model.common.HttpStatus; | ||
import org.eclipse.ditto.base.model.exceptions.DittoRuntimeException; | ||
import org.eclipse.ditto.base.model.exceptions.DittoRuntimeExceptionBuilder; | ||
import org.eclipse.ditto.base.model.headers.DittoHeaders; | ||
import org.eclipse.ditto.base.model.json.JsonParsableException; | ||
import org.eclipse.ditto.json.JsonObject; | ||
|
||
/** | ||
* This exception indicates that an unexpected internal error occurred in a Ditto service. | ||
* @since 3.0.0 | ||
*/ | ||
@Immutable | ||
@JsonParsableException(errorCode = DittoInternalErrorException.ERROR_CODE) | ||
public final class DittoInternalErrorException extends DittoRuntimeException implements GeneralException { | ||
|
||
/** | ||
* Error code of this exception. | ||
*/ | ||
public static final String ERROR_CODE = ERROR_CODE_PREFIX + "internalerror"; | ||
|
||
private static final String DEFAULT_MESSAGE = "There was a rare case of an unexpected internal error."; | ||
private static final String DEFAULT_DESCRIPTION = "Please contact the service team or your administrator."; | ||
|
||
private static final long serialVersionUID = 927151443229985012L; | ||
|
||
private DittoInternalErrorException(final DittoHeaders dittoHeaders, | ||
@Nullable final String message, | ||
@Nullable final String description, | ||
@Nullable final Throwable cause, | ||
@Nullable final URI href) { | ||
super(ERROR_CODE, HttpStatus.INTERNAL_SERVER_ERROR, dittoHeaders, message, description, cause, href); | ||
} | ||
|
||
/** | ||
* A mutable builder for a {@code DittoInternalErrorException}. | ||
* | ||
* @return the builder. | ||
*/ | ||
public static Builder newBuilder() { | ||
return new Builder(); | ||
} | ||
|
||
/** | ||
* Constructs a new {@code DittoInternalErrorException} object with given message. | ||
* | ||
* @param message detail message. This message can be later retrieved by the {@link #getMessage()} method. | ||
* @param dittoHeaders the headers of the command which resulted in this exception. | ||
* @return the new DittoInternalErrorException. | ||
* @throws NullPointerException if {@code dittoHeaders} is {@code null}. | ||
*/ | ||
public static DittoInternalErrorException fromMessage(@Nullable final String message, | ||
final DittoHeaders dittoHeaders) { | ||
return DittoRuntimeException.fromMessage(message, dittoHeaders, new Builder()); | ||
} | ||
|
||
/** | ||
* Constructs a new {@code DittoInternalErrorException} object with the exception message extracted from the given | ||
* JSON object. | ||
* | ||
* @param jsonObject the JSON to read the {@link org.eclipse.ditto.base.model.exceptions.DittoRuntimeException.JsonFields#MESSAGE} field from. | ||
* @param dittoHeaders the headers of the command which resulted in this exception. | ||
* @return the new DittoInternalErrorException. | ||
* @throws NullPointerException if any argument is {@code null}. | ||
* @throws org.eclipse.ditto.json.JsonMissingFieldException if this JsonObject did not contain an error message. | ||
* @throws org.eclipse.ditto.json.JsonParseException if the passed in {@code jsonObject} was not in the expected | ||
* format. | ||
*/ | ||
public static DittoInternalErrorException fromJson(final JsonObject jsonObject, | ||
final DittoHeaders dittoHeaders) { | ||
return DittoRuntimeException.fromJson(jsonObject, dittoHeaders, new Builder()); | ||
} | ||
|
||
@Override | ||
public DittoRuntimeException setDittoHeaders(final DittoHeaders dittoHeaders) { | ||
return new Builder() | ||
.message(getMessage()) | ||
.description(getDescription().orElse(null)) | ||
.cause(getCause()) | ||
.href(getHref().orElse(null)) | ||
.dittoHeaders(dittoHeaders) | ||
.build(); | ||
} | ||
|
||
/** | ||
* A mutable builder with a fluent API for a {@link org.eclipse.ditto.base.model.signals.commands.exceptions.DittoInternalErrorException}. | ||
*/ | ||
@NotThreadSafe | ||
public static final class Builder extends DittoRuntimeExceptionBuilder<DittoInternalErrorException> { | ||
|
||
private Builder() { | ||
message(DEFAULT_MESSAGE); | ||
description(DEFAULT_DESCRIPTION); | ||
} | ||
|
||
@Override | ||
protected DittoInternalErrorException doBuild(final DittoHeaders dittoHeaders, | ||
@Nullable final String message, | ||
@Nullable final String description, | ||
@Nullable final Throwable cause, | ||
@Nullable final URI href) { | ||
return new DittoInternalErrorException(dittoHeaders, message, description, cause, href); | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
27 changes: 27 additions & 0 deletions
27
.../main/java/org/eclipse/ditto/base/model/signals/commands/exceptions/GeneralException.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
/* | ||
* Copyright (c) 2022 Contributors to the Eclipse Foundation | ||
* | ||
* See the NOTICE file(s) distributed with this work for additional | ||
* information regarding copyright ownership. | ||
* | ||
* This program and the accompanying materials are made available under the | ||
* terms of the Eclipse Public License 2.0 which is available at | ||
* http://www.eclipse.org/legal/epl-2.0 | ||
* | ||
* SPDX-License-Identifier: EPL-2.0 | ||
*/ | ||
package org.eclipse.ditto.base.model.signals.commands.exceptions; | ||
|
||
/** | ||
* Aggregates all {@link org.eclipse.ditto.base.model.exceptions.DittoRuntimeException}s which are emitted by Ditto | ||
* by any service, e.g. used for "internal error" exceptions. | ||
* @since 3.0.0 | ||
*/ | ||
public interface GeneralException { | ||
|
||
/** | ||
* Error code prefix of errors emitted by any Ditto service. | ||
*/ | ||
String ERROR_CODE_PREFIX = "general" + ":"; | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.