/
GatewayTimeoutInvalidException.java
executable file
·139 lines (117 loc) · 5.43 KB
/
GatewayTimeoutInvalidException.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
/*
* Copyright (c) 2017 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.signals.commands.base.exceptions;
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.json.JsonObject;
import org.eclipse.ditto.model.base.common.HttpStatus;
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.base.json.JsonParsableException;
/**
* This exception indicates that the configured {@code "timeout"} of a HTTP call was not valid or within its allowed
* bounds.
*
* @since 1.1.0
*/
@Immutable
@JsonParsableException(errorCode = GatewayTimeoutInvalidException.ERROR_CODE)
public final class GatewayTimeoutInvalidException extends DittoRuntimeException implements GatewayException {
/**
* Error code of this exception.
*/
public static final String ERROR_CODE = ERROR_CODE_PREFIX + "timeout.invalid";
private static final String DEFAULT_MESSAGE = "The timeout <{0}ms> is not inside its allowed bounds <0ms - {1}ms>";
private static final String DEFAULT_DESCRIPTION = "Choose a timeout inside the bounds.";
private static final long serialVersionUID = 4432789435789590723L;
private GatewayTimeoutInvalidException(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
super(ERROR_CODE, HttpStatus.BAD_REQUEST, dittoHeaders, message, description, cause, href);
}
/**
* A mutable builder for a {@code GatewayTimeoutInvalidException}.
*
* @return the builder.
*/
public static Builder newBuilder(final Duration timeout, final Duration maxTimeout) {
return new Builder(timeout, maxTimeout);
}
/**
* Constructs a new {@code GatewayTimeoutInvalidException} 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 GatewayTimeoutInvalidException.
* @throws NullPointerException if {@code dittoHeaders} is {@code null}.
*/
public static GatewayTimeoutInvalidException fromMessage(@Nullable final String message,
final DittoHeaders dittoHeaders) {
return DittoRuntimeException.fromMessage(message, dittoHeaders, new Builder());
}
/**
* Constructs a new {@code GatewayTimeoutInvalidException} object with the exception message extracted from the
* given JSON object.
*
* @param jsonObject the JSON to read the
* {@link org.eclipse.ditto.model.base.exceptions.DittoRuntimeException.JsonFields#MESSAGE} field from.
* @param dittoHeaders the headers of the command which resulted in this exception.
* @return the new GatewayTimeoutInvalidException.
* @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 GatewayTimeoutInvalidException 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.signals.commands.base.exceptions.GatewayTimeoutInvalidException}.
*/
@NotThreadSafe
public static final class Builder extends DittoRuntimeExceptionBuilder<GatewayTimeoutInvalidException> {
private Builder() {
description(DEFAULT_DESCRIPTION);
}
private Builder(final Duration timeout, final Duration maxTimeout) {
message(MessageFormat.format(DEFAULT_MESSAGE, timeout.toMillis(), maxTimeout.toMillis()));
description(DEFAULT_DESCRIPTION);
}
@Override
protected GatewayTimeoutInvalidException doBuild(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
return new GatewayTimeoutInvalidException(dittoHeaders, message, description, cause, href);
}
}
}