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
ACTION_CREATE
The vert.x event bus event message subject property to use for the create operations.static String
ACTION_DELETE
The vert.x event bus event message subject property to use for the delete operations.static String
ACTION_GET
The vert.x event bus event message subject property to use for the get operations.static String
ACTION_UPDATE
The vert.x event bus event message subject property to use for the update operations.static String
API_VERSION
The current version of the API.static String
CREDENTIALS_ENDPOINT
The Credential service's endpoint name.static String
CREDENTIALS_HTTP_ENDPOINT
The name of the Device Registration HTTP API endpoint.static String
CREDENTIALS_OBJECT
The name of the property that contains credentials object in event bus message.static String
DEFAULT_HASH_FUNCTION
The name of the default hash function to use for hashed passwords if not set explicitly.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
DEVICES_HTTP_ENDPOINT
The name of the Credentials Registration HTTP API endpoint.static String
EVENT_BUS_ADDRESS_CREDENTIALS_MANAGEMENT_IN
The vert.x event bus address to which inbound credentials management messages are published.static String
EVENT_BUS_ADDRESS_DEVICE_MANAGEMENT_IN
The vert.x event bus address to which inbound registration messages are published.static String
EVENT_BUS_ADDRESS_TENANT_IN
The vert.x event bus address to which inbound registration messages are published.static String
EVENT_BUS_ADDRESS_TENANT_MANAGEMENT_IN
The vert.x event bus address to which inbound management messages are published.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_CREDENTIALS_TOTAL
The name of the field that contains the number of credentials contained in a message.static String
FIELD_DEVICES
The name of the JSON array containing device registration information for a tenant.static String
FIELD_EXT
The name of the field that contains the extension fields.static String
FIELD_ID
The name of the field that contains the id of the entity (e.g.static String
FIELD_MAX_TTD
The name of the property that contains the maximum time til disconnect 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_RESOURCE_LIMITS
The name of the property that contains the configuration options for the resource limits.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_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
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
HASH_FUNCTION_SHA512
The name of the SHA-512 hash function.static String
MESSAGE_ID_PREFIX
Messages that are sent by the Hono client for the Tenant API use this as a prefix for the messageId.static String
REGISTRATION_HTTP_ENDPOINT
The name of the Device Registration HTTP API endpoint.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
SPECIFIER_WILDCARD
The name of the field that contains the pattern to use for matching authentication identifiers.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
All Methods Static Methods Concrete Methods Modifier and Type Method Description static boolean
isValidAction(String action)
Checks if a given string represents a valid action.-
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
-
ACTION_CREATE
public static final String ACTION_CREATE
The vert.x event bus event message subject property to use for the create operations.- See Also:
- Constant Field Values
-
ACTION_GET
public static final String ACTION_GET
The vert.x event bus event message subject property to use for the get operations.- See Also:
- Constant Field Values
-
ACTION_DELETE
public static final String ACTION_DELETE
The vert.x event bus event message subject property to use for the delete operations.- See Also:
- Constant Field Values
-
ACTION_UPDATE
public static final String ACTION_UPDATE
The vert.x event bus event message subject property to use for the update operations.- 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
-
CREDENTIALS_OBJECT
public static final String CREDENTIALS_OBJECT
The name of the property that contains credentials object in event bus message.- See Also:
- Constant Field Values
-
EVENT_BUS_ADDRESS_DEVICE_MANAGEMENT_IN
public static final String EVENT_BUS_ADDRESS_DEVICE_MANAGEMENT_IN
The vert.x event bus address to which inbound registration messages are published.- See Also:
- Constant Field Values
-
EVENT_BUS_ADDRESS_CREDENTIALS_MANAGEMENT_IN
public static final String EVENT_BUS_ADDRESS_CREDENTIALS_MANAGEMENT_IN
The vert.x event bus address to which inbound credentials management messages are published.- See Also:
- Constant Field Values
-
REGISTRATION_HTTP_ENDPOINT
public static final String REGISTRATION_HTTP_ENDPOINT
The name of the Device Registration HTTP API endpoint.- See Also:
- Constant Field Values
-
EVENT_BUS_ADDRESS_TENANT_IN
public static final String EVENT_BUS_ADDRESS_TENANT_IN
The vert.x event bus address to which inbound registration messages are published.- See Also:
- Constant Field Values
-
EVENT_BUS_ADDRESS_TENANT_MANAGEMENT_IN
public static final String EVENT_BUS_ADDRESS_TENANT_MANAGEMENT_IN
The vert.x event bus address to which inbound management messages are published.- 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_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_CREDENTIALS_TOTAL
public static final String FIELD_CREDENTIALS_TOTAL
The name of the field that contains the number of credentials contained in a message.- 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
-
CREDENTIALS_ENDPOINT
public static final String CREDENTIALS_ENDPOINT
The Credential service's endpoint name.- 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
-
SPECIFIER_WILDCARD
public static final String SPECIFIER_WILDCARD
The name of the field that contains the pattern to use for matching authentication identifiers.- 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
-
HASH_FUNCTION_SHA512
public static final String HASH_FUNCTION_SHA512
The name of the SHA-512 hash function.- See Also:
- Constant Field Values
-
DEFAULT_HASH_FUNCTION
public static final String DEFAULT_HASH_FUNCTION
The name of the default hash function to use for hashed passwords if not set explicitly.- See Also:
- Constant Field Values
-
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
-
MESSAGE_ID_PREFIX
public static final String MESSAGE_ID_PREFIX
Messages that are sent by the Hono client for the Tenant API use this as a prefix for the messageId.- 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_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_MAX_TTD
public static final String FIELD_MAX_TTD
The name of the property that contains the maximum time til disconnect 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_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
-
-
Method Detail
-
isValidAction
public static boolean isValidAction(String action)
Checks if a given string represents a valid action.- Parameters:
action
- The string to check.- Returns:
true
if the given string is a supported action.
-
-