/
GatewayPlaceholderReferenceNotSupportedException.java
119 lines (102 loc) · 5.23 KB
/
GatewayPlaceholderReferenceNotSupportedException.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
/*
* 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.base.exceptions;
import static java.util.Objects.requireNonNull;
import java.net.URI;
import java.text.MessageFormat;
import java.util.Set;
import java.util.stream.Collectors;
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;
/**
* This exception indicates that a request contains a reference placeholder which references an unsupported entity type.
*/
@Immutable
public final class GatewayPlaceholderReferenceNotSupportedException extends DittoRuntimeException
implements GatewayException {
/**
* Error code of this exception.
*/
public static final String ERROR_CODE = ERROR_CODE_PREFIX + "placeholder.reference.notsupported";
private static final String MESSAGE_TEMPLATE = "The placeholder references a not supported entity: ''{0}''.";
private static final String DESCRIPTION_TEMPLATE = "Please reference one of the supported entities: {0}.";
private static final String DESCRIPTION_WITHOUT_SUPPORTED_ENTITIES =
"Please reference one of the supported entities.";
private static final long serialVersionUID = -8724860134957013912L;
private GatewayPlaceholderReferenceNotSupportedException(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 {@link GatewayPlaceholderReferenceNotSupportedException} for an unsupported referenced
* entity type.
*
* @param unsupportedEntityType the unknown placeholder.
* @param supportedEntityTypes the supported placeholders.
* @return the builder.
*/
public static Builder fromUnsupportedEntityType(final CharSequence unsupportedEntityType,
final Set<CharSequence> supportedEntityTypes) {
requireNonNull(unsupportedEntityType);
requireNonNull(supportedEntityTypes);
final String message = MessageFormat.format(MESSAGE_TEMPLATE, requireNonNull(unsupportedEntityType));
final String supportedEntitiesStr = supportedEntityTypes.stream()
.map(supportedEntityType -> "'" + supportedEntityType + "'")
.collect(Collectors.joining(", "));
final String description = MessageFormat.format(DESCRIPTION_TEMPLATE, supportedEntitiesStr);
return new Builder(message, description);
}
/**
* Constructs a new {@code GatewayPlaceholderNotResolvableException} object with the exception message extracted
* from the given JSON object.
*
* @param jsonObject the JSON to read the {@link org.eclipse.ditto.model.base.exceptions.DittoRuntimeException.JsonFields#MESSAGE} field from.
* @param dittoHeaders the headers of the command which resulted in this exception.
* @return the new GatewayPlaceholderNotResolvableException.
* @throws org.eclipse.ditto.json.JsonMissingFieldException if the {@code jsonObject} does not have
* the {@link org.eclipse.ditto.model.base.exceptions.DittoRuntimeException.JsonFields#MESSAGE} field.
*/
public static GatewayPlaceholderReferenceNotSupportedException fromJson(final JsonObject jsonObject,
final DittoHeaders dittoHeaders) {
return new Builder()
.dittoHeaders(dittoHeaders)
.message(readMessage(jsonObject))
.description(readDescription(jsonObject).orElse(DESCRIPTION_WITHOUT_SUPPORTED_ENTITIES))
.build();
}
/**
* A mutable builder with a fluent API for a {@link GatewayPlaceholderReferenceNotSupportedException}.
*/
@NotThreadSafe
public static final class Builder
extends DittoRuntimeExceptionBuilder<GatewayPlaceholderReferenceNotSupportedException> {
private Builder() {}
private Builder(final String message, final String description) {
this();
message(requireNonNull(message));
description(requireNonNull(description));
}
@Override
protected GatewayPlaceholderReferenceNotSupportedException doBuild(final DittoHeaders dittoHeaders,
@Nullable final String message, @Nullable final String description, @Nullable final Throwable cause,
@Nullable final URI href) {
return new GatewayPlaceholderReferenceNotSupportedException(dittoHeaders, message, description, cause,
href);
}
}
}