/
ConnectionSignalIllegalException.java
154 lines (131 loc) · 5.85 KB
/
ConnectionSignalIllegalException.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
143
144
145
146
147
148
149
150
151
152
153
/*
* Copyright (c) 2017-2018 Bosch Software Innovations GmbH.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/org/documents/epl-2.0/index.php
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.signals.commands.connectivity.exceptions;
import java.net.URI;
import java.text.MessageFormat;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.NotThreadSafe;
import org.eclipse.ditto.json.JsonObject;
import org.eclipse.ditto.model.base.common.HttpStatusCode;
import org.eclipse.ditto.model.base.exceptions.DittoRuntimeException;
import org.eclipse.ditto.model.base.exceptions.DittoRuntimeExceptionBuilder;
import org.eclipse.ditto.model.base.headers.DittoHeaders;
import org.eclipse.ditto.model.connectivity.ConnectivityException;
/**
* Thrown if a connection command arrives while a connection operation is underway.
*/
@Immutable
public final class ConnectionSignalIllegalException extends DittoRuntimeException implements ConnectivityException {
/**
* Error code of this exception.
*/
public static final String ERROR_CODE = ERROR_CODE_PREFIX + "signal.illegal";
private static final String OPERATING_MESSAGE_TEMPLATE = "The Connection with ID ''{0}'' is {1}.";
private static final String OPERATING_DESCRIPTION_TEMPLATE = "Please retry in {0} {1}.";
private static final String STAYING_MESSAGE_TEMPLATE = "The message ''{2}'' is illegal for the {1} Connection " +
"with ID ''{0}''";
private static final long serialVersionUID = 2648721759252899991L;
private ConnectionSignalIllegalException(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
super(ERROR_CODE, HttpStatusCode.CONFLICT, dittoHeaders, message, description, cause, href);
}
/**
* A mutable builder for a {@code ConnectionBusyException}.
*
* @param connectionId the ID of the connection.
* @return the builder.
*/
public static Builder newBuilder(final String connectionId) {
return new Builder().connectionId(connectionId);
}
/**
* Constructs a new {@code ConnectionBusyException} object with the exception message extracted from the
* given JSON object.
*
* @param jsonObject the JSON to read the {@link JsonFields#MESSAGE} field from.
* @param dittoHeaders the headers of the command which resulted in this exception.
* @return the new ConnectionBusyException.
* @throws org.eclipse.ditto.json.JsonMissingFieldException if the {@code jsonObject} does not have the {@link
* JsonFields#MESSAGE} field.
*/
public static ConnectionSignalIllegalException fromJson(final JsonObject jsonObject,
final DittoHeaders dittoHeaders) {
return new Builder()
.dittoHeaders(dittoHeaders)
.message(readMessage(jsonObject))
.description(readDescription(jsonObject).orElse(null))
.href(readHRef(jsonObject).orElse(null))
.build();
}
/**
* A mutable builder with a fluent API for a {@link ConnectionSignalIllegalException}.
*/
@NotThreadSafe
public static final class Builder extends DittoRuntimeExceptionBuilder<ConnectionSignalIllegalException> {
private String connectionId = "UNKNOWN";
private Builder() {}
/**
* Set the connection ID.
*
* @param connectionId the connection ID.
* @return this builder.
*/
public Builder connectionId(final String connectionId) {
this.connectionId = connectionId;
return this;
}
/**
* Set what is happening. The operation name is the gerund complementing "is" in the error message;
* good choices are lower-case verbs in ING-form such as "connecting" and "disconnecting".
*
* @param operationName name of the operation.
* @return this builder.
*/
public Builder operationName(final String operationName) {
message(MessageFormat.format(OPERATING_MESSAGE_TEMPLATE, connectionId, operationName));
return this;
}
/**
* Set description to after how many seconds the user should attempt the command again.
*
* @param timeout timeout of the current connection operation in seconds.
* @return this builder.
*/
public Builder timeout(final int timeout) {
final String timeoutUnit = timeout == 1 ? "second" : "seconds";
description(MessageFormat.format(OPERATING_DESCRIPTION_TEMPLATE, timeout, timeoutUnit));
return this;
}
/**
* Set message to about a signal arriving when the connection state does not handle it.
*
* @param signalType type of the signal.
* @param state state of the connection. Should be an adjective.
* @return this builder.
*/
public Builder illegalSignalForState(final String signalType, final String state) {
message(MessageFormat.format(STAYING_MESSAGE_TEMPLATE, connectionId, state, signalType));
return this;
}
@Override
protected ConnectionSignalIllegalException doBuild(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
return new ConnectionSignalIllegalException(dittoHeaders, message, description, cause, href);
}
}
}