/
ConnectionSignalIdEnforcementFailedException.java
130 lines (112 loc) · 5.07 KB
/
ConnectionSignalIdEnforcementFailedException.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
/*
* 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.model.connectivity;
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.base.json.JsonParsableException;
/**
* Thrown if the enforcement of the Signal ID (e.g. a Thing ID) failed.
*/
@Immutable
@JsonParsableException(errorCode = ConnectionSignalIdEnforcementFailedException.ERROR_CODE)
public final class ConnectionSignalIdEnforcementFailedException extends DittoRuntimeException
implements ConnectivityException {
/**
* Error code of this exception.
*/
public static final String ERROR_CODE = ERROR_CODE_PREFIX + "connection.id.enforcement.failed";
private static final String MESSAGE_TEMPLATE =
"The configured filters could not be matched against the given target with ID ''{0}''.";
private static final String DEFAULT_DESCRIPTION =
"Either modify the configured filter or ensure that the message is sent via the correct ID.";
private static final long serialVersionUID = 2672495302389903822L;
private ConnectionSignalIdEnforcementFailedException(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
super(ERROR_CODE, HttpStatusCode.BAD_REQUEST, dittoHeaders, message, description, cause, href);
}
/**
* A mutable builder for a {@link ConnectionSignalIdEnforcementFailedException}.
*
* @param target the enforcement target.
* @return the builder.
*/
public static Builder newBuilder(final String target) {
return new Builder(target);
}
/**
* Constructs a new {@code ConnectionSignalIdEnforcementFailedException} 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 ConnectionSignalIdEnforcementFailedException.
*/
public static ConnectionSignalIdEnforcementFailedException fromMessage(final String message,
final DittoHeaders dittoHeaders) {
return new Builder()
.dittoHeaders(dittoHeaders)
.message(message)
.build();
}
/**
* Constructs a new {@code ConnectionSignalIdEnforcementFailedException} 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 ConnectionSignalIdEnforcementFailedException.
* @throws org.eclipse.ditto.json.JsonMissingFieldException if the {@code jsonObject} does not have the {@link
* JsonFields#MESSAGE} field.
*/
public static ConnectionSignalIdEnforcementFailedException fromJson(final JsonObject jsonObject,
final DittoHeaders dittoHeaders) {
return new Builder()
.dittoHeaders(dittoHeaders)
.message(readMessage(jsonObject))
.description(readDescription(jsonObject).orElse(DEFAULT_DESCRIPTION))
.href(readHRef(jsonObject).orElse(null))
.build();
}
/**
* A mutable builder with a fluent API for a {@link ConnectionSignalIdEnforcementFailedException}.
*/
@NotThreadSafe
public static final class Builder
extends DittoRuntimeExceptionBuilder<ConnectionSignalIdEnforcementFailedException> {
private Builder() {
description(DEFAULT_DESCRIPTION);
}
private Builder(final String target) {
this();
message(MessageFormat.format(MESSAGE_TEMPLATE, target));
}
@Override
protected ConnectionSignalIdEnforcementFailedException doBuild(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
return new ConnectionSignalIdEnforcementFailedException(dittoHeaders, message, description, cause, href);
}
}
}