-
Notifications
You must be signed in to change notification settings - Fork 225
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add new exception GatewayWebsocketSessionAbortedException which is us…
…ed for terminating the websocket session; extend Connect with an optional killSwitch; shutdown websocket streams in service requests done phase of CoordinatedShutdown; Signed-off-by: Stefan Maute <stefan.maute@bosch.io>
- Loading branch information
Stefan Maute
committed
Sep 15, 2022
1 parent
7174e8c
commit 46cb671
Showing
7 changed files
with
215 additions
and
27 deletions.
There are no files selected for viewing
115 changes: 115 additions & 0 deletions
115
.../src/main/java/org/eclipse/ditto/gateway/api/GatewayWebsocketSessionAbortedException.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,115 @@ | ||
| /* | ||
| * 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.gateway.api; | ||
|
|
||
| import java.net.URI; | ||
|
|
||
| import javax.annotation.Nullable; | ||
| 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; | ||
|
|
||
| /** | ||
| * Error response for websocket sessions that are aborted due to service restart. | ||
| * | ||
| * @since 3.0.0 | ||
| */ | ||
| @JsonParsableException(errorCode = GatewayWebsocketSessionAbortedException.ERROR_CODE) | ||
| public class GatewayWebsocketSessionAbortedException extends DittoRuntimeException implements GatewayException { | ||
|
|
||
| /** | ||
| * Error code of this exception. | ||
| */ | ||
| public static final String ERROR_CODE = ERROR_CODE_PREFIX + "streaming.session.aborted"; | ||
|
|
||
| /** | ||
| * Error message of this exception. | ||
| */ | ||
| public static final String MESSAGE = "The web socket session is aborted due to a service restart."; | ||
|
|
||
| private static final HttpStatus STATUS_CODE = HttpStatus.INTERNAL_SERVER_ERROR; | ||
|
|
||
| private GatewayWebsocketSessionAbortedException(final DittoHeaders dittoHeaders, | ||
| @Nullable final String message, | ||
| @Nullable final String description, | ||
| @Nullable final Throwable cause, | ||
| @Nullable final URI href) { | ||
|
|
||
| super(ERROR_CODE, STATUS_CODE, dittoHeaders, message, description, cause, href); | ||
| } | ||
|
|
||
| /** | ||
| * Create a {@code GatewayWebsocketSessionAbortedException}. | ||
| * | ||
| * @param dittoHeaders the Ditto headers. | ||
| * @return the exception. | ||
| */ | ||
| public static GatewayWebsocketSessionAbortedException of(final DittoHeaders dittoHeaders) { | ||
| return new Builder() | ||
| .message(MESSAGE) | ||
| .description("Please try again later.") | ||
| .dittoHeaders(dittoHeaders) | ||
| .build(); | ||
| } | ||
|
|
||
| /** | ||
| * Constructs a new {@code SubscriptionAbortedException} 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 SubscriptionAbortedException. | ||
| * @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 GatewayWebsocketSessionAbortedException 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 GatewayWebsocketSessionAbortedException}. | ||
| */ | ||
| @NotThreadSafe | ||
| public static final class Builder extends DittoRuntimeExceptionBuilder<GatewayWebsocketSessionAbortedException> { | ||
|
|
||
| private Builder() {} | ||
|
|
||
| @Override | ||
| protected GatewayWebsocketSessionAbortedException doBuild(final DittoHeaders dittoHeaders, | ||
| @Nullable final String message, | ||
| @Nullable final String description, | ||
| @Nullable final Throwable cause, | ||
| @Nullable final URI href) { | ||
| return new GatewayWebsocketSessionAbortedException(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
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.