-
Notifications
You must be signed in to change notification settings - Fork 215
/
GatewayWebsocketSessionClosedException.java
executable file
·142 lines (123 loc) · 5.74 KB
/
GatewayWebsocketSessionClosedException.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/*
* 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.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 the websocket session is closed because the Authorization Context of the session
* changed.
*/
@Immutable
@JsonParsableException(errorCode = GatewayWebsocketSessionClosedException.ERROR_CODE)
public final class GatewayWebsocketSessionClosedException extends DittoRuntimeException implements GatewayException {
/**
* Error code of this exception.
*/
public static final String ERROR_CODE = ERROR_CODE_PREFIX + "websocket.session.closed";
private static final String DEFAULT_MESSAGE =
"The websocket session was closed because the authorization context changed.";
private static final String DEFAULT_DESCRIPTION =
"Changing the authorization context for an established websocket session isn't supported.";
private static final String INVALID_TOKEN_MESSAGE = "The websocket session was closed because the JWT is invalid.";
private static final long serialVersionUID = -1391574777788522077L;
private GatewayWebsocketSessionClosedException(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
super(ERROR_CODE, HttpStatus.FORBIDDEN, dittoHeaders, message, description, cause, href);
}
/**
* A mutable builder for a {@code GatewayWebsocketSessionClosedException}.
*
* @return the builder.
*/
public static Builder newBuilder() {
return new Builder();
}
/**
* A mutable builder for a {@code GatewayWebsocketSessionClosedException} thrown due to an invalid token.
*
* @return the builder.
*/
public static Builder newBuilderForInvalidToken() {
return new Builder(INVALID_TOKEN_MESSAGE, null);
}
/**
* Constructs a new {@code GatewayWebsocketSessionClosedException} 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 GatewayWebsocketSessionClosedException.
* @throws NullPointerException if {@code dittoHeaders} is {@code null}.
*/
public static GatewayWebsocketSessionClosedException fromMessage(@Nullable final String message,
final DittoHeaders dittoHeaders) {
return DittoRuntimeException.fromMessage(message, dittoHeaders, new Builder());
}
/**
* Constructs a new {@code GatewayWebsocketSessionClosedException} 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 GatewayWebsocketSessionClosedException.
* @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 GatewayWebsocketSessionClosedException 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 GatewayWebsocketSessionClosedException}.
*/
@NotThreadSafe
public static final class Builder extends DittoRuntimeExceptionBuilder<GatewayWebsocketSessionClosedException> {
private Builder() {
this(DEFAULT_MESSAGE, DEFAULT_DESCRIPTION);
}
private Builder(final String message, @Nullable final String description) {
message(message);
description(description);
}
@Override
protected GatewayWebsocketSessionClosedException doBuild(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
return new GatewayWebsocketSessionClosedException(dittoHeaders, message, description, cause, href);
}
}
}