Package org.eclipse.hono.util
Class TenantConstants
java.lang.Object
org.eclipse.hono.util.RequestResponseApiConstants
org.eclipse.hono.util.TenantConstants
Constants & utility methods used throughout the Tenant API.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Request actions that belong to the Tenant API. -
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The default number of seconds that a protocol adapter should wait for an upstream command.static final int
The default message size is set to 0, which implies no minimum size is defined.static final String
The name of the property that contains configuration options for specific protocol adapters.static final String
The name of the property that indicates whether a protocol adapter requires all devices to authenticate.static final String
The name of the property that contains the type name of a protocol adapter.static final String
The name of the property that indicates whether a CA cert can be used to automatically provision new devices.static final String
The name of the property that contains the configuration options to limit the device connection duration of tenants.static final String
The name of the property that contains the configuration options for the data volume.static final String
The name of the property that contains the date on which the data volume limit came into effect.static final String
The name of the field that contains the extension fields.static final String
The name of the property that indicates if cache invalidation is required on update operations.static final String
The name of the property that defines the messaging type to be used for a tenant.static final String
The name of the property that contains the maximum number of bytes to be allowed for a tenant.static final String
The name of the property that contains the maximum number of connections to be allowed for a tenant.static final String
The name of the property that contains the maximum connection duration in minutes to be allowed for a tenant.static final String
The name of the property that contains the maximum time til disconnect (seconds) that protocol adapters should use for a tenant.static final String
The name of the property that contains the maximum time to live (seconds) for downstream events that protocol adapters should use for a tenant.static final String
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.static final String
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.static final String
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.static final String
The name of the property that contains the minimum message size in bytes.static final String
The name of the property that contains the Base64 encoded (binary) DER encoding of the trusted certificate configured for a tenant.static final String
The name of the property that contains the algorithm used for a public key.static final String
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.static final String
The name of the property that contains the trusted certificate authority configured for a tenant.static final String
The name of the property that contains the period details for which the data usage is calculated.static final String
The name of the property that contains the mode of the period for which the data usage is calculated.static final String
The name of the property that contains the number of days for which the data usage is calculated.static final String
The name of the property that contains the configuration options for the resource limits.static final String
The name of the property that defines tenant-specific tracing options.static final String
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.static final String
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.static final String
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.static final String
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.static final String
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.static final String
The name of the Tenant API endpoint.static final long
The value indicating an unlimited number of bytes to be allowed for a tenant.static final int
The value indicating an unlimited number of connections to be allowed for a tenant.static final long
The value indicating an unlimited number of minutes to be allowed for a tenant.static final long
The value indicating unlimited time-to-live for downstream events.Fields inherited from class org.eclipse.hono.util.RequestResponseApiConstants
FIELD_AUTO_PROVISIONED, FIELD_AUTO_PROVISIONING_NOTIFICATION_SENT, FIELD_ENABLED, FIELD_ERROR, FIELD_OBJECT_ID, FIELD_PAYLOAD, FIELD_PAYLOAD_AUTH_ID_TEMPLATE, FIELD_PAYLOAD_DEFAULTS, FIELD_PAYLOAD_DEVICE_ID, FIELD_PAYLOAD_SUBJECT_DN, FIELD_PAYLOAD_TENANT_ID
-
Method Summary
-
Field Details
-
DEFAULT_MAX_TTD
public static final int DEFAULT_MAX_TTDThe 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_SIZEThe default message size is set to 0, which implies no minimum size is defined.- See Also:
-
UNLIMITED_BYTES
public static final long UNLIMITED_BYTESThe value indicating an unlimited number of bytes to be allowed for a tenant.- See Also:
-
UNLIMITED_CONNECTIONS
public static final int UNLIMITED_CONNECTIONSThe value indicating an unlimited number of connections to be allowed for a tenant.- See Also:
-
UNLIMITED_MINUTES
public static final long UNLIMITED_MINUTESThe value indicating an unlimited number of minutes to be allowed for a tenant.- See Also:
-
UNLIMITED_TTL
public static final long UNLIMITED_TTLThe value indicating unlimited time-to-live for downstream events.- See Also:
-
FIELD_ADAPTERS
The name of the property that contains configuration options for specific protocol adapters.- See Also:
-
FIELD_ADAPTERS_TYPE
The name of the property that contains the type name of a protocol adapter.- See Also:
-
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
The name of the property that indicates whether a CA cert can be used to automatically provision new devices.- See Also:
-
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
The name of the property that contains the configuration options for the data volume.- See Also:
-
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
The name of the field that contains the extension fields.- See Also:
-
FIELD_MINIMUM_MESSAGE_SIZE
The name of the property that contains the minimum message size in bytes.- See Also:
-
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
The name of the property that contains the maximum number of connections to be allowed for a tenant.- See Also:
-
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
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
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
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
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
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
The name of the property that contains the algorithm used for a public key.- See Also:
-
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
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
The name of the property that contains the trusted certificate authority configured for a tenant.- See Also:
-
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
The name of the property that contains the number of days for which the data usage is calculated.- See Also:
-
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
The name of the property that contains the configuration options for the resource limits.- See Also:
-
FIELD_TRACING
The name of the property that defines tenant-specific tracing options.- See Also:
-
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 aTracingSamplingMode
value.- See Also:
-
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 aTracingSamplingMode
value.- See Also:
-
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
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
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
The name of the property that defines the messaging type to be used for a tenant.- See Also:
-
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
The name of the Tenant API endpoint.- See Also:
-