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

Class DeleteAclEntry

java.lang.Object

org.eclipse.ditto.signals.commands.base.AbstractCommand<DeleteAclEntry>

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

All Implemented Interfaces:

org.eclipse.ditto.model.base.entity.type.WithEntityType, org.eclipse.ditto.model.base.headers.WithDittoHeaders<DeleteAclEntry>, 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.WithThingId, org.eclipse.ditto.signals.base.Signal<DeleteAclEntry>, 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.WithType, org.eclipse.ditto.signals.commands.base.Command<DeleteAclEntry>, ThingModifyCommand<DeleteAclEntry>, ThingCommand<DeleteAclEntry>

@Deprecated
@Immutable
public final class DeleteAclEntry
extends org.eclipse.ditto.signals.commands.base.AbstractCommand<DeleteAclEntry>
implements ThingModifyCommand<DeleteAclEntry>

Deprecated.

AccessControlLists belong to deprecated API version 1. Use API version 2 with policies instead.

This command deletes one single ACL entry of a Thing. Contains the authorizationSubject of the ACL to delete.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.ditto.signals.commands.base.Command

org.eclipse.ditto.signals.commands.base.Command.Category, org.eclipse.ditto.signals.commands.base.Command.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>

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

ThingCommand.JsonFields

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME	Deprecated. Name of this command.
static String	TYPE	Deprecated. Type of this command.

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

TYPE_QUALIFIER

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

RESOURCE_TYPE, TYPE_PREFIX

Method Summary

Modifier and Type	Method	Description
protected void	appendPayload(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder, org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion, Predicate<org.eclipse.ditto.json.JsonField> thePredicate)	Deprecated.
protected boolean	canEqual(Object other)	Deprecated.
boolean	changesAuthorization()	Deprecated. Checks whether this command may change authorization of the Thing.
boolean	equals(Object obj)	Deprecated.
static DeleteAclEntry	fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)	Deprecated. Creates a new DeleteAclEntry from a JSON string.
static DeleteAclEntry	fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)	Deprecated. Creates a new DeleteAclEntry from a JSON object.
org.eclipse.ditto.model.base.auth.AuthorizationSubject	getAuthorizationSubject()	Deprecated. Returns the subject of the ACL entry to be deleted.
org.eclipse.ditto.signals.commands.base.Command.Category	getCategory()	Deprecated.
org.eclipse.ditto.json.JsonPointer	getResourcePath()	Deprecated.
org.eclipse.ditto.model.things.ThingId	getThingEntityId()	Deprecated.
int	hashCode()	Deprecated.
static DeleteAclEntry	of(String thingId, org.eclipse.ditto.model.base.auth.AuthorizationSubject authorizationSubject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)	Deprecated. Thing ID is now typed.
static DeleteAclEntry	of(org.eclipse.ditto.model.things.ThingId thingId, org.eclipse.ditto.model.base.auth.AuthorizationSubject authorizationSubject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)	Deprecated. Returns a command for deleting one single ACL entry of a Thing.
DeleteAclEntry	setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)	Deprecated.
String	toString()	Deprecated.

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

getDittoHeaders, getManifest, 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.base.Command

getImplementedSchemaVersion, toJson, toJson

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

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

getName

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

getEntityId, getEntityType, getResourceType, getTypePrefix

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

getDittoHeaders

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

getId

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

getManifest

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

getEntity, getEntity

Methods inherited from interface org.eclipse.ditto.model.things.WithThingId

getThingId

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

getType

Field Detail

NAME

public static final String NAME

Deprecated.

Name of this command.

See Also:

Constant Field Values

TYPE

public static final String TYPE

Deprecated.

Type of this command.

See Also:

Constant Field Values

Method Detail

of

