-
Notifications
You must be signed in to change notification settings - Fork 214
/
AcknowledgementLabelInvalidException.java
145 lines (125 loc) · 5.48 KB
/
AcknowledgementLabelInvalidException.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
/*
* 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.acks;
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.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;
/**
* Thrown if an AcknowledgementLabel is not valid, for example because it did not comply to the AcknowledgmentLabel
* regex.
*
* @since 1.1.0
*/
@Immutable
@JsonParsableException(errorCode = AcknowledgementLabelInvalidException.ERROR_CODE)
public final class AcknowledgementLabelInvalidException extends DittoRuntimeException
implements AcknowledgementException {
/**
* Error code of this exception.
*/
public static final String ERROR_CODE = ERROR_CODE_PREFIX + "label.invalid";
private static final String MESSAGE_TEMPLATE = "Acknowledgement label <{0}> is invalid.";
private static final String DEFAULT_DESCRIPTION =
"An acknowledgement label must conform to the regular expression of Ditto documentation.";
private static final URI DEFAULT_HREF = URI.create(
"https://www.eclipse.dev/ditto/protocol-specification-topic.html#acknowledgement-criterion-actions");
private static final long serialVersionUID = -2385649293006205966L;
private AcknowledgementLabelInvalidException(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);
}
/**
* Constructs a new {@code AcknowledgementLabelInvalidException} object.
*
* @param label the label that causes the exception.
*/
public AcknowledgementLabelInvalidException(final CharSequence label) {
this(DittoHeaders.empty(),
MessageFormat.format(MESSAGE_TEMPLATE, label),
DEFAULT_DESCRIPTION,
null,
DEFAULT_HREF);
}
/**
* Create an {@code AcknowledgementLabelInvalidException} with custom description, hyperlink and headers.
*
* @param label the invalid label.
* @param description the custom description.
* @param href hyperlink in the exception.
* @param dittoHeaders the headers of the exception.
* @return the exception.
* @since 1.4.0
*/
public static AcknowledgementLabelInvalidException of(final CharSequence label,
@Nullable final String description,
@Nullable final URI href,
final DittoHeaders dittoHeaders) {
return new AcknowledgementLabelInvalidException(dittoHeaders, MessageFormat.format(MESSAGE_TEMPLATE, label),
description, null, href);
}
/**
* Constructs a new {@code AcknowledgementLabelInvalidException} object with the exception message extracted from
* the given JSON object.
*
* @param jsonObject the JSON object representation of the returned exception.
* @param dittoHeaders the headers of the command which resulted in this exception.
* @return the new exception.
* @throws NullPointerException if any argument is {@code null}.
* @throws org.eclipse.ditto.json.JsonMissingFieldException if the {@code jsonObject} misses a required field.
* @throws org.eclipse.ditto.json.JsonParseException if {@code jsonObject} contained an unexpected value type.
*/
public static AcknowledgementLabelInvalidException 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();
}
@NotThreadSafe
private static class Builder extends DittoRuntimeExceptionBuilder<AcknowledgementLabelInvalidException> {
private Builder() {
description(DEFAULT_DESCRIPTION);
href(DEFAULT_HREF);
}
@Override
protected AcknowledgementLabelInvalidException doBuild(final DittoHeaders dittoHeaders,
@Nullable final String message, @Nullable final String description, @Nullable final Throwable cause,
@Nullable final URI href) {
return new AcknowledgementLabelInvalidException(dittoHeaders, message, description, cause, href);
}
}
}