Package org.eclipse.ditto.model.things
Contains the Things framework around the cornerstone of this package:
Thing
.
A Thing can consist of
- an
AccessControlList
which contains thePermission
s ofAuthorizationSubject
s on that Thing, Attributes
for describing the Thing in more details,- and
Features
for managing all data and functionality of the Thing.
Furthermore a Thing can have a ThingLifecycle
and a
ThingRevision
which is incremented with each change of the Thing.
Object creation
ThingsModelFactory
is the main entry point for obtaining objects of this
package's interfaces to work with.-
Interface Summary Interface Description AccessControlList Deprecated. AccessControlLists belong to deprecated API version 1.AccessControlListBuilder Deprecated. AccessControlLists belong to deprecated API version 1.AclEntry Deprecated. AccessControlLists belong to deprecated API version 1.Attributes Attributes
describe other entities (e.AttributesBuilder A mutable builder for aAttributes
with a fluent API.DefinitionIdentifier This interface represents a single fully qualified Identifier of aDefinition
both used forThing
andFeature
.Feature A Feature is used to manage all data and functionality of aThing
that can be clustered in an outlined technical context.FeatureBuilder A mutable builder for for aFeature
which uses Object Scoping and Method Chaining to provide a fluent API.FeatureBuilder.FeatureBuildable This interface eventually allows create a newFeature
object.FeatureBuilder.FromCopyBuildable A mutable builder with a fluent API for an immutableFeature
.FeatureBuilder.FromJsonBuildable This interface enables the creation of aFeature
object from JSON.FeatureBuilder.FromScratchBuildable This interface enables the creation of aFeature
object from scratch.FeatureDefinition A FeatureDefinition is a list of fully qualifiedDefinitionIdentifier
s.FeatureDefinitionBuilder A mutable builder with a fluent API for an immutableFeatureDefinition
.FeatureProperties Represents data related toFeature
s.FeaturePropertiesBuilder A mutable builder for aFeatureProperties
with a fluent API.Features FeaturesBuilder A mutable builder for aFeature
with a fluent API.Permissions Deprecated. Permissions belong to deprecated API version 1.Thing A generic entity which can be used as a "handle" for multipleFeature
s belonging to this Thing.ThingBuilder Builder for instances ofThing
which uses Object Scoping and Method Chaining to provide a convenient usage experience.ThingBuilder.FromCopy A mutable builder with a fluent API for an immutableThing
.ThingBuilder.FromScratch A mutable builder with a fluent API for an immutableThing
from scratch.ThingDefinition A ThingDefinition represents a single fully qualifiedDefinitionIdentifier
.ThingException Aggregates allDittoRuntimeException
s which are related to aThing
.ThingRevision Represents the current revision of a Thing.WithThingId Implementations of this interface are associated to aThing
identified by the value returned fromgetThingEntityId()
()}. -
Class Summary Class Description AccessControlListModelFactory Deprecated. AccessControlLists belong to deprecated API version 1.AclEntryInvalidException.Builder A mutable builder with a fluent API for aAclEntryInvalidException
.AclInvalidException.Builder A mutable builder with a fluent API for aAclInvalidException
.AclNotAllowedException.Builder A mutable builder with a fluent API for aAclNotAllowedException
.AclValidator Deprecated. AccessControlLists belong to deprecated API version 1.AttributesModelFactory Factory that creates newattributes
objects.DefinitionIdentifierInvalidException.Builder A mutable builder with a fluent API for an immutableDefinitionIdentifierInvalidException
.Feature.JsonFields An enumeration of the knownJsonField
s of a Feature.FeatureDefinitionEmptyException.Builder A mutable builder with a fluent API for an immutableFeatureDefinitionEmptyException
.PolicyIdMissingException.Builder A mutable builder with a fluent API for aPolicyIdMissingException
.Thing.JsonFields An enumeration of the knownJsonField
s of a Thing.ThingAclValidator Deprecated. AccessControlLists belong to deprecated API version 1.ThingConstants Constants to support working withThing
.ThingId Java representation of a validated Thing ID.ThingIdInvalidException.Builder A mutable builder with a fluent API for aThingIdInvalidException
.ThingsModelFactory Factory that creates newthings
objects.ThingTooLargeException.Builder A mutable builder with a fluent API for aThingTooLargeException
. -
Enum Summary Enum Description Permission Deprecated. Permissions belong to deprecated API version 1.ThingLifecycle An enumeration of a Thing's lifecycle. -
Exception Summary Exception Description AclEntryInvalidException Deprecated. AccessControlLists belong to deprecated API version 1.AclInvalidException Deprecated. AccessControlLists belong to deprecated API version 1.AclNotAllowedException Deprecated. AccessControlLists belong to deprecated API version 1.DefinitionIdentifierInvalidException This exception is thrown if an Identifier of a Feature Definition has an invalid structure.FeatureDefinitionEmptyException This exception is thrown if a Feature Definition was set to an empty array.PolicyIdMissingException This exception indicates that aThing
'sJsonSchemaVersion
requires a policyId.ThingIdInvalidException Thrown if the Thing's ID is not valid (for example if it does not comply to the Thing ID REGEX).ThingTooLargeException This exception indicates the content of a Thing is too large to be processed by a backend.