forked from eclipse-ditto/ditto
-
Notifications
You must be signed in to change notification settings - Fork 7
/
PolicyActionFailedException.java
executable file
·188 lines (162 loc) · 6.85 KB
/
PolicyActionFailedException.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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
/*
* 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.model.policies;
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;
import org.eclipse.ditto.model.base.json.JsonParsableException;
import org.eclipse.ditto.model.base.json.JsonSchemaVersion;
/**
* Thrown if an action on a policy failed.
*/
@Immutable
@JsonParsableException(errorCode = PolicyActionFailedException.ERROR_CODE)
public final class PolicyActionFailedException extends DittoRuntimeException implements PolicyException {
/**
* Error code of this exception.
*/
public static final String ERROR_CODE = ERROR_CODE_PREFIX + "action.failed";
/**
* The action {@code activateTokenIntegration}.
*/
public static final String ACTIVATE_TOKEN_INTEGRATION = "activateTokenIntegration";
/**
* The action {@code deactivateTokenIntegration}.
*/
public static final String DEACTIVATE_TOKEN_INTEGRATION = "deactivateTokenIntegration";
private static final HttpStatusCode DEFAULT_STATUS = HttpStatusCode.INTERNAL_SERVER_ERROR;
private static final String MESSAGE_TEMPLATE = "Failed to execute action ''{0}''.";
private static final String DEFAULT_DESCRIPTION = "Please contact the service team.";
private PolicyActionFailedException(final DittoHeaders dittoHeaders,
final HttpStatusCode status,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
super(ERROR_CODE, status, dittoHeaders, message, description, cause, href);
}
/**
* A mutable builder for a {@code PolicyActionFailedException} for the action {@code activateTokenIntegration}.
*
* @return the builder.
*/
public static DittoRuntimeExceptionBuilder<PolicyActionFailedException> newBuilderForActivateTokenIntegration() {
return new Builder().action(ACTIVATE_TOKEN_INTEGRATION);
}
/**
* A mutable builder for a {@code PolicyActionFailedException} for the action {@code deactivateTokenIntegration}.
*
* @return the builder.
*/
public static DittoRuntimeExceptionBuilder<PolicyActionFailedException> newBuilderForDeactivateTokenIntegration() {
return new Builder().action(DEACTIVATE_TOKEN_INTEGRATION);
}
/**
* A mutable builder for a {@code PolicyActionFailedException} due to inappropriate authentication method.
*
* @param action the failed action.
* @return the exception builder.
*/
public static DittoRuntimeExceptionBuilder<PolicyActionFailedException>
newBuilderForInappropriateAuthenticationMethod(final String action) {
return new Builder().action(action)
.status(HttpStatusCode.BAD_REQUEST)
.description("Policy action is only possible with JWT authentication.");
}
/**
* A mutable builder for when a deactivation failed due to matching permanent subjects.
*
* @return the builder.
*/
public static DittoRuntimeExceptionBuilder<PolicyActionFailedException>
newBuilderForDeactivatingPermanentSubjects() {
return new Builder()
.action(DEACTIVATE_TOKEN_INTEGRATION)
.status(HttpStatusCode.BAD_REQUEST)
.description("Some matched subjects are permanent.");
}
/**
* Constructs a new {@code PolicyActionFailedException} object with the exception content extracted from the
* given JSON object.
*
* @param jsonObject the JSON to read the exception content from.
* @param dittoHeaders the headers of the command which resulted in this exception.
* @return the new PolicyActionFailedException.
* @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 PolicyActionFailedException fromJson(final JsonObject jsonObject, final DittoHeaders dittoHeaders) {
return DittoRuntimeException.fromJson(jsonObject, dittoHeaders, new Builder());
}
@Override
public JsonSchemaVersion[] getSupportedSchemaVersions() {
return new JsonSchemaVersion[]{JsonSchemaVersion.V_2};
}
@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 PolicyActionFailedException}.
*/
@NotThreadSafe
public static final class Builder extends DittoRuntimeExceptionBuilder<PolicyActionFailedException> {
private HttpStatusCode status = DEFAULT_STATUS;
private Builder() {
description(DEFAULT_DESCRIPTION);
}
/**
* Set the error message to mention the failed action.
*
* @param action the failed action.
* @return this builder.
*/
public Builder action(final String action) {
message(MessageFormat.format(MESSAGE_TEMPLATE, action));
return this;
}
/**
* Set the status code.
*
* @param status the status code.
* @return this builder.
*/
public Builder status(final HttpStatusCode status) {
this.status = status;
return this;
}
@Override
protected PolicyActionFailedException doBuild(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
return new PolicyActionFailedException(dittoHeaders, status, message, description, cause, href);
}
}
}