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.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class TenantConstants.TenantAction
Request actions that belong to the Tenant API.

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`DEFAULT_MAX_TTD`	The default number of seconds that a protocol adapter should wait for an upstream command.
`static int`	`DEFAULT_MINIMUM_MESSAGE_SIZE`	The default message size is set to 0, which implies no minimum size is defined.
`static String`	`FIELD_ADAPTERS`	The name of the property that contains configuration options for specific protocol adapters.
`static String`	`FIELD_ADAPTERS_DEVICE_AUTHENTICATION_REQUIRED`	The name of the property that indicates whether a protocol adapter requires all devices to authenticate.
`static String`	`FIELD_ADAPTERS_TYPE`	The name of the property that contains the type name of a protocol adapter.
`static String`	`FIELD_AUTO_PROVISIONING_ENABLED`	The name of the property that indicates whether a CA cert can be used to automatically provision new devices.
`static String`	`FIELD_CONNECTION_DURATION`	The name of the property that contains the configuration options to limit the device connection duration of tenants.
`static String`	`FIELD_DATA_VOLUME`	The name of the property that contains the configuration options for the data volume.
`static String`	`FIELD_EFFECTIVE_SINCE`	The name of the property that contains the date on which the data volume limit came into effect.
`static String`	`FIELD_EXT`	The name of the field that contains the extension fields.
`static String`	`FIELD_MAX_BYTES`	The name of the property that contains the maximum number of bytes to be allowed for a tenant.
`static String`	`FIELD_MAX_CONNECTIONS`	The name of the property that contains the maximum number of connections to be allowed for a tenant.
`static String`	`FIELD_MAX_MINUTES`	The name of the property that contains the maximum connection duration in minutes to be allowed for a tenant.
`static 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.
`static 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.
`static String`	`FIELD_MINIMUM_MESSAGE_SIZE`	The name of the property that contains the minimum message size in bytes.
`static 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.
`static String`	`FIELD_PAYLOAD_KEY_ALGORITHM`	The name of the property that contains the algorithm used for a public key.
`static 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.
`static String`	`FIELD_PAYLOAD_TRUSTED_CA`	The name of the property that contains the trusted certificate authority configured for a tenant.
`static String`	`FIELD_PERIOD`	The name of the property that contains the period details for which the data usage is calculated.
`static String`	`FIELD_PERIOD_MODE`	The name of the property that contains the mode of the period for which the data usage is calculated.
`static String`	`FIELD_PERIOD_NO_OF_DAYS`	The name of the property that contains the number of days for which the data usage is calculated.
`static String`	`FIELD_RESOURCE_LIMITS`	The name of the property that contains the configuration options for the resource limits.
`static String`	`FIELD_TRACING`	The name of the property that defines tenant-specific tracing options.
`static 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.
`static 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.
`static String`	`TENANT_ENDPOINT`	The name of the Tenant API endpoint.
`static long`	`UNLIMITED_BYTES`	The value indicating an unlimited number of bytes to be allowed for a tenant.
`static int`	`UNLIMITED_CONNECTIONS`	The value indicating an unlimited number of connections to be allowed for a tenant.
`static long`	`UNLIMITED_MINUTES`	The value indicating an unlimited number of minutes to be allowed for a tenant.
`static long`	`UNLIMITED_TTL`	The value indicating unlimited time-to-live for downstream events.

Fields inherited from class org.eclipse.hono.util.RequestResponseApiConstants
CONTENT_TYPE_APPLICATION_JSON, FIELD_ENABLED, FIELD_ERROR, FIELD_OBJECT_ID, FIELD_PAYLOAD, FIELD_PAYLOAD_DEFAULTS, FIELD_PAYLOAD_DEVICE_ID, FIELD_PAYLOAD_SUBJECT_DN, FIELD_PAYLOAD_TENANT_ID

Method Summary
- Methods inherited from class org.eclipse.hono.util.RequestResponseApiConstants
  getAmqpReply, getAmqpReply, getErrorMessage
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - UNLIMITED_BYTES
```
public static final long UNLIMITED_BYTES
```
    The value indicating an unlimited number of bytes to be allowed for a tenant.
    
    See Also:
    
    Constant Field Values
  - UNLIMITED_CONNECTIONS
```
public static final int UNLIMITED_CONNECTIONS
```
    The value indicating an unlimited number of connections to be allowed for a tenant.
    
    See Also:
    
    Constant Field Values
  - UNLIMITED_MINUTES
```
public static final long UNLIMITED_MINUTES
```
    The value indicating an unlimited number of minutes to be allowed for a tenant.
    
    See Also:
    
    Constant Field Values
  - UNLIMITED_TTL
```
public static final long UNLIMITED_TTL
```
    The value indicating unlimited time-to-live for downstream events.
    
    See Also:
    
    Constant Field Values
  - FIELD_ADAPTERS
```
public static final String FIELD_ADAPTERS
```
    The name of the property that contains configuration options for specific protocol adapters.
    
    See Also:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - FIELD_EXT
```
public static final String FIELD_EXT
```
    The name of the field that contains the extension fields.
    
    See Also:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - TENANT_ENDPOINT
```
public static final String TENANT_ENDPOINT
```
    The name of the Tenant API endpoint.
    
    See Also:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - FIELD_TRACING
```
public static final String FIELD_TRACING
```
    The name of the property that defines tenant-specific tracing options.
    
    See Also:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values

Class TenantConstants

Nested Class Summary

Field Summary

Fields inherited from class org.eclipse.hono.util.RequestResponseApiConstants

Method Summary

Methods inherited from class org.eclipse.hono.util.RequestResponseApiConstants

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_TTD

DEFAULT_MINIMUM_MESSAGE_SIZE

UNLIMITED_BYTES

UNLIMITED_CONNECTIONS

UNLIMITED_MINUTES

UNLIMITED_TTL

FIELD_ADAPTERS

FIELD_ADAPTERS_TYPE

FIELD_ADAPTERS_DEVICE_AUTHENTICATION_REQUIRED

FIELD_AUTO_PROVISIONING_ENABLED

FIELD_CONNECTION_DURATION

FIELD_DATA_VOLUME

FIELD_EFFECTIVE_SINCE

FIELD_EXT

FIELD_MAX_BYTES

FIELD_MAX_CONNECTIONS

FIELD_MAX_MINUTES

FIELD_MAX_TTD

FIELD_MAX_TTL

FIELD_PAYLOAD_KEY_ALGORITHM

FIELD_PAYLOAD_CERT

FIELD_PAYLOAD_PUBLIC_KEY

FIELD_PAYLOAD_TRUSTED_CA

FIELD_PERIOD

FIELD_PERIOD_NO_OF_DAYS

FIELD_PERIOD_MODE

FIELD_MINIMUM_MESSAGE_SIZE

TENANT_ENDPOINT

FIELD_RESOURCE_LIMITS

FIELD_TRACING

FIELD_TRACING_SAMPLING_MODE

FIELD_TRACING_SAMPLING_MODE_PER_AUTH_ID