/
MessageSendNotAllowedException.java
executable file
·132 lines (111 loc) · 4.72 KB
/
MessageSendNotAllowedException.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
/*
* 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.model.messages;
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;
/**
* Thrown if a message cannot be send because the affected thing does not exist or because of a missing permission.
*/
@Immutable
public final class MessageSendNotAllowedException extends DittoRuntimeException implements MessageException {
/**
* Error code of this exception.
*/
public static final String ERROR_CODE = ERROR_CODE_PREFIX + "send.notallowed";
private static final String MESSAGE_TEMPLATE =
"You are not allowed to send messages for the Thing with id ''{0}''!";
private static final String DEFAULT_DESCRIPTION =
"Please make sure that the Thing exists and that you have a WRITE permission on the Thing.";
private static final long serialVersionUID = -7767643705375184154L;
/**
* Constructs a new {@code MessageSendNotAllowedException} object.
*
* @param thingId the ID of the Thing for which a message should be sent.
*/
public MessageSendNotAllowedException(@Nullable final String thingId) {
this(DittoHeaders.empty(), MessageFormat.format(MESSAGE_TEMPLATE, thingId), DEFAULT_DESCRIPTION, null, null);
}
private MessageSendNotAllowedException(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
super(ERROR_CODE, HttpStatusCode.FORBIDDEN, dittoHeaders, message, description, cause, href);
}
/**
* A mutable builder for a {@code MessageNotSendableException}.
*
* @param thingId the ID of the Thing for which a message should be sent.
* @return the builder.
*/
public static Builder newBuilder(@Nullable final String thingId) {
return new Builder(thingId);
}
/**
* Constructs a new {@code MessageNotSendableException} object with the given exception message.
*
* @param message detail message. This message can be later retrieved by the {@link #getMessage()} method.
* @return the new SubjectInvalidException.
*/
public static MessageSendNotAllowedException fromMessage(@Nullable final String message) {
return new Builder()
.message(message)
.build();
}
/**
* Deserialize from a JSON object.
*
* @param jsonObject the JSON object to deserialize.
* @param dittoHeaders the headers.
* @return an instance of this class.
* @throws NullPointerException if any argument is {@code null}.
*/
public static MessageSendNotAllowedException fromJson(final JsonObject jsonObject,
final DittoHeaders dittoHeaders) {
return new Builder()
.loadJson(jsonObject)
.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 MessageSendNotAllowedException}.
*
*/
@NotThreadSafe
public static final class Builder extends DittoRuntimeExceptionBuilder<MessageSendNotAllowedException> {
private Builder() {
description(DEFAULT_DESCRIPTION);
}
private Builder(@Nullable final String subject) {
this();
message(MessageFormat.format(MESSAGE_TEMPLATE, subject));
}
@Override
protected MessageSendNotAllowedException doBuild(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
return new MessageSendNotAllowedException(dittoHeaders, message, description, cause, href);
}
}
}