@Deprecated
public static DeleteAclEntry of(String thingId,
                                org.eclipse.ditto.model.base.auth.AuthorizationSubject authorizationSubject,
                                org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Deprecated.

Thing ID is now typed. Use of(org.eclipse.ditto.model.things.ThingId, org.eclipse.ditto.model.base.auth.AuthorizationSubject, org.eclipse.ditto.model.base.headers.DittoHeaders) instead.

Returns a command for deleting one single ACL entry of a Thing. The ACL entry's authorizationSubject is passed as identifier of which ACL entry to delete.

Parameters:

thingId - the Thing's key.

authorizationSubject - the subject of the ACL entry to delete.

dittoHeaders - the headers of the command.

Returns:

a command for deleting a Thing's ACL entry.

Throws:

NullPointerException - if any argument but thingId is null.

of

public static DeleteAclEntry of(org.eclipse.ditto.model.things.ThingId thingId,
                                org.eclipse.ditto.model.base.auth.AuthorizationSubject authorizationSubject,
                                org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Deprecated.

Returns a command for deleting one single ACL entry of a Thing. The ACL entry's authorizationSubject is passed as identifier of which ACL entry to delete.

Parameters:

thingId - the Thing's key.

authorizationSubject - the subject of the ACL entry to delete.

dittoHeaders - the headers of the command.

Returns:

a command for deleting a Thing's ACL entry.

Throws:

NullPointerException - if any argument but thingId is null.

fromJson

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

Deprecated.

Creates a new DeleteAclEntry from a JSON string.

Parameters:

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

dittoHeaders - the headers of the command.

Returns:

the command.

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.

org.eclipse.ditto.model.things.ThingIdInvalidException - if thingId does not comply to RegexPatterns.ID_REGEX.

fromJson

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

Deprecated.

Creates a new DeleteAclEntry from a JSON object.

Parameters:

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

dittoHeaders - the headers of the command.

Returns:

the command.

Throws:

NullPointerException - if any argument is null.

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

org.eclipse.ditto.model.things.ThingIdInvalidException - if thingId does not comply to RegexPatterns.ID_REGEX.

getAuthorizationSubject

public org.eclipse.ditto.model.base.auth.AuthorizationSubject getAuthorizationSubject()

Deprecated.

Returns the subject of the ACL entry to be deleted.

Returns:

the subject.

getThingEntityId

public org.eclipse.ditto.model.things.ThingId getThingEntityId()

Deprecated.

Specified by:

getThingEntityId in interface org.eclipse.ditto.model.things.WithThingId

getResourcePath

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

Deprecated.

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> thePredicate)

Deprecated.

Specified by:

appendPayload in class org.eclipse.ditto.signals.commands.base.AbstractCommand<DeleteAclEntry>

getCategory

public org.eclipse.ditto.signals.commands.base.Command.Category getCategory()

Deprecated.

Specified by:

getCategory in interface org.eclipse.ditto.signals.commands.base.Command<DeleteAclEntry>

setDittoHeaders

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

Deprecated.

Specified by:

setDittoHeaders in interface org.eclipse.ditto.signals.commands.base.Command<DeleteAclEntry>

Specified by:

setDittoHeaders in interface ThingCommand<DeleteAclEntry>

Specified by:

setDittoHeaders in interface ThingModifyCommand<DeleteAclEntry>

Specified by:

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

changesAuthorization

public boolean changesAuthorization()

Deprecated.

Description copied from interface: ThingModifyCommand

Checks whether this command may change authorization of the Thing.

Specified by:

changesAuthorization in interface ThingModifyCommand<DeleteAclEntry>

Returns:

true if authorization would change, false otherwise.

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class org.eclipse.ditto.signals.commands.base.AbstractCommand<DeleteAclEntry>

equals

public boolean equals(@Nullable
                      Object obj)

Deprecated.

Overrides:

equals in class org.eclipse.ditto.signals.commands.base.AbstractCommand<DeleteAclEntry>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Deprecated.

Overrides:

canEqual in class org.eclipse.ditto.signals.commands.base.AbstractCommand<DeleteAclEntry>

toString

public String toString()

Deprecated.

Overrides:

toString in class org.eclipse.ditto.signals.commands.base.AbstractCommand<DeleteAclEntry>