/
FeaturePropertyNotAccessibleException.java
executable file
·125 lines (108 loc) · 5.19 KB
/
FeaturePropertyNotAccessibleException.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
/*
* 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.signals.commands.things.exceptions;
import java.net.URI;
import java.text.MessageFormat;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.NotThreadSafe;
import org.eclipse.ditto.json.JsonObject;
import org.eclipse.ditto.json.JsonPointer;
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.things.ThingException;
/**
* This exception indicates, that the requested Property does not exist or the request has insufficient rights.
*/
@Immutable
public final class FeaturePropertyNotAccessibleException extends DittoRuntimeException implements ThingException {
/**
* Error code of this exception.
*/
public static final String ERROR_CODE = ERROR_CODE_PREFIX + "feature.property.notfound";
private static final String MESSAGE_TEMPLATE =
"The Property with JSON Pointer ''{0}'' of the Feature with ID ''{1}'' "
+
"on the Thing with ID ''{2}'' does not exist or the requester had insufficient permissions to access it.";
private static final String DEFAULT_DESCRIPTION =
"Check if the ID of the Thing, the Feature ID and the key of your requested property"
+ " was correct and you have sufficient permissions.";
private static final long serialVersionUID = -1793783227991859251L;
private FeaturePropertyNotAccessibleException(final DittoHeaders dittoHeaders, final String message,
final String description, final Throwable cause, final URI href) {
super(ERROR_CODE, HttpStatusCode.NOT_FOUND, dittoHeaders, message, description, cause, href);
}
/**
* A mutable builder for a {@code FeaturePropertyNotAccessibleException}.
*
* @param thingId the ID of the Thing.
* @param featureId the ID of the Feature.
* @param jsonPointer the JSON Pointer of the Property.
* @return the builder.
*/
public static Builder newBuilder(final String thingId, final String featureId, final JsonPointer jsonPointer) {
return new Builder(thingId, featureId, jsonPointer);
}
/**
* Constructs a new {@code FeaturePropertyNotAccessibleException} 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 FeaturePropertyNotAccessibleException.
*/
public static FeaturePropertyNotAccessibleException fromMessage(final String message,
final DittoHeaders dittoHeaders) {
return new Builder()
.dittoHeaders(dittoHeaders)
.message(message)
.build();
}
/**
* Constructs a new {@code FeaturePropertyNotAccessibleException} 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 FeaturePropertyNotAccessibleException.
* @throws org.eclipse.ditto.json.JsonMissingFieldException if the {@code jsonObject} does not have the {@link
* JsonFields#MESSAGE} field.
*/
public static FeaturePropertyNotAccessibleException 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 FeaturePropertyNotAccessibleException}.
*
*/
@NotThreadSafe
public static final class Builder extends DittoRuntimeExceptionBuilder<FeaturePropertyNotAccessibleException> {
private Builder() {
description(DEFAULT_DESCRIPTION);
}
private Builder(final String thingId, final String featureId, final JsonPointer jsonPointer) {
this();
message(MessageFormat.format(MESSAGE_TEMPLATE, jsonPointer, featureId, thingId));
}
@Override
protected FeaturePropertyNotAccessibleException doBuild(final DittoHeaders dittoHeaders,
final String message,
final String description, final Throwable cause, final URI href) {
return new FeaturePropertyNotAccessibleException(dittoHeaders, message, description, cause, href);
}
}
}