/
GatewayUnknownPlaceholderException.java
103 lines (88 loc) · 4.31 KB
/
GatewayUnknownPlaceholderException.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
/*
* 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.stream.Collectors;
import java.util.stream.StreamSupport;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.NotThreadSafe;
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 placeholder which cannot be resolved.
*/
@Immutable
public final class GatewayUnknownPlaceholderException extends DittoRuntimeException implements GatewayException {
/**
* Error code of this exception.
*/
public static final String ERROR_CODE = ERROR_CODE_PREFIX + "placeholder.unknown";
private static final String MESSAGE_TEMPLATE = "The placeholder ''{0}'' is unknown.";
private static final String DESCRIPTION_TEMPLATE = "Please use one of the supported placeholders: {0}.";
private static final long serialVersionUID = -8724890154457417912L;
private GatewayUnknownPlaceholderException(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 GatewayUnknownPlaceholderException}.
*
* @param unknownPlaceholder the unknown placeholder.
* @param supportedPlaceholders the supported placeholders.
*
* @return the builder.
*/
public static Builder newBuilder(final CharSequence unknownPlaceholder,
final Iterable<CharSequence> supportedPlaceholders) {
return new Builder(requireNonNull(unknownPlaceholder), requireNonNull(supportedPlaceholders));
}
/**
* Constructs a new {@link GatewayUnknownPlaceholderException} 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 {@link GatewayUnknownPlaceholderException}.
*/
public static GatewayUnknownPlaceholderException fromMessage(final String message, final DittoHeaders dittoHeaders) {
return new Builder()
.dittoHeaders(dittoHeaders)
.message(message)
.build();
}
/**
* A mutable builder with a fluent API for a {@link GatewayUnknownPlaceholderException}.
*
*/
@NotThreadSafe
public static final class Builder extends DittoRuntimeExceptionBuilder<GatewayUnknownPlaceholderException> {
private Builder() {}
private Builder(final CharSequence issuer, final Iterable<CharSequence> supportedPlaceHolders) {
this();
message(MessageFormat.format(MESSAGE_TEMPLATE, requireNonNull(issuer)));
requireNonNull(supportedPlaceHolders);
final String supportedPlaceHoldersStr = StreamSupport.stream(supportedPlaceHolders.spliterator(), false)
.map(placeholder -> "'" + placeholder + "'")
.collect(Collectors.joining(", "));
description(MessageFormat.format(DESCRIPTION_TEMPLATE, supportedPlaceHoldersStr));
}
@Override
protected GatewayUnknownPlaceholderException doBuild(final DittoHeaders dittoHeaders,
@Nullable final String message, @Nullable final String description, @Nullable final Throwable cause,
@Nullable final URI href) {
return new GatewayUnknownPlaceholderException(dittoHeaders, message, description, cause, href);
}
}
}