-
Notifications
You must be signed in to change notification settings - Fork 215
/
CommandTimeoutException.java
executable file
·141 lines (118 loc) · 5.16 KB
/
CommandTimeoutException.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
/*
* Copyright (c) 2020 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 static org.eclipse.ditto.base.model.common.ConditionChecker.checkNotNull;
import java.net.URI;
import java.text.MessageFormat;
import java.time.Duration;
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.exceptions.GeneralException;
import org.eclipse.ditto.base.model.headers.DittoHeaders;
import org.eclipse.ditto.base.model.json.JsonParsableException;
import org.eclipse.ditto.json.JsonObject;
/**
* Thrown if a command reached its defined timeout after no response was received.
*
* @since 1.1.0
*/
@Immutable
@JsonParsableException(errorCode = CommandTimeoutException.ERROR_CODE)
public final class CommandTimeoutException extends DittoRuntimeException implements GeneralException {
/**
* Error code of this exception.
*/
public static final String ERROR_CODE = ERROR_CODE_PREFIX + "command.timeout";
private static final String MESSAGE_TEMPLATE = "The Command reached the specified timeout of {0}ms.";
private static final String DEFAULT_DESCRIPTION = "Try increasing the command timeout.";
private static final long serialVersionUID = -3732435554989623073L;
private CommandTimeoutException(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
super(ERROR_CODE, HttpStatus.REQUEST_TIMEOUT, dittoHeaders, message, description, cause, href);
}
/**
* A mutable builder for a {@code CommandTimeoutException}.
*
* @param timeout the timeout.
* @return the builder.
* @throws NullPointerException if {@code timeout} is {@code null}.
*/
public static Builder newBuilder(final Duration timeout) {
return new Builder(checkNotNull(timeout, "timeout"));
}
/**
* Constructs a new {@code CommandTimeoutException} 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 CommandTimeoutException.
* @throws NullPointerException if {@code dittoHeaders} is {@code null}.
*/
public static CommandTimeoutException fromMessage(@Nullable final String message,
final DittoHeaders dittoHeaders) {
return DittoRuntimeException.fromMessage(message, dittoHeaders, new Builder());
}
/**
* Deserialize from a JSON object.
*
* @param jsonObject the JSON object to deserialize.
* @param dittoHeaders the headers.
* @return an instance of this class.
* @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 CommandTimeoutException 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 CommandTimeoutException}.
*/
@NotThreadSafe
public static final class Builder extends DittoRuntimeExceptionBuilder<CommandTimeoutException> {
private Builder() {
description(DEFAULT_DESCRIPTION);
}
private Builder(final Duration timeout) {
this();
message(MessageFormat.format(MESSAGE_TEMPLATE, timeout.toMillis()));
}
@Override
protected CommandTimeoutException doBuild(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
return new CommandTimeoutException(dittoHeaders, message, description, cause, href);
}
}
}