-
Notifications
You must be signed in to change notification settings - Fork 215
/
CloudEventNotParsableException.java
134 lines (114 loc) · 5.69 KB
/
CloudEventNotParsableException.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
/*
* 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.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.base.model.common.HttpStatus;
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 request with an unparsable CloudEvent is made.
*
* @since 1.5.0
*/
@Immutable
@JsonParsableException(errorCode = CloudEventNotParsableException.ERROR_CODE)
public final class CloudEventNotParsableException extends DittoRuntimeException implements GeneralException {
/**
* Error code of this exception.
*/
public static final String ERROR_CODE = ERROR_CODE_PREFIX + "cloudevent.unparsable";
private static final String DEFAULT_MESSAGE = "Unable to parse as Cloud Event.";
private static final String MESSAGE_PATTERN = "Unable to parse as Cloud Event because of: <{0}>";
private static final String DESCRIPTION = "Ensure that the event is being transmitted according to the " +
"Cloud Events HTTP binding specification v1.0 and that all mandatory headers were set.";
private static final URI DEFAULT_URI =
URI.create("https://github.com/cloudevents/spec/blob/v1.0/http-protocol-binding.md");
private static final HttpStatus HTTP_STATUS = HttpStatus.BAD_REQUEST;
/**
* Constructs a new {@code CloudEventNotParsableException} object.
*
* @param dittoHeaders the headers with which this Exception should be reported back to the user.
* @param message the detail message for later retrieval with {@link #getMessage()}.
* @param description a description with further information about the exception.
* @param cause the cause of the exception for later retrieval with {@link #getCause()}.
* @param href a link to a resource which provides further information about the exception.
* @throws NullPointerException if {@code dittoHeaders} is {@code null}.
*/
private CloudEventNotParsableException(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
super(ERROR_CODE, HTTP_STATUS, dittoHeaders, message, description, cause, href == null ? DEFAULT_URI : href);
}
/**
* A mutable builder for a {@code CloudEventNotParsableException} where the message contains detailed information
* about the parse error.
*
* @param details the details about why the CloudEvent could not be parsed.
* @return the new CloudEventNotParsableException.
*/
public static DittoRuntimeExceptionBuilder<CloudEventNotParsableException> withDetailedInformationBuilder(
final String details) {
final String msgPattern = MessageFormat.format(MESSAGE_PATTERN, details);
return new Builder().message(msgPattern).description(DESCRIPTION);
}
/**
* Constructs a new {@code CloudEventNotParsableException} object with the exception message extracted from the
* given JSON object.
*
* @param jsonObject the JSON to read the {@link org.eclipse.ditto.base.model.exceptions.DittoRuntimeException.JsonFields#MESSAGE} field from.
* @param dittoHeaders the headers of the command which resulted in this exception.
* @return the new CloudEventNotParsableException.
* @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 CloudEventNotParsableException 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.base.model.exceptions.CloudEventNotParsableException}.
*/
@NotThreadSafe
public static final class Builder extends DittoRuntimeExceptionBuilder<CloudEventNotParsableException> {
private Builder() {
message(DEFAULT_MESSAGE);
}
@Override
protected CloudEventNotParsableException doBuild(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
return new CloudEventNotParsableException(dittoHeaders, message, description, cause, href);
}
}
}