Package org.eclipse.hono.util
Class RegistryManagementConstants
- java.lang.Object
-
- org.eclipse.hono.util.RequestResponseApiConstants
-
- org.eclipse.hono.util.RegistryManagementConstants
-
public final class RegistryManagementConstants extends RequestResponseApiConstants
Constants & utility methods used throughout the Device Management API.
-
-
Field Summary
Fields Modifier and Type Field Description static String
API_VERSION
The current version of the API.static String
CREDENTIALS_HTTP_ENDPOINT
The name of the Device Registration HTTP API endpoint.static String
DEFAULT_DEVICE_ID_PATTERN
The default regular expression to validate device IDs supplied when creating devices are legal.static int
DEFAULT_MINIMUM_MESSAGE_SIZE
The default message size is set to 0, which implies no minimum size is defined.static String
DEFAULT_TENANT_ID_PATTERN
The default regular expression to validate tenant IDs supplied when creating tenants are legal.static String
DEVICES_HTTP_ENDPOINT
The name of the Credentials Registration HTTP API endpoint.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_AUTH_ID
The name of the field that contains the authentication identifier.static String
FIELD_COMMENT
The name of the field that contains a comment for the credentials.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 a tenant's data volume limits.static String
FIELD_DEVICES
The name of the JSON array containing device registration information for a tenant.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_FILTER_FIELD
The name of the field that contains the JSON pointer corresponding to the field used for filtering devices.static String
FIELD_FILTER_OPERATOR
The name of the field that contains the operator used for filtering devices.static String
FIELD_FILTER_VALUE
The name of the field that contains the value used for filtering devices.static String
FIELD_ID
The name of the field that contains the id of the entity (e.g.static String
FIELD_MAPPER
The name of the field that contains the name of a service that can be used to transform messages uploaded by the device before they are forwarded to downstream consumers.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_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_MEMBER_OF
The name of the field that contains the names of the gateway groups that the (gateway) device is a member of.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_RESULT_SET_PAGE
The name of the field that contains the result of the search devices operation.static String
FIELD_RESULT_SET_SIZE
The name of the field that contains the total number of objects in the result set of the search devices operation.static String
FIELD_SECRETS
The name of the field that contains the secret(s) of the credentials.static String
FIELD_SECRETS_COMMENT
The name of the field that contains the comment about the secret.static String
FIELD_SECRETS_HASH_FUNCTION
The name of the field that contains the name of the hash function used for a hashed password.static String
FIELD_SECRETS_KEY
The name of the field that contains a (pre-shared) key.static String
FIELD_SECRETS_NOT_AFTER
The name of the field that contains the latest point in time a secret may be used for authentication.static String
FIELD_SECRETS_NOT_BEFORE
The name of the field that contains the earliest point in time a secret may be used for authentication.static String
FIELD_SECRETS_PWD_HASH
The name of the field that contains the password hash.static String
FIELD_SECRETS_PWD_PLAIN
The name of the field that contains the clear text password.static String
FIELD_SECRETS_SALT
The name of the field that contains the salt for the password hash.static String
FIELD_SORT_DIRECTION
The name of the field that contains sort direction used by search devices operation to sort the result set.static String
FIELD_STATUS
The name of the field that contains the status data for the device.static String
FIELD_STATUS_CREATION_DATE
The name of the field that contains the creation date of the device.static String
FIELD_STATUS_LAST_UPDATE
The name of the field that contains the last update date of the device.static String
FIELD_STATUS_LAST_USER
The name of the field that contains the last user that edited the device.static String
FIELD_TENANT
The name of the JSON property containing the tenant ID.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
FIELD_TYPE
The name of the field that contains the type of credentials.static String
FIELD_VIA
The name of the field that contains the identifiers of those gateways that may act on behalf of the device.static String
FIELD_VIA_GROUPS
The name of the field that contains the identifiers of groups of gateways that may act on behalf of the device.static String
HASH_FUNCTION_BCRYPT
The name of the BCrypt hash function.static String
HASH_FUNCTION_SHA256
The name of the SHA-256 hash function.static String
PARAM_FILTER_JSON
The name of the query parameter that contains the filter JSON object for search devices operation.static String
PARAM_PAGE_OFFSET
The name of the query parameter that contains the page offset for search devices operation.static String
PARAM_PAGE_SIZE
The name of the query parameter that contains the page size for search devices operation.static String
PARAM_SORT_JSON
The name of the query parameter that contains the sort JSON object used by search devices operation to sort the result set.static String
SECRETS_TYPE_HASHED_PASSWORD
The type name that indicates a hashed password secret.static String
SECRETS_TYPE_PRESHARED_KEY
The type name that indicates a pre-shared key secret.static String
SECRETS_TYPE_X509_CERT
The type name that indicates an X.509 client certificate secret.static String
TENANT_HTTP_ENDPOINT
The name of the HTTP endpoint for the Tenant API.-
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
-
-
-
-
Field Detail
-
API_VERSION
public static final String API_VERSION
The current version of the API.- See Also:
- Constant Field Values
-
DEVICES_HTTP_ENDPOINT
public static final String DEVICES_HTTP_ENDPOINT
The name of the Credentials Registration HTTP API endpoint.- See Also:
- Constant Field Values
-
CREDENTIALS_HTTP_ENDPOINT
public static final String CREDENTIALS_HTTP_ENDPOINT
The name of the Device Registration HTTP API endpoint.- See Also:
- Constant Field Values
-
TENANT_HTTP_ENDPOINT
public static final String TENANT_HTTP_ENDPOINT
The name of the HTTP endpoint for the Tenant API.- See Also:
- Constant Field Values
-
FIELD_VIA
public static final String FIELD_VIA
The name of the field that contains the identifiers of those gateways that may act on behalf of the device.- See Also:
- Constant Field Values
-
FIELD_VIA_GROUPS
public static final String FIELD_VIA_GROUPS
The name of the field that contains the identifiers of groups of gateways that may act on behalf of the device.- See Also:
- Constant Field Values
-
FIELD_STATUS
public static final String FIELD_STATUS
The name of the field that contains the status data for the device. The status object contains the creation date, the last edit date and the last user.- See Also:
- Constant Field Values
-
FIELD_STATUS_CREATION_DATE
public static final String FIELD_STATUS_CREATION_DATE
The name of the field that contains the creation date of the device.- See Also:
- Constant Field Values
-
FIELD_STATUS_LAST_UPDATE
public static final String FIELD_STATUS_LAST_UPDATE
The name of the field that contains the last update date of the device.- See Also:
- Constant Field Values
-
FIELD_STATUS_LAST_USER
public static final String FIELD_STATUS_LAST_USER
The name of the field that contains the last user that edited the device.- See Also:
- Constant Field Values
-
FIELD_MAPPER
public static final String FIELD_MAPPER
The name of the field that contains the name of a service that can be used to transform messages uploaded by the device before they are forwarded to downstream consumers.- See Also:
- Constant Field Values
-
FIELD_MEMBER_OF
public static final String FIELD_MEMBER_OF
The name of the field that contains the names of the gateway groups that the (gateway) device is a member of.- See Also:
- Constant Field Values
-
FIELD_FILTER_FIELD
public static final String FIELD_FILTER_FIELD
The name of the field that contains the JSON pointer corresponding to the field used for filtering devices.- See Also:
- Constant Field Values
-
PARAM_FILTER_JSON
public static final String PARAM_FILTER_JSON
The name of the query parameter that contains the filter JSON object for search devices operation.- See Also:
- Constant Field Values
-
FIELD_FILTER_OPERATOR
public static final String FIELD_FILTER_OPERATOR
The name of the field that contains the operator used for filtering devices.- See Also:
- Constant Field Values
-
FIELD_FILTER_VALUE
public static final String FIELD_FILTER_VALUE
The name of the field that contains the value used for filtering devices.- See Also:
- Constant Field Values
-
PARAM_PAGE_OFFSET
public static final String PARAM_PAGE_OFFSET
The name of the query parameter that contains the page offset for search devices operation.- See Also:
- Constant Field Values
-
PARAM_PAGE_SIZE
public static final String PARAM_PAGE_SIZE
The name of the query parameter that contains the page size for search devices operation.- See Also:
- Constant Field Values
-
FIELD_SORT_DIRECTION
public static final String FIELD_SORT_DIRECTION
The name of the field that contains sort direction used by search devices operation to sort the result set.- See Also:
- Constant Field Values
-
PARAM_SORT_JSON
public static final String PARAM_SORT_JSON
The name of the query parameter that contains the sort JSON object used by search devices operation to sort the result set.- See Also:
- Constant Field Values
-
FIELD_RESULT_SET_SIZE
public static final String FIELD_RESULT_SET_SIZE
The name of the field that contains the total number of objects in the result set of the search devices operation.- See Also:
- Constant Field Values
-
FIELD_RESULT_SET_PAGE
public static final String FIELD_RESULT_SET_PAGE
The name of the field that contains the result of the search devices operation.- See Also:
- Constant Field Values
-
FIELD_COMMENT
public static final String FIELD_COMMENT
The name of the field that contains a comment for the credentials.- See Also:
- Constant Field Values
-
FIELD_TYPE
public static final String FIELD_TYPE
The name of the field that contains the type of credentials.- See Also:
- Constant Field Values
-
FIELD_AUTH_ID
public static final String FIELD_AUTH_ID
The name of the field that contains the authentication identifier.- See Also:
- Constant Field Values
-
FIELD_SECRETS
public static final String FIELD_SECRETS
The name of the field that contains the secret(s) of the credentials.- 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_ID
public static final String FIELD_ID
The name of the field that contains the id of the entity (e.g. secret id).- See Also:
- Constant Field Values
-
FIELD_SECRETS_PWD_HASH
public static final String FIELD_SECRETS_PWD_HASH
The name of the field that contains the password hash.- See Also:
- Constant Field Values
-
FIELD_SECRETS_PWD_PLAIN
public static final String FIELD_SECRETS_PWD_PLAIN
The name of the field that contains the clear text password.- See Also:
- Constant Field Values
-
FIELD_SECRETS_SALT
public static final String FIELD_SECRETS_SALT
The name of the field that contains the salt for the password hash.- See Also:
- Constant Field Values
-
FIELD_SECRETS_HASH_FUNCTION
public static final String FIELD_SECRETS_HASH_FUNCTION
The name of the field that contains the name of the hash function used for a hashed password.- See Also:
- Constant Field Values
-
FIELD_SECRETS_KEY
public static final String FIELD_SECRETS_KEY
The name of the field that contains a (pre-shared) key.- See Also:
- Constant Field Values
-
FIELD_SECRETS_NOT_BEFORE
public static final String FIELD_SECRETS_NOT_BEFORE
The name of the field that contains the earliest point in time a secret may be used for authentication.- See Also:
- Constant Field Values
-
FIELD_SECRETS_NOT_AFTER
public static final String FIELD_SECRETS_NOT_AFTER
The name of the field that contains the latest point in time a secret may be used for authentication.- See Also:
- Constant Field Values
-
FIELD_SECRETS_COMMENT
public static final String FIELD_SECRETS_COMMENT
The name of the field that contains the comment about the secret.- See Also:
- Constant Field Values
-
SECRETS_TYPE_X509_CERT
public static final String SECRETS_TYPE_X509_CERT
The type name that indicates an X.509 client certificate secret.- See Also:
- Constant Field Values
-
SECRETS_TYPE_HASHED_PASSWORD
public static final String SECRETS_TYPE_HASHED_PASSWORD
The type name that indicates a hashed password secret.- See Also:
- Constant Field Values
-
SECRETS_TYPE_PRESHARED_KEY
public static final String SECRETS_TYPE_PRESHARED_KEY
The type name that indicates a pre-shared key secret.- See Also:
- Constant Field Values
-
HASH_FUNCTION_BCRYPT
public static final String HASH_FUNCTION_BCRYPT
The name of the BCrypt hash function.- See Also:
- Constant Field Values
-
HASH_FUNCTION_SHA256
public static final String HASH_FUNCTION_SHA256
The name of the SHA-256 hash function.- 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
-
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_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 a tenant's data volume limits.- See Also:
- Constant Field Values
-
FIELD_DEVICES
public static final String FIELD_DEVICES
The name of the JSON array containing device registration information for a tenant.- 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_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_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_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
-
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_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_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_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_TENANT
public static final String FIELD_TENANT
The name of the JSON property containing the tenant ID.- 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 aTracingSamplingMode
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 aTracingSamplingMode
value.- See Also:
- Constant Field Values
-
DEFAULT_TENANT_ID_PATTERN
public static final String DEFAULT_TENANT_ID_PATTERN
The default regular expression to validate tenant IDs supplied when creating tenants are legal.- See Also:
- Constant Field Values
-
DEFAULT_DEVICE_ID_PATTERN
public static final String DEFAULT_DEVICE_ID_PATTERN
The default regular expression to validate device IDs supplied when creating devices are legal.- See Also:
- Constant Field Values
-
-