Package org.eclipse.hono.util

Class RequestResponseApiConstants

java.lang.Object
org.eclipse.hono.util.RequestResponseApiConstants
Direct Known Subclasses:
CommandRouterConstants, CredentialsConstants, DeviceConnectionConstants, RegistrationConstants, RegistryManagementConstants, TenantConstants
public abstract class RequestResponseApiConstants extends Object
Constants & utility methods that are common to APIs that follow the request response pattern.

  • Field Details

    • FIELD_PAYLOAD_DEFAULTS

      public static final String FIELD_PAYLOAD_DEFAULTS
      The name of the property which contains default properties that protocol adapters should add to messages published by a device.
      See Also:

    • FIELD_PAYLOAD_DEVICE_ID

      public static final String FIELD_PAYLOAD_DEVICE_ID
      The name of the property that contains the identifier of a device.
      See Also:

    • FIELD_PAYLOAD_SUBJECT_DN

      public static final String FIELD_PAYLOAD_SUBJECT_DN
      The name of the property that contains the subject DN of the CA certificate that has been configured for a tenant. The subject DN is serialized as defined by RFC 2253, Section 2.
      See Also:

    • FIELD_PAYLOAD_TENANT_ID

      public static final String FIELD_PAYLOAD_TENANT_ID
      The name of the property that contains the identifier of a tenant.
      See Also:

    • FIELD_PAYLOAD_AUTH_ID_TEMPLATE

      public static final String FIELD_PAYLOAD_AUTH_ID_TEMPLATE
      The name of the property that defines the template for generating authentication identifier to be used during authentication and auto-provisioning.
      See Also:

    • FIELD_ENABLED

      public static final String FIELD_ENABLED
      The name of the field that contains a boolean indicating the status of an entity.
      See Also:

    • FIELD_AUTO_PROVISIONED

      public static final String FIELD_AUTO_PROVISIONED
      The name of the field that contains a boolean indicating if an entity was auto-provisioned.
      See Also:

    • FIELD_AUTO_PROVISIONING_NOTIFICATION_SENT

      public static final String FIELD_AUTO_PROVISIONING_NOTIFICATION_SENT
      The name of the field that contains a boolean indicating if a notification for an auto-provisioned device was sent.
      See Also:

    • FIELD_ERROR

      public static final String FIELD_ERROR
      The name of the field that contains additional information about an error that has occurred while processing a request message.
      See Also:

    • FIELD_PAYLOAD

      public static final String FIELD_PAYLOAD
      The name of the field that contains the payload of a request or response message.
      See Also:

    • FIELD_OBJECT_ID

      public static final String FIELD_OBJECT_ID
      The name of the field that contains the identifier of the object.
      See Also:

  • Constructor Details

    • RequestResponseApiConstants

      protected RequestResponseApiConstants()
      Empty default constructor.