org.eclipse.ditto.signals.commands.things.modify

Class ModifyAclEntryResponse

java.lang.Object

org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<ModifyAclEntryResponse>

org.eclipse.ditto.signals.commands.things.modify.ModifyAclEntryResponse

All Implemented Interfaces:

org.eclipse.ditto.model.base.headers.WithDittoHeaders<ModifyAclEntryResponse>, 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.signals.base.Signal<ModifyAclEntryResponse>, org.eclipse.ditto.signals.base.WithId, org.eclipse.ditto.signals.base.WithName, org.eclipse.ditto.signals.base.WithOptionalEntity, org.eclipse.ditto.signals.base.WithResource, org.eclipse.ditto.signals.base.WithThingId, org.eclipse.ditto.signals.base.WithType, org.eclipse.ditto.signals.commands.base.CommandResponse<ModifyAclEntryResponse>, ThingModifyCommandResponse<ModifyAclEntryResponse>, ThingCommandResponse<ModifyAclEntryResponse>

@Immutable
public final class ModifyAclEntryResponse
extends org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<ModifyAclEntryResponse>
implements ThingModifyCommandResponse<ModifyAclEntryResponse>

Response to a ModifyAclEntry command.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.ditto.signals.commands.things.ThingCommandResponse

ThingCommandResponse.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>, 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>

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE Type of this response.

Fields inherited from interface org.eclipse.ditto.signals.commands.things.ThingCommandResponse

TYPE_PREFIX

Fields inherited from interface org.eclipse.ditto.signals.commands.base.CommandResponse

TYPE_QUALIFIER

Method Summary

Modifier and Type	Method and Description
protected void	appendPayload(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder, org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion, Predicate<org.eclipse.ditto.json.JsonField> predicate)
protected boolean	canEqual(Object other)
static ModifyAclEntryResponse	created(String thingId, org.eclipse.ditto.model.things.AclEntry aclEntry, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Returns a new ModifyAclEntryResponse for a created AclEntry.
boolean	equals(Object o)
static ModifyAclEntryResponse	fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a response to a ModifyAclEntry command from a JSON object.
static ModifyAclEntryResponse	fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a response to a ModifyAcl command from a JSON string.
org.eclipse.ditto.model.things.AclEntry	getAclEntry() Returns the modified ACL entry.
Optional<org.eclipse.ditto.json.JsonValue>	getEntity(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)
org.eclipse.ditto.json.JsonPointer	getResourcePath()
org.eclipse.ditto.model.base.json.JsonSchemaVersion[]	getSupportedSchemaVersions() ModifyAclEntryResponse is only available in JsonSchemaVersion V_1.
String	getThingId()
int	hashCode()
static ModifyAclEntryResponse	modified(String thingId, org.eclipse.ditto.model.things.AclEntry aclEntry, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Returns a new ModifyAclEntryResponse for a modified AclEntry.
ModifyAclEntryResponse	setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
String	toString()

Methods inherited from class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse

getDittoHeaders, getManifest, getStatusCode, getType, toJson

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ditto.signals.commands.things.ThingCommandResponse

getId, getResourceType

Methods inherited from interface org.eclipse.ditto.signals.commands.base.CommandResponse

getImplementedSchemaVersion, getStatusCode, getStatusCodeValue, toJson, toJson

Methods inherited from interface org.eclipse.ditto.signals.base.Signal

getName

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

toJson, toJsonString, toJsonString

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

getLatestSchemaVersion, implementsSchemaVersion, implementsSchemaVersion, toJsonString

Methods inherited from interface org.eclipse.ditto.model.base.headers.WithDittoHeaders

getDittoHeaders

Methods inherited from interface org.eclipse.ditto.model.base.headers.WithManifest

getManifest

Methods inherited from interface org.eclipse.ditto.signals.base.WithType

getType

Methods inherited from interface org.eclipse.ditto.signals.base.WithOptionalEntity

getEntity

Field Detail

TYPE

public static final String TYPE

Type of this response.

See Also:

Constant Field Values

Method Detail

created

public static ModifyAclEntryResponse created(String thingId,
                                             org.eclipse.ditto.model.things.AclEntry aclEntry,
                                             org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Returns a new ModifyAclEntryResponse for a created AclEntry. This corresponds to the HTTP status code HttpStatusCode.CREATED.

Parameters:

thingId - the Thing ID of the created ACL entry.

aclEntry - the created AclEntry.

dittoHeaders - the headers of the ThingCommand which caused the new response.

Returns:

a command response for a created Thing.

Throws:

NullPointerException - if any argument is null.

modified

public static ModifyAclEntryResponse modified(String thingId,
                                              org.eclipse.ditto.model.things.AclEntry aclEntry,
                                              org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Returns a new ModifyAclEntryResponse for a modified AclEntry. This corresponds to the HTTP status code HttpStatusCode.NO_CONTENT.

Parameters:

thingId - the Thing ID of the modified ACL entry.

aclEntry - the modified AclEntry.

dittoHeaders - the headers of the ThingCommand which caused the new response.

Returns:

a command response for a modified Thing.

Throws:

NullPointerException - any argument is null.

fromJson

public static ModifyAclEntryResponse fromJson(String jsonString,
                                              org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a response to a ModifyAcl command from a JSON string.

Parameters:

jsonString - the JSON string of which the response is to be created.

dittoHeaders - the headers of the preceding command.

Returns:

the response.

Throws:

NullPointerException - if any argument is null.

IllegalArgumentException - if jsonString is empty.

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

fromJson

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

Creates a response to a ModifyAclEntry command from a JSON object.

Parameters:

jsonObject - the JSON object of which the response is to be created.

dittoHeaders - the headers of the preceding command.

Returns:

the response.

Throws:

NullPointerException - any argument is null.

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

getThingId

public String getThingId()

Specified by:

getThingId in interface org.eclipse.ditto.signals.base.WithThingId

getAclEntry

public org.eclipse.ditto.model.things.AclEntry getAclEntry()

Returns the modified ACL entry.

Returns:

the ACL entry.

getEntity

public Optional<org.eclipse.ditto.json.JsonValue> getEntity(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)

Specified by:

getEntity in interface org.eclipse.ditto.signals.base.WithOptionalEntity

getResourcePath

public org.eclipse.ditto.json.JsonPointer getResourcePath()

Specified by:

getResourcePath in interface org.eclipse.ditto.signals.base.WithResource

appendPayload

protected void appendPayload(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder,
                             org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion,
                             Predicate<org.eclipse.ditto.json.JsonField> predicate)

Specified by:

appendPayload in class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<ModifyAclEntryResponse>

setDittoHeaders

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

Specified by:

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

Specified by:

setDittoHeaders in interface org.eclipse.ditto.signals.commands.base.CommandResponse<ModifyAclEntryResponse>

Specified by:

setDittoHeaders in interface ThingModifyCommandResponse<ModifyAclEntryResponse>

Specified by:

setDittoHeaders in interface ThingCommandResponse<ModifyAclEntryResponse>

getSupportedSchemaVersions

public org.eclipse.ditto.model.base.json.JsonSchemaVersion[] getSupportedSchemaVersions()

ModifyAclEntryResponse is only available in JsonSchemaVersion V_1.

Specified by:

getSupportedSchemaVersions in interface org.eclipse.ditto.model.base.json.Jsonifiable<org.eclipse.ditto.json.JsonObject>

Returns:

the supported JsonSchemaVersions of ModifyAclEntryResponse.

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<ModifyAclEntryResponse>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<ModifyAclEntryResponse>

hashCode

public int hashCode()

Overrides:

hashCode in class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<ModifyAclEntryResponse>

toString

public String toString()

Overrides:

toString in class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<ModifyAclEntryResponse>