org.eclipse.ditto.model.policies (Eclipse Ditto :: Model

Contains the Policy framework around the cornerstone of this package: Policy. A Policy consists of PolicyEntrys.

One PolicyEntry is identified by a Label and contains Subjects and Resources. The first is a list of Subject's that define for whom this entry will apply and the later defines the single Resource's together with the granted or revoked permissions for the given subjects.

Object creation

PoliciesModelFactory is the main entry point for obtaining objects of this package's interfaces to work with.

Interface Summary
Interface	Description
EffectedPermissions	Holds `Permissions` for `PermissionEffect`s (grant/revoke).
Label	Represents a `PolicyEntry`'s Label.
Permissions	This Set is dedicated to hold permissions only.
Policy	A Policy contains `PolicyEntry`s containing information about which `Subjects` are granted/revoked which `Permissions` on which `Resources`.
PolicyBuilder	A mutable builder for a `Policy` with a fluent API.
PolicyBuilder.LabelScoped	Sub-Interface extending PolicyBuilder by awareness of the `Label` to use.
PolicyEntry	Represents a single entry of a `Policy` consisting of a `label`, `subjects` and `resources`.
PolicyException	Aggregates all `DittoRuntimeException`s which are related to a `Policy`.
PolicyRevision	Represents the current revision of a Policy.
Resource	Represents a single Resource (a `JsonPointer`) in the `Resources` of a `PolicyEntry`.
ResourceKey	Represents a `Resource`'s Key.
Resources	A collection of `Resource`s contained in a single `PolicyEntry`.
Subject	Represents a single Subject in the `Subjects` of a `PolicyEntry`.
SubjectId	Represents a `Subject`'s ID.
SubjectIssuer	Represents a `Subject` issuer who has issued the subject.
Subjects	A collection of `Subject`s contained in a single `PolicyEntry`.
SubjectType	Represents a `Subject` type used in a subject for documenting what type it is.

Class Summary
Class	Description
EffectedPermissions.JsonFields	An enumeration of the known `JsonField`s of a EffectedPermissions.
PoliciesModelFactory	Factory that new `Policy` objects and other objects related to policies.
PoliciesResourceType	Contains currently "known" policy resource types and convenience methods for creating `ResourceKey`s.
Policy.JsonFields	An enumeration of the known `JsonField`s of a Policy.
PolicyConstants	Constants to support working with `Policy`.
PolicyEntry.JsonFields	An enumeration of the known `JsonField`s of a PolicyEntry.
PolicyEntryInvalidException.Builder	A mutable builder with a fluent API for a `PolicyEntryInvalidException`.
PolicyId	Java representation of a policy ID.
PolicyIdInvalidException.Builder	A mutable builder with a fluent API for a `PolicyIdInvalidException`.
PolicyTooLargeException.Builder	A mutable builder with a fluent API for a `PolicyTooLargeException`.
Resource.JsonFields	An enumeration of the known `JsonField`s of a Resource.
Subject.JsonFields	An enumeration of the known `JsonField`s of a Subject.
SubjectIdInvalidException.Builder	A mutable builder with a fluent API for a `SubjectIdInvalidException`.

Enum Summary
Enum Description

PermissionEffect
An enumeration of the available Policy permission effects.

PolicyLifecycle
An enumeration of a Policy's lifecycle.

Enum Summary
Enum	Description
PermissionEffect	An enumeration of the available `Policy` permission effects.
PolicyLifecycle	An enumeration of a Policy's lifecycle.

Exception Summary
Exception	Description
PolicyEntryInvalidException	This exception indicates that an Policy entry is invalid for some reason.
PolicyIdInvalidException	Thrown if the Policy's ID is not valid (for example if it does not comply to the Policy ID REGEX).
PolicyTooLargeException	This exception indicates the content of a Policy is too large to be processed by a backend.
SubjectIdInvalidException	Thrown if a Subject ID is not valid (it requires at least one "":"" in it).

Package org.eclipse.ditto.model.policies

Object creation