/
ThingIdInvalidException.java
executable file
·134 lines (113 loc) · 5.01 KB
/
ThingIdInvalidException.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) 2017-2018 Bosch Software Innovations GmbH.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/org/documents/epl-2.0/index.php
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.model.messages;
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;
/**
* Thrown if the Thing's ID is not valid (for example if it does not comply to the Thing ID REGEX).
*/
@Immutable
public final class ThingIdInvalidException extends DittoRuntimeException implements MessageException {
/**
* Error code of this exception.
*/
public static final String ERROR_CODE = ERROR_CODE_PREFIX + "id.invalid";
private static final String MESSAGE_TEMPLATE = "Thing ID ''{0}'' is not valid!";
private static final String DEFAULT_DESCRIPTION =
"It must contain a namespace prefix (java package notation + a colon ':') + ID and must be a valid URI " +
"path segment according to RFC-2396";
private static final long serialVersionUID = -2426810319409279256L;
/**
* Constructs a new {@code ThingIdInvalidException} object.
*
* @param thingId the invalid Thing ID.
*/
public ThingIdInvalidException(final String thingId) {
this(DittoHeaders.empty(), MessageFormat.format(MESSAGE_TEMPLATE, thingId), DEFAULT_DESCRIPTION, null, null);
}
private ThingIdInvalidException(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 {@code ThingIdInvalidException}.
*
* @param thingId the ID of the thing.
* @return the builder.
*/
public static Builder newBuilder(@Nullable final CharSequence thingId) {
return new Builder(thingId);
}
/**
* Constructs a new {@code ThingIdInvalidException} object with the given exception 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 ThingIdInvalidException.
* @throws NullPointerException if {@code dittoHeaders} is {@code null}.
*/
public static ThingIdInvalidException fromMessage(@Nullable final String message, final DittoHeaders dittoHeaders) {
return new Builder()
.dittoHeaders(dittoHeaders)
.message(message)
.build();
}
/**
* Constructs a new {@code ThingIdInvalidException} 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 ThingIdInvalidException.
* @throws org.eclipse.ditto.json.JsonMissingFieldException if the {@code jsonObject} does not have the {@link
* JsonFields#MESSAGE} field.
*/
public static ThingIdInvalidException 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 ThingIdInvalidException}.
*/
@NotThreadSafe
public static final class Builder extends DittoRuntimeExceptionBuilder<ThingIdInvalidException> {
private Builder() {
description(DEFAULT_DESCRIPTION);
}
private Builder(@Nullable final CharSequence thingId) {
this();
message(MessageFormat.format(MESSAGE_TEMPLATE, thingId));
}
@Override
protected ThingIdInvalidException doBuild(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
return new ThingIdInvalidException(dittoHeaders, message, description, cause, href);
}
}
}