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

Class PolicyInvalidException

  • All Implemented Interfaces:
    java.io.Serializable, org.eclipse.ditto.base.model.headers.DittoHeadersSettable<org.eclipse.ditto.base.model.exceptions.DittoRuntimeException>, org.eclipse.ditto.base.model.headers.WithDittoHeaders, org.eclipse.ditto.base.model.headers.WithManifest, org.eclipse.ditto.base.model.json.Jsonifiable<org.eclipse.ditto.json.JsonObject>, org.eclipse.ditto.base.model.json.Jsonifiable.WithPredicate<org.eclipse.ditto.json.JsonObject,​org.eclipse.ditto.json.JsonField>, ThingException
    @Immutable
public final class PolicyInvalidException
extends org.eclipse.ditto.base.model.exceptions.DittoRuntimeException
implements ThingException
    This exception indicates that a Policy is not valid for a Thing.
    See Also:
    Serialized Form

    • Nested Class Summary

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

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

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

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

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

    • Field Summary

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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static PolicyInvalidException fromJson​(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Constructs a new PolicyInvalidException object from the given JSON object.
      org.eclipse.ditto.base.model.json.JsonSchemaVersion[] getSupportedSchemaVersions()  
      static PolicyInvalidException.Builder newBuilder​(java.util.Collection<java.lang.String> permissions, ThingId thingId)
      A mutable builder for a PolicyInvalidException.
      static PolicyInvalidException.Builder newBuilderForCause​(java.lang.Throwable cause, ThingId thingId)
      A mutable builder for a PolicyInvalidException caused by some other error.
      org.eclipse.ditto.base.model.exceptions.DittoRuntimeException setDittoHeaders​(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)  

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

        appendToJson, asDittoRuntimeException, equals, fromJson, fromMessage, getDescription, getDittoHeaders, getErrorCode, getHref, getHref, getHttpStatus, getHttpStatus, getImplementedSchemaVersion, getManifest, hashCode, 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.base.model.json.Jsonifiable

        getLatestSchemaVersion, implementsSchemaVersion, implementsSchemaVersion, toJsonString

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

        toJson, toJsonString, toJsonString

    • Field Detail

      • ERROR_CODE

        public static final java.lang.String ERROR_CODE
        Error code of this exception.
        See Also:
        Constant Field Values

    • Method Detail

      • newBuilder

        public static PolicyInvalidException.Builder newBuilder​(java.util.Collection<java.lang.String> permissions,
                                                        ThingId thingId)
        A mutable builder for a PolicyInvalidException.
        Parameters:
        permissions - the required permissions.
        thingId - the identifier of the Thing.
        Returns:
        the builder.

      • newBuilderForCause

        public static PolicyInvalidException.Builder newBuilderForCause​(java.lang.Throwable cause,
                                                                ThingId thingId)
        A mutable builder for a PolicyInvalidException caused by some other error.
        Parameters:
        cause - reason why the policy is invalid.
        thingId - ID of the thing the policy applies to.
        Returns:
        the builder.

      • fromJson

        public static PolicyInvalidException fromJson​(org.eclipse.ditto.json.JsonObject jsonObject,
                                              org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
        Constructs a new PolicyInvalidException object from the given JSON object.
        Parameters:
        jsonObject - the JSON to read the DittoRuntimeException.JsonFields.MESSAGE field from.
        dittoHeaders - the headers of the command which resulted in this exception.
        Returns:
        the new PolicyInvalidException.
        Throws:
        java.lang.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.

      • getSupportedSchemaVersions

        public org.eclipse.ditto.base.model.json.JsonSchemaVersion[] getSupportedSchemaVersions()
        Specified by:
        getSupportedSchemaVersions in interface org.eclipse.ditto.base.model.json.Jsonifiable<org.eclipse.ditto.json.JsonObject>

      • setDittoHeaders

        public org.eclipse.ditto.base.model.exceptions.DittoRuntimeException setDittoHeaders​(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
        Specified by:
        setDittoHeaders in interface org.eclipse.ditto.base.model.headers.DittoHeadersSettable<org.eclipse.ditto.base.model.exceptions.DittoRuntimeException>