/
PolicyInvalidException.java
145 lines (125 loc) · 5.48 KB
/
PolicyInvalidException.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) 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 static org.eclipse.ditto.model.base.common.ConditionChecker.checkNotNull;
import java.net.URI;
import java.text.MessageFormat;
import java.util.Collection;
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.JsonSchemaVersion;
import org.eclipse.ditto.model.things.ThingException;
/**
* This exception indicates that a Policy is not valid for a Thing.
*/
@Immutable
public final class PolicyInvalidException extends DittoRuntimeException implements ThingException {
/**
* Error code of this exception.
*/
public static final String ERROR_CODE = ERROR_CODE_PREFIX + "policy.invalid";
/**
* Status code of this exception.
*/
static final HttpStatusCode STATUS_CODE = HttpStatusCode.BAD_REQUEST;
private static final String MESSAGE_TEMPLATE = "The Policy specified for the Thing with ID ''{0}'' is invalid.";
private static final String DESCRIPTION_TEMPLATE =
"It must contain at least one Subject with the following permission(s): ''{0}''!";
private static final long serialVersionUID = -4503670096839743360L;
private PolicyInvalidException(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
super(ERROR_CODE, STATUS_CODE, dittoHeaders, message, description, cause, href);
}
/**
* A mutable builder for a {@link PolicyInvalidException}.
*
* @param permissions the required permissions.
* @param thingId the identifier of the Thing.
* @return the builder.
*/
public static Builder newBuilder(final Collection<String> permissions, final String thingId) {
checkNotNull(permissions, "permissions");
checkNotNull(thingId, "thingId");
return new Builder(permissions, thingId);
}
/**
* A mutable builder for a {@link PolicyInvalidException} caused by some other error.
*
* @param cause reason why the policy is invalid.
* @param thingId ID of the thing the policy applies to.
* @return the builder.
*/
public static Builder newBuilderForCause(final Throwable cause, final String thingId) {
checkNotNull(cause, "cause");
checkNotNull(thingId, "thingId");
return new Builder(cause, thingId);
}
/**
* Constructs a new {@link PolicyInvalidException} object 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 {@link PolicyInvalidException}.
* @throws org.eclipse.ditto.json.JsonMissingFieldException if the {@code jsonObject} does not have the {@link
* JsonFields#MESSAGE} field.
*/
public static PolicyInvalidException fromJson(final JsonObject jsonObject, final DittoHeaders dittoHeaders) {
return new Builder()
.dittoHeaders(dittoHeaders)
.message(readMessage(jsonObject))
.description(readDescription(jsonObject).orElse(DESCRIPTION_TEMPLATE))
.href(readHRef(jsonObject).orElse(null))
.build();
}
@Override
protected DittoRuntimeExceptionBuilder<? extends DittoRuntimeException> getEmptyBuilder() {
return new Builder();
}
@Override
public JsonSchemaVersion[] getSupportedSchemaVersions() {
return new JsonSchemaVersion[]{JsonSchemaVersion.V_2};
}
/**
* A mutable builder with a fluent API for a {@link PolicyInvalidException}.
*/
@NotThreadSafe
public static final class Builder extends DittoRuntimeExceptionBuilder<PolicyInvalidException> {
private Builder() {
description(DESCRIPTION_TEMPLATE);
}
private Builder(final Collection<String> permissions, final String thingId) {
message(MessageFormat.format(MESSAGE_TEMPLATE, thingId));
description(MessageFormat.format(DESCRIPTION_TEMPLATE, permissions));
}
private Builder(final Throwable cause, final String thingId) {
message(MessageFormat.format(MESSAGE_TEMPLATE, thingId));
description(cause.getMessage());
cause(cause);
}
@Override
protected PolicyInvalidException doBuild(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
return new PolicyInvalidException(dittoHeaders, message, description, cause, href);
}
}
}