Package org.eclipse.hono.util

Class TenantConstants

java.lang.Object
org.eclipse.hono.util.RequestResponseApiConstants
org.eclipse.hono.util.TenantConstants
public final class TenantConstants extends RequestResponseApiConstants
Constants & utility methods used throughout the Tenant API.

  • Field Details

    • DEFAULT_MAX_TTD

      public static final int DEFAULT_MAX_TTD
      The default number of seconds that a protocol adapter should wait for an upstream command.
      See Also:

    • DEFAULT_MINIMUM_MESSAGE_SIZE

      public static final int DEFAULT_MINIMUM_MESSAGE_SIZE
      The default message size is set to 0, which implies no minimum size is defined.
      See Also:

    • UNLIMITED_BYTES

      public static final long UNLIMITED_BYTES
      The value indicating an unlimited number of bytes to be allowed for a tenant.
      See Also:

    • UNLIMITED_CONNECTIONS

      public static final int UNLIMITED_CONNECTIONS
      The value indicating an unlimited number of connections to be allowed for a tenant.
      See Also:

    • UNLIMITED_MINUTES

      public static final long UNLIMITED_MINUTES
      The value indicating an unlimited number of minutes to be allowed for a tenant.
      See Also:

    • UNLIMITED_TTL

      public static final long UNLIMITED_TTL
      The value indicating unlimited time-to-live for downstream events.
      See Also:

    • FIELD_ADAPTERS

      public static final String FIELD_ADAPTERS
      The name of the property that contains configuration options for specific protocol adapters.
      See Also:

    • FIELD_ADAPTERS_TYPE

      public static final String FIELD_ADAPTERS_TYPE
      The name of the property that contains the type name of a protocol adapter.
      See Also:

    • FIELD_ADAPTERS_DEVICE_AUTHENTICATION_REQUIRED

      public static final String FIELD_ADAPTERS_DEVICE_AUTHENTICATION_REQUIRED
      The name of the property that indicates whether a protocol adapter requires all devices to authenticate.
      See Also:

    • FIELD_AUTO_PROVISIONING_ENABLED

      public static final String FIELD_AUTO_PROVISIONING_ENABLED
      The name of the property that indicates whether a CA cert can be used to automatically provision new devices.
      See Also:

    • FIELD_CONNECTION_DURATION

      public static final String FIELD_CONNECTION_DURATION
      The name of the property that contains the configuration options to limit the device connection duration of tenants.
      See Also:

    • FIELD_DATA_VOLUME

      public static final String FIELD_DATA_VOLUME
      The name of the property that contains the configuration options for the data volume.
      See Also:

    • FIELD_EFFECTIVE_SINCE

      public static final String FIELD_EFFECTIVE_SINCE
      The name of the property that contains the date on which the data volume limit came into effect.
      See Also:

    • FIELD_EXT

      public static final String FIELD_EXT
      The name of the field that contains the extension fields.
      See Also:

    • FIELD_MINIMUM_MESSAGE_SIZE

      public static final String FIELD_MINIMUM_MESSAGE_SIZE
      The name of the property that contains the minimum message size in bytes.
      See Also:

    • FIELD_MAX_BYTES

      public static final String FIELD_MAX_BYTES
      The name of the property that contains the maximum number of bytes to be allowed for a tenant.
      See Also:

    • FIELD_MAX_CONNECTIONS

      public static final String FIELD_MAX_CONNECTIONS
      The name of the property that contains the maximum number of connections to be allowed for a tenant.
      See Also:

    • FIELD_MAX_MINUTES

      public static final String FIELD_MAX_MINUTES
      The name of the property that contains the maximum connection duration in minutes to be allowed for a tenant.
      See Also:

    • FIELD_MAX_TTD

      public static final String FIELD_MAX_TTD
      The name of the property that contains the maximum time til disconnect (seconds) that protocol adapters should use for a tenant.
      See Also:

    • FIELD_MAX_TTL

      public static final String FIELD_MAX_TTL
      The name of the property that contains the maximum time to live (seconds) for downstream events that protocol adapters should use for a tenant.
      See Also:

    • FIELD_MAX_TTL_TELEMETRY_QOS0

      public static final String FIELD_MAX_TTL_TELEMETRY_QOS0
      The name of the property that contains the maximum time to live (seconds) for downstream QoS 0 telemetry messages that protocol adapters should use for a tenant.
      See Also:

    • FIELD_MAX_TTL_TELEMETRY_QOS1

      public static final String FIELD_MAX_TTL_TELEMETRY_QOS1
      The name of the property that contains the maximum time to live (seconds) for downstream QoS 1 telemetry messages that protocol adapters should use for a tenant.
      See Also:

    • FIELD_MAX_TTL_COMMAND_RESPONSE

      public static final String FIELD_MAX_TTL_COMMAND_RESPONSE
      The name of the property that contains the maximum time to live (seconds) for downstream command response messages that protocol adapters should use for a tenant.
      See Also:

    • FIELD_PAYLOAD_KEY_ALGORITHM

      public static final String FIELD_PAYLOAD_KEY_ALGORITHM
      The name of the property that contains the algorithm used for a public key.
      See Also:

    • FIELD_PAYLOAD_CERT

      public static final String FIELD_PAYLOAD_CERT
      The name of the property that contains the Base64 encoded (binary) DER encoding of the trusted certificate configured for a tenant.
      See Also:

    • FIELD_PAYLOAD_PUBLIC_KEY

      public static final String FIELD_PAYLOAD_PUBLIC_KEY
      The name of the property that contains the Base64 encoded DER encoding of the public key of the trusted certificate authority configured for a tenant.
      See Also:

    • FIELD_PAYLOAD_TRUSTED_CA

      public static final String FIELD_PAYLOAD_TRUSTED_CA
      The name of the property that contains the trusted certificate authority configured for a tenant.
      See Also:

    • FIELD_PERIOD

      public static final String FIELD_PERIOD
      The name of the property that contains the period details for which the data usage is calculated.
      See Also:

    • FIELD_PERIOD_NO_OF_DAYS

      public static final String FIELD_PERIOD_NO_OF_DAYS
      The name of the property that contains the number of days for which the data usage is calculated.
      See Also:

    • FIELD_PERIOD_MODE

      public static final String FIELD_PERIOD_MODE
      The name of the property that contains the mode of the period for which the data usage is calculated.
      See Also:

    • FIELD_RESOURCE_LIMITS

      public static final String FIELD_RESOURCE_LIMITS
      The name of the property that contains the configuration options for the resource limits.
      See Also:

    • FIELD_TRACING

      public static final String FIELD_TRACING
      The name of the property that defines tenant-specific tracing options.
      See Also:

    • FIELD_TRACING_SAMPLING_MODE

      public static final String FIELD_TRACING_SAMPLING_MODE
      The name of the property that defines in how far spans created when processing messages for a tenant shall be recorded (sampled) by the tracing system. The property contains a TracingSamplingMode value.
      See Also:

    • FIELD_TRACING_SAMPLING_MODE_PER_AUTH_ID

      public static final String FIELD_TRACING_SAMPLING_MODE_PER_AUTH_ID
      The name of the property that defines in how far spans created when processing messages for a tenant and a particular auth-id shall be recorded (sampled) by the tracing system. The property contains a JsonObject with fields having a auth-id as name and a TracingSamplingMode value.
      See Also:

    • FIELD_TTL_TELEMETRY_QOS0

      public static final String FIELD_TTL_TELEMETRY_QOS0
      The name of the property that contains the time to live (seconds) for downstream QoS 0 telemetry messages that protocol adapters should use for a tenant if a device does not specify a TTL explicitly.
      See Also:

    • FIELD_TTL_TELEMETRY_QOS1

      public static final String FIELD_TTL_TELEMETRY_QOS1
      The name of the property that contains the time to live (seconds) for downstream QoS 1 telemetry messages that protocol adapters should use for a tenant if a device does not specify a TTL explicitly.
      See Also:

    • FIELD_TTL_COMMAND_RESPONSE

      public static final String FIELD_TTL_COMMAND_RESPONSE
      The name of the property that contains the time to live (seconds) for downstream command response messages that protocol adapters should use for a tenant if a device does not specify a TTL explicitly.
      See Also:

    • FIELD_EXT_MESSAGING_TYPE

      public static final String FIELD_EXT_MESSAGING_TYPE
      The name of the property that defines the messaging type to be used for a tenant.
      See Also:

    • FIELD_EXT_INVALIDATE_CACHE_ON_UPDATE

      public static final String FIELD_EXT_INVALIDATE_CACHE_ON_UPDATE
      The name of the property that indicates if cache invalidation is required on update operations.
      See Also:

    • TENANT_ENDPOINT

      public static final String TENANT_ENDPOINT
      The name of the Tenant API endpoint.
      See Also: