Package org.eclipse.ditto.signals.commands.things.exceptions

Class EventSendNotAllowedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.eclipse.ditto.model.base.exceptions.DittoRuntimeException

org.eclipse.ditto.signals.commands.things.exceptions.EventSendNotAllowedException

All Implemented Interfaces:

Serializable, org.eclipse.ditto.model.base.headers.WithDittoHeaders<org.eclipse.ditto.model.base.exceptions.DittoRuntimeException>, org.eclipse.ditto.model.base.headers.WithManifest, org.eclipse.ditto.model.base.json.Jsonifiable<org.eclipse.ditto.json.JsonObject>, org.eclipse.ditto.model.base.json.Jsonifiable.WithPredicate<org.eclipse.ditto.json.JsonObject,org.eclipse.ditto.json.JsonField>, org.eclipse.ditto.model.things.ThingException

@Immutable
public final class EventSendNotAllowedException
extends org.eclipse.ditto.model.base.exceptions.DittoRuntimeException
implements org.eclipse.ditto.model.things.ThingException

Thrown if an event cannot be send because the affected thing does not exist or because of a missing permission.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventSendNotAllowedException.Builder	A mutable builder with a fluent API for a EventSendNotAllowedException.

Nested classes/interfaces inherited from class org.eclipse.ditto.model.base.exceptions.DittoRuntimeException

org.eclipse.ditto.model.base.exceptions.DittoRuntimeException.JsonFields

Nested classes/interfaces inherited from interface org.eclipse.ditto.model.base.json.Jsonifiable

org.eclipse.ditto.model.base.json.Jsonifiable.WithFieldSelector, org.eclipse.ditto.model.base.json.Jsonifiable.WithFieldSelectorAndPredicate<T extends Object>, org.eclipse.ditto.model.base.json.Jsonifiable.WithPointer<J extends org.eclipse.ditto.json.JsonValue>, org.eclipse.ditto.model.base.json.Jsonifiable.WithPredicate<J extends org.eclipse.ditto.json.JsonValue,T extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static String	ERROR_CODE	Error code of this exception.

Fields inherited from interface org.eclipse.ditto.model.things.ThingException

ERROR_CODE_PREFIX

Constructor Summary

Constructors

Constructor	Description
EventSendNotAllowedException(String thingId)	Constructs a new EventSendNotAllowedException object.

Method Summary

Modifier and Type	Method	Description
static EventSendNotAllowedException	fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)	Deserialize from a JSON object.
static EventSendNotAllowedException	fromMessage(String message)	Deprecated. since DittoHeaders are required for the builder.
static EventSendNotAllowedException	fromMessage(String message, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)	Constructs a new EventSendNotAllowedException object with given message.
static EventSendNotAllowedException.Builder	newBuilder(org.eclipse.ditto.model.things.ThingId thingId)	A mutable builder for a MessageNotSendableException.
org.eclipse.ditto.model.base.exceptions.DittoRuntimeException	setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Methods inherited from class org.eclipse.ditto.model.base.exceptions.DittoRuntimeException

appendToJson, asDittoRuntimeException, equals, fromJson, fromMessage, fromUnknownErrorJson, getBuilder, getDescription, getDittoHeaders, getEmptyBuilder, getErrorCode, getHref, getImplementedSchemaVersion, getManifest, getStatusCode, hashCode, newBuilder, newBuilder, readDescription, readHRef, readMessage, toBuilder, toJson, toJson, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.ditto.model.base.json.Jsonifiable

getLatestSchemaVersion, getSupportedSchemaVersions, implementsSchemaVersion, implementsSchemaVersion, toJsonString

Methods inherited from interface org.eclipse.ditto.model.base.json.Jsonifiable.WithPredicate

toJson, toJsonString, toJsonString

Field Detail

ERROR_CODE

public static final String ERROR_CODE

Error code of this exception.

See Also:

Constant Field Values

Constructor Detail

EventSendNotAllowedException

public EventSendNotAllowedException(@Nullable
                                    String thingId)

Constructs a new EventSendNotAllowedException object.

Parameters:

thingId - the ID of the Thing for which an event should be sent.

Method Detail

newBuilder

public static EventSendNotAllowedException.Builder newBuilder(@Nullable
                                                              org.eclipse.ditto.model.things.ThingId thingId)

A mutable builder for a MessageNotSendableException.

Parameters:

thingId - the ID of the Thing for which an event should be sent.

Returns:

the builder.

fromMessage

@Deprecated
public static EventSendNotAllowedException fromMessage(@Nullable
                                                       String message)

Deprecated.

since DittoHeaders are required for the builder. Use #fromMessage(String, DittoHeaders) instead.

Constructs a new MessageNotSendableException object with the given exception message.

Parameters:

message - detail message. This message can be later retrieved by the Throwable.getMessage() method.

Returns:

the new SubjectInvalidException.

fromMessage

public static EventSendNotAllowedException fromMessage(@Nullable
                                                       String message,
                                                       org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Constructs a new EventSendNotAllowedException object with given message.

Parameters:

message - detail message. This message can be later retrieved by the Throwable.getMessage() method.

dittoHeaders - the headers of the command which resulted in this exception.

Returns:

the new EventSendNotAllowedException.

Throws:

NullPointerException - if dittoHeaders is null.

fromJson

public static EventSendNotAllowedException fromJson(org.eclipse.ditto.json.JsonObject jsonObject,
                                                    org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Deserialize from a JSON object.

Parameters:

jsonObject - the JSON object to deserialize.

dittoHeaders - the headers.

Returns:

an instance of this class.

Throws:

NullPointerException - if any argument is null.

org.eclipse.ditto.json.JsonMissingFieldException - if this JsonObject did not contain an error message.

org.eclipse.ditto.json.JsonParseException - if the passed in jsonObject was not in the expected format.

setDittoHeaders

public org.eclipse.ditto.model.base.exceptions.DittoRuntimeException setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Specified by:

setDittoHeaders in interface org.eclipse.ditto.model.base.headers.WithDittoHeaders<org.eclipse.ditto.model.base.exceptions.DittoRuntimeException>

Overrides:

setDittoHeaders in class org.eclipse.ditto.model.base.exceptions.DittoRuntimeException