Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- AbstractConfig - Class in org.eclipse.hono.config
-
A base class for managing basic configuration properties shared by clients and server components.
- AbstractConfig() - Constructor for class org.eclipse.hono.config.AbstractConfig
-
Creates a new empty instance.
- AbstractConfig(AbstractConfig) - Constructor for class org.eclipse.hono.config.AbstractConfig
-
Creates a new instance from another instance.
- AbstractConfig(GenericOptions) - Constructor for class org.eclipse.hono.config.AbstractConfig
-
Creates a new instance from generic options.
- ACTION_ASSERT - Static variable in class org.eclipse.hono.util.RegistrationConstants
-
The AMQP 1.0 subject to use for the assert device registration operation.
- Activity - Enum Class in org.eclipse.hono.auth
-
Defines permissions that are required to access Hono service resources.
- Adapter - Class in org.eclipse.hono.util
-
Protocol Adapter configuration properties.
- Adapter(String) - Constructor for class org.eclipse.hono.util.Adapter
-
Creates a new adapter instance for the given type.
- AdapterInstanceStatus - Enum Class in org.eclipse.hono.util
-
The adapter instance status.
- add - Enum constant in enum class org.eclipse.hono.util.CredentialsConstants.CredentialsAction
-
The AMQP subject property value to use for invoking the add Credentials operation.
- add - Enum constant in enum class org.eclipse.hono.util.TenantConstants.TenantAction
-
The add Tenant operation.
- addAdapter(Adapter) - Method in class org.eclipse.hono.util.TenantObject
-
Adds an adapter configuration.
- addAll(Authorities) - Method in class org.eclipse.hono.auth.AuthoritiesImpl
-
Adds all authorities contained in another object to this instance.
- addOnStartedHandler(Handler<AsyncResult<Void>>) - Method in class org.eclipse.hono.util.LifecycleStatus
-
Adds a handler to be notified once the tracked component has started up.
- addOnStoppedHandler(Handler<AsyncResult<Void>>) - Method in class org.eclipse.hono.util.LifecycleStatus
-
Adds a handler to be notified once the tracked component has shut down.
- addOperation(String, String) - Method in class org.eclipse.hono.auth.AuthoritiesImpl
-
Adds an authority to execute an operation.
- addOperation(String, String, String) - Method in class org.eclipse.hono.auth.AuthoritiesImpl
-
Adds an authority to execute an operation.
- addResource(String, String, Activity...) - Method in class org.eclipse.hono.auth.AuthoritiesImpl
-
Adds an authority to perform one or more activities on a resource.
- addResource(String, Activity...) - Method in class org.eclipse.hono.auth.AuthoritiesImpl
-
Adds an authority to perform one or more activities on a resource.
- addSecret(JsonObject) - Method in class org.eclipse.hono.util.CredentialsObject
-
Adds a secret.
- addSecret(Map<String, Object>) - Method in class org.eclipse.hono.util.CredentialsObject
-
Adds a secret.
- addTrustAnchor(byte[], String, X500Principal, String, Boolean) - Method in class org.eclipse.hono.util.TenantObject
-
Adds a trusted certificate authority to use for authenticating devices of this tenant.
- addTrustAnchor(PublicKey, X500Principal, Boolean) - Method in class org.eclipse.hono.util.TenantObject
-
Adds a trusted certificate authority to use for authenticating devices of this tenant.
- adoptSamplingPriorityFromContext(SpanContext, Tracer.SpanBuilder) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Gets a "sampling.priority" baggage item from the given span context (if set) and sets a corresponding tag in the given span builder.
- ALIVE - Enum constant in enum class org.eclipse.hono.util.AdapterInstanceStatus
-
Adapter instance is alive.
- ALL - Enum constant in enum class org.eclipse.hono.util.TracingSamplingMode
- amqp - Enum constant in enum class org.eclipse.hono.util.MessagingType
-
AMQP 1.0 based messaging infrastructure.
- ANNOTATION_X_OPT_RETAIN - Static variable in class org.eclipse.hono.util.MessageHelper
-
The name of the AMQP 1.0 message annotation that is used to indicate that the sender of the message intended the message to be retained in the MQTT sense.
- API_VERSION - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The current version of the API.
- APP_PROPERTY_CACHE_CONTROL - Static variable in class org.eclipse.hono.util.MessageHelper
-
The name of the AMQP 1.0 message application property containing the caching directive to follow for the body of the message.
- APP_PROPERTY_CMD_VIA - Static variable in class org.eclipse.hono.util.MessageHelper
-
The name of the AMQP 1.0 message application property containing the gateway through which a command is sent.
- APP_PROPERTY_DEVICE_ID - Static variable in class org.eclipse.hono.util.MessageHelper
-
The name of the AMQP 1.0 message application property containing the id of the device that has reported the data belongs to.
- APP_PROPERTY_GATEWAY_ID - Static variable in class org.eclipse.hono.util.MessageHelper
-
The name of the AMQP 1.0 message application property containing the id of the gateway that wants to report data on behalf of another device.
- APP_PROPERTY_LIFESPAN - Static variable in class org.eclipse.hono.util.MessageHelper
-
The name of the AMQP 1.0 message application property containing a lifespan value in seconds.
- APP_PROPERTY_ORIG_ADAPTER - Static variable in class org.eclipse.hono.util.MessageHelper
-
The name of the AMQP 1.0 message application property containing the name of the protocol adapter over which an uploaded message has originally been received.
- APP_PROPERTY_ORIG_ADDRESS - Static variable in class org.eclipse.hono.util.MessageHelper
-
The name of the AMQP 1.0 application property that is used to convey the address that a message has been originally published to by a device.
- APP_PROPERTY_QOS - Static variable in class org.eclipse.hono.util.MessageHelper
-
The name of the AMQP 1.0 message application property containing the QoS level of the message as set by the device.
- APP_PROPERTY_REGISTRATION_STATUS - Static variable in class org.eclipse.hono.util.MessageHelper
-
The name of the AMQP 1.0 message application property containing the flag denoting an event sent whenever a device was auto-provisioned.
- APP_PROPERTY_RESOURCE - Static variable in class org.eclipse.hono.util.MessageHelper
-
The name of the AMQP 1.0 message application property containing the resource a message is addressed at.
- APP_PROPERTY_RESOURCE_VERSION - Static variable in class org.eclipse.hono.util.MessageHelper
-
The name of the AMQP 1.0 message application property containing the resource version expected by the client.
- APP_PROPERTY_SEND_EVENT - Static variable in class org.eclipse.hono.util.MessageHelper
-
The name of the AMQP 1.0 message application property containing flag if connection event should be sent.
- APP_PROPERTY_STATUS - Static variable in class org.eclipse.hono.util.MessageHelper
-
The name of the AMQP 1.0 message application property containing the status code indicating the outcome of processing a request.
- APP_PROPERTY_TENANT_ID - Static variable in class org.eclipse.hono.util.MessageHelper
-
The name of the AMQP 1.0 message application property containing the id of the tenant the device that has reported the data belongs to.
- APPLICATION_PROPERTY_TYPE - Static variable in class org.eclipse.hono.util.AuthenticationConstants
-
The name of the AMQP message application property holding the type of token contained in the body.
- apply(String) - Method in class org.eclipse.hono.util.IdentityTemplate
-
Applies attribute values from the given subject DN to the template.
- applyTraceSamplingPriority(TenantObject, String, Span) - Static method in class org.eclipse.hono.tracing.TenantTraceSamplingHelper
-
Applies the trace sampling priority configured for the given tenant to the given span.
- asAddress(String, String) - Static method in class org.eclipse.hono.auth.Device
-
Gets the device id in an address structure.
- asAddress(Device) - Static method in class org.eclipse.hono.auth.Device
-
Gets the device id in an address structure.
- asMap() - Method in interface org.eclipse.hono.auth.Authorities
-
Gets the authorities as a map of claims.
- asMap() - Method in class org.eclipse.hono.auth.AuthoritiesImpl
- AT_LEAST_ONCE - Enum constant in enum class org.eclipse.hono.util.QoS
-
Indicates that a message might be sent multiple times, for example if the sender believes that the message might have not reached its recipient due to a network problem.
- AT_MOST_ONCE - Enum constant in enum class org.eclipse.hono.util.QoS
-
Indicates that the message will be sent at most once, i.e.
- AUDIENCE_HONO_ADAPTER - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The aud claim value indicating that a JWT is intended to be processed by a Hono protocol adapter.
- AuthenticationConstants - Class in org.eclipse.hono.util
-
Constants related to authentication.
- Authorities - Interface in org.eclipse.hono.auth
-
A collection of authorities granted on resources and/or operations.
- AuthoritiesImpl - Class in org.eclipse.hono.auth
-
A map backed implementation of authorities on resources and operations.
- AuthoritiesImpl() - Constructor for class org.eclipse.hono.auth.AuthoritiesImpl
- AUTHORITY_AUTO_PROVISIONING_ENABLED - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the authority which authorizes a gateway to perform auto-provisioning.
B
- bindAddress() - Method in interface org.eclipse.hono.config.ServerOptions
-
Gets the host name or literal IP address of the network interface that this server's secure port is configured to be bound to.
- buildChildSpan(Tracer, SpanContext, String, String) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Creates a span builder that is initialized with the given operation name and a child-of reference to the given span context (if set).
- buildFollowsFromSpan(Tracer, SpanContext, String) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Creates a span builder that is initialized with the given operation name and a follows-from reference to the given span context (if set).
- buildServerChildSpan(Tracer, SpanContext, String, String) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Creates a span builder that is initialized with the given operation name and a child-of reference to the given span context (if set).
- buildSpan(Tracer, SpanContext, String, String) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Creates a span builder that is initialized with the given operation name and a reference to the given span context (if set).
C
- CacheDirective - Class in org.eclipse.hono.util
-
A helper for parsing and creating cache directives compliant with RFC 2616, Section 14.9.
- certPath() - Method in interface org.eclipse.hono.config.GenericOptions
-
Gets the absolute path to the PEM file containing the X.509 certificate chain for the RSA private key that should be used for authentication to peers.
- checkSecrets() - Method in class org.eclipse.hono.util.CredentialsObject
-
Checks if this credentials object contains secrets that comply with the Credentials API specification.
- checkSecrets(BiConsumer<String, JsonObject>) - Method in class org.eclipse.hono.util.CredentialsObject
-
Checks if this credentials object contains secrets that comply with the Credentials API specification.
- checkValidity() - Method in class org.eclipse.hono.util.CredentialsObject
-
Checks if this credentials object is in a consistent state.
- checkValidity(String) - Static method in class org.eclipse.hono.util.IdentityTemplate
-
Checks if the template is valid.
- checkValidity(BiConsumer<String, JsonObject>) - Method in class org.eclipse.hono.util.CredentialsObject
-
Checks if this credentials object is in a consistent state.
- CLAIM_TENANT_ID - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the claim that contains the tenant that a device belongs to.
- COMMAND_ENDPOINT - Static variable in class org.eclipse.hono.util.CommandConstants
-
The name of the Command and Control API endpoint.
- COMMAND_ENDPOINT - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains information about the service endpoint to use for sending commands to a device.
- COMMAND_ENDPOINT_SHORT - Static variable in class org.eclipse.hono.util.CommandConstants
-
The short name of the Command and Control endpoint.
- COMMAND_RESPONSE_ENDPOINT - Static variable in class org.eclipse.hono.util.CommandConstants
-
The name of the Command and Control API endpoint provided by protocol adapters that use a separate endpoint for command responses.
- COMMAND_RESPONSE_ENDPOINT_SHORT - Static variable in class org.eclipse.hono.util.CommandConstants
-
The short name of the Command and Control API endpoint provided by protocol adapters that use a separate endpoint for command responses.
- COMMAND_RESPONSE_REQUEST_PART - Static variable in class org.eclipse.hono.util.CommandConstants
-
The part of the address for a command response between a device and an adapter, which identifies the request.
- COMMAND_RESPONSE_REQUEST_PART_SHORT - Static variable in class org.eclipse.hono.util.CommandConstants
-
Short version of COMMAND_RESPONSE_REQUEST_PART.
- COMMAND_RESPONSE_RESPONSE_PART - Static variable in class org.eclipse.hono.util.CommandConstants
-
The part of the address for a command response between a device and an adapter, which identifies the response.
- COMMAND_RESPONSE_RESPONSE_PART_SHORT - Static variable in class org.eclipse.hono.util.CommandConstants
-
Short version of COMMAND_RESPONSE_RESPONSE_PART.
- COMMAND_ROUTER_ENDPOINT - Static variable in class org.eclipse.hono.util.CommandRouterConstants
-
The name of the Command Router API endpoint.
- CommandConstants - Class in org.eclipse.hono.util
-
Constants & utility methods used throughout the Command and Control API.
- CommandEndpoint - Class in org.eclipse.hono.util
-
Encapsulates the command endpoint information for a device as defined by the Device Registration API.
- CommandEndpoint() - Constructor for class org.eclipse.hono.util.CommandEndpoint
- CommandRouterConstants - Class in org.eclipse.hono.util
-
Constants & utility methods used throughout the Command Router API.
- CommandRouterConstants.CommandRouterAction - Enum Class in org.eclipse.hono.util
-
Request actions that belong to the Command Router API.
- ConfigurationSupportingVerticle<T> - Class in org.eclipse.hono.util
-
A base class for implementing Verticles.
- ConfigurationSupportingVerticle() - Constructor for class org.eclipse.hono.util.ConfigurationSupportingVerticle
- ConnectionDuration - Class in org.eclipse.hono.util
-
The resource limits definition corresponding to the connection duration.
- ConnectionDuration(Instant, ResourceLimitsPeriod) - Constructor for class org.eclipse.hono.util.ConnectionDuration
-
Creates a new connection duration specification for an instant in time.
- ConnectionDuration(Instant, ResourceLimitsPeriod, long) - Constructor for class org.eclipse.hono.util.ConnectionDuration
-
Creates a new connection duration specification for an instant in time.
- Constants - Class in org.eclipse.hono.util
-
Constants used throughout Hono.
- CONTENT_TYPE_APPLICATION_JSON - Static variable in class org.eclipse.hono.util.MessageHelper
-
The MIME type representing the String representation of a JSON Object.
- CONTENT_TYPE_DELIVERY_FAILURE_NOTIFICATION - Static variable in class org.eclipse.hono.util.CommandConstants
-
The content type that is defined for error command response messages sent by a protocol adapter or Command Router.
- CONTENT_TYPE_DEVICE_PROVISIONING_NOTIFICATION - Static variable in class org.eclipse.hono.util.EventConstants
-
The content type of the device provisioning notification event.
- CONTENT_TYPE_EMPTY_NOTIFICATION - Static variable in class org.eclipse.hono.util.EventConstants
-
The content type that is defined for empty events without any payload.
- CONTENT_TYPE_OCTET_STREAM - Static variable in class org.eclipse.hono.util.MessageHelper
-
The MIME type representing an opaque array of bytes.
- CONTENT_TYPE_TEXT_PLAIN - Static variable in class org.eclipse.hono.util.MessageHelper
-
The MIME type representing plain text.
- corsAllowedOrigin() - Method in interface org.eclipse.hono.config.ServiceOptions
-
Gets the allowed origin pattern for CORS handler.
- create(Supplier<CompletionStage<T>>) - Static method in class org.eclipse.hono.util.Futures
-
Create a completion stage and map the outcome to a vert.x future.
- CREDENTIALS_ENDPOINT - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The Credential service's endpoint name.
- CREDENTIALS_HTTP_ENDPOINT - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the Device Registration HTTP API endpoint.
- CredentialsConstants - Class in org.eclipse.hono.util
-
Constants & utility methods used throughout the Credentials API.
- CredentialsConstants.CredentialsAction - Enum Class in org.eclipse.hono.util
-
Request actions that belong to the Credentials API.
- CredentialsObject - Class in org.eclipse.hono.util
-
Encapsulates the credentials information for a device as defined by the Credentials API.
- CredentialsObject() - Constructor for class org.eclipse.hono.util.CredentialsObject
-
Empty default constructor.
- CredentialsObject(String, String, String) - Constructor for class org.eclipse.hono.util.CredentialsObject
-
Creates new credentials for an authentication identifier.
- CredentialsResult<T> - Class in org.eclipse.hono.util
-
A container for the result returned by Hono's credentials API.
- custom - Enum constant in enum class org.eclipse.hono.util.TenantConstants.TenantAction
-
The custom operation.
D
- DataVolume - Class in org.eclipse.hono.util
-
Data volume definition of the tenant resource limits.
- DataVolume(Instant, ResourceLimitsPeriod) - Constructor for class org.eclipse.hono.util.DataVolume
-
Creates a new data volume specification for an instant in time and an accounting period definition.
- DataVolume(Instant, ResourceLimitsPeriod, long) - Constructor for class org.eclipse.hono.util.DataVolume
-
Creates a new data volume specification for an instant in time.
- days - Enum constant in enum class org.eclipse.hono.util.ResourceLimitsPeriod.PeriodMode
-
The mode of the data volume calculation in terms of days.
- DEAD - Enum constant in enum class org.eclipse.hono.util.AdapterInstanceStatus
-
Adapter instance has been terminated.
- DEFAULT - Enum constant in enum class org.eclipse.hono.util.TracingSamplingMode
- DEFAULT_CACHE_NAME - Static variable in class org.eclipse.hono.util.CommandRouterConstants
-
The default name of the (remote) cache in the data grid that is used for storing command router information.
- DEFAULT_HASH_FUNCTION - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the default hash function to use for hashed passwords if not set explicitly.
- DEFAULT_MAX_PAYLOAD_SIZE - Static variable in class org.eclipse.hono.config.ServiceConfigProperties
-
The default maximum payload size for messages uploaded by devices.
- DEFAULT_MAX_TTD - Static variable in class org.eclipse.hono.util.TenantConstants
-
The default number of seconds that a protocol adapter should wait for an upstream command.
- DEFAULT_MINIMUM_MESSAGE_SIZE - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The default message size is set to 0, which implies no minimum size is defined.
- DEFAULT_MINIMUM_MESSAGE_SIZE - Static variable in class org.eclipse.hono.util.TenantConstants
-
The default message size is set to 0, which implies no minimum size is defined.
- DEFAULT_PATH_SEPARATOR - Static variable in class org.eclipse.hono.util.Constants
-
The default separator character for target addresses.
- DEFAULT_PATTERN_USERNAME - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The default pattern for validating authentication IDs supplied when creating hashed-password credentials.
- DEFAULT_RECEIVER_LINK_CREDITS - Static variable in class org.eclipse.hono.config.ServiceConfigProperties
-
The default number of credits to flow to a client.
- DEFAULT_REGEX_DEVICE_ID - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The default regular expression to validate device IDs supplied when creating devices are legal.
- DEFAULT_REGEX_TENANT_ID - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The default regular expression to validate tenant IDs supplied when creating tenants are legal.
- DEFAULT_REGEX_USERNAME - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The default regular expression for validating authentication IDs supplied when creating hashed-password credentials.
- DEFAULT_SEND_TIMEOUT_IN_MS - Static variable in class org.eclipse.hono.config.ServiceConfigProperties
-
The default send timeout value in milliseconds, which is to be used when sending a message on the vert.x event bus.
- DEFAULT_TENANT - Static variable in class org.eclipse.hono.util.Constants
-
The name of the default tenant.
- detect(String) - Static method in enum class org.eclipse.hono.config.FileFormat
-
Detects the file format based on a file name's extension.
- Device - Class in org.eclipse.hono.auth
-
An authenticated client of a protocol adapter representing a device.
- Device(String, String) - Constructor for class org.eclipse.hono.auth.Device
-
Creates a new device for a tenant and device identifier.
- DeviceConnectionConstants - Class in org.eclipse.hono.util
-
Constants used for dealing with the device connection data.
- deviceIdPattern() - Method in interface org.eclipse.hono.config.ServiceOptions
-
Gets the pattern defining valid device identifiers.
- DEVICES_HTTP_ENDPOINT - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the Credentials Registration HTTP API endpoint.
E
- EC_ALG - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the supported elliptic curve algorithm.
- elementAt(int) - Method in class org.eclipse.hono.util.ResourceIdentifier
-
Gets the element at a given index of the resource path.
- emptySecret(Instant, Instant) - Static method in class org.eclipse.hono.util.CredentialsObject
-
Creates an otherwise empty secret for a not-before and a not-after instant.
- ENABLE_COMMAND_ROUTING - Enum constant in enum class org.eclipse.hono.util.CommandRouterConstants.CommandRouterAction
-
The enable command routing operation.
- ENDPOINT_NAME_AUTHENTICATION - Static variable in class org.eclipse.hono.util.AuthenticationConstants
-
The name of the authentication endpoint.
- equals(Object) - Method in class org.eclipse.hono.util.CacheDirective
- equals(Object) - Method in class org.eclipse.hono.util.Pair
- equals(Object) - Method in class org.eclipse.hono.util.ResourceIdentifier
- equals(Object) - Method in class org.eclipse.hono.util.TriTuple
- ERROR_CAUSE_OBJECT - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing span log entry field containing a nested exception object.
- EVENT_BUS_ADDRESS_AUTHENTICATION_IN - Static variable in class org.eclipse.hono.util.AuthenticationConstants
-
The vert.x event bus address inbound authentication requests are published on.
- EVENT_BUS_ADDRESS_CREDENTIALS_IN - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The vert.x event bus address to which inbound credentials messages are published.
- EVENT_BUS_ADDRESS_NOTIFICATION_PREFIX - Static variable in class org.eclipse.hono.util.Constants
-
The prefix for the vert.x event bus address that notification messages are published to.
- EVENT_BUS_ADDRESS_TENANT_TIMED_OUT - Static variable in class org.eclipse.hono.util.Constants
-
The vert.x event bus address that the ID of a tenant that timed out is published to.
- EVENT_CONNECTION_NOTIFICATION_CONTENT_TYPE - Static variable in class org.eclipse.hono.util.EventConstants
-
The content type of the connection notification event.
- EVENT_ENDPOINT - Static variable in class org.eclipse.hono.util.EventConstants
-
The name of the event endpoint.
- EVENT_ENDPOINT_SHORT - Static variable in class org.eclipse.hono.util.EventConstants
-
The short name of the event endpoint.
- EventConstants - Class in org.eclipse.hono.util
-
Constants > utility methods used throughout the Event API.
- EventConstants.RegistrationStatus - Enum Class in org.eclipse.hono.util
-
The registration status of a device.
- eventLoopBlockedCheckTimeout() - Method in interface org.eclipse.hono.config.ServiceOptions
-
Gets the time to wait for completion after which a handler is considered to be blocking the vert.x event loop.
- EXECUTE - Enum constant in enum class org.eclipse.hono.auth.Activity
-
Permission required for executing an operation on a node.
- executeBlocking(Vertx, Futures.BlockingCode<T>) - Static method in class org.eclipse.hono.util.Futures
-
Use
Vertx.executeBlocking(Handler, Handler)
with Futures. - executeOnContextWithSameRoot(Context, Handler<Promise<T>>) - Static method in class org.eclipse.hono.util.Futures
-
Executes some code, ensuring it is run on the given context or a duplicated context of the given context.
- ExecutionContext - Interface in org.eclipse.hono.util
-
A container for information relevant for processing a message sent by a device.
- extractSpanContext(Tracer, JsonObject) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Extracts a
SpanContext
from a JSON object. - extractSpanContext(Tracer, MultiMap) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Extracts a
SpanContext
from the headers of a vert.x event bus message. - extractSpanContext(Tracer, Supplier<Iterator<Map.Entry<String, String>>>) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Extracts a
SpanContext
from given key-value pairs.
F
- FIELD_ADAPTER_INSTANCE_ID - Static variable in class org.eclipse.hono.util.DeviceConnectionConstants
-
The name of the field that contains the identifier of the protocol adapter instance.
- FIELD_ADAPTER_INSTANCES - Static variable in class org.eclipse.hono.util.DeviceConnectionConstants
-
The name of the field that contains the list of objects with protocol adapter instance id and device id.
- FIELD_ADAPTERS - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains configuration options for specific protocol adapters.
- FIELD_ADAPTERS - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that contains configuration options for specific protocol adapters.
- FIELD_ADAPTERS_DEVICE_AUTHENTICATION_REQUIRED - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that indicates whether a protocol adapter requires all devices to authenticate.
- FIELD_ADAPTERS_DEVICE_AUTHENTICATION_REQUIRED - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that indicates whether a protocol adapter requires all devices to authenticate.
- FIELD_ADAPTERS_TYPE - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the type name of a protocol adapter.
- FIELD_ADAPTERS_TYPE - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that contains the type name of a protocol adapter.
- FIELD_ALIAS - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains a tenant's optional alternative identifier.
- FIELD_AUTH_ID - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the field that contains the authentication identifier.
- FIELD_AUTH_ID - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the authentication identifier.
- FIELD_AUTH_ID_TEMPLATE - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that defines the template for generating authentication identifier to be used during authentication and auto-provisioning.
- FIELD_AUTHORITIES - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the authorities of a device.
- FIELD_AUTHORIZATION_ID - Static variable in class org.eclipse.hono.util.AuthenticationConstants
-
The name of the field containing the authorization ID granted as the result of a successful authentication.
- FIELD_AUTO_PROVISION_AS_GATEWAY - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that indicates whether a unregistered device that authenticates with a client certificate should be auto-provisioned as a gateway.
- FIELD_AUTO_PROVISIONED - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains a boolean indicating if a device has been auto-provisioned.
- FIELD_AUTO_PROVISIONED - Static variable in class org.eclipse.hono.util.RequestResponseApiConstants
-
The name of the field that contains a boolean indicating if an entity was auto-provisioned.
- FIELD_AUTO_PROVISIONING_DEVICE_ID_TEMPLATE - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that defines the device identifier template for the devices/gateways being auto-provisioned.
- FIELD_AUTO_PROVISIONING_ENABLED - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that indicates whether a CA cert can be used to automatically provision new devices.
- FIELD_AUTO_PROVISIONING_ENABLED - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that indicates whether a CA cert can be used to automatically provision new devices.
- FIELD_AUTO_PROVISIONING_NOTIFICATION_SENT - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains a boolean indicating if a notification for an auto-provisioned device was sent.
- FIELD_AUTO_PROVISIONING_NOTIFICATION_SENT - Static variable in class org.eclipse.hono.util.RequestResponseApiConstants
-
The name of the field that contains a boolean indicating if a notification for an auto-provisioned device was sent.
- FIELD_CLIENT_CERT - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the field that contains the client certificate that is used for authentication.
- FIELD_COMMAND_ENDPOINT - Static variable in class org.eclipse.hono.util.RegistrationConstants
-
Top level property name of a command endpoint.
- FIELD_COMMAND_ENDPOINT_HEADERS - Static variable in class org.eclipse.hono.util.RegistrationConstants
-
The name of the property containing the headers for a command endpoint.
- FIELD_COMMAND_ENDPOINT_PAYLOAD_PROPERTIES - Static variable in class org.eclipse.hono.util.RegistrationConstants
-
The name of the property containing the additional payload properties for a command endpoint.
- FIELD_COMMAND_ENDPOINT_URI - Static variable in class org.eclipse.hono.util.RegistrationConstants
-
The name of the property containing the uri format for a command endpoint.
- FIELD_COMMENT - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains a comment for the credentials.
- FIELD_CONNECTION_DURATION - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the configuration options to limit the device connection duration of tenants.
- FIELD_CONNECTION_DURATION - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that contains the configuration options to limit the device connection duration of tenants.
- FIELD_CREDENTIALS_TOTAL - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the field that contains the number of credentials contained in a message.
- FIELD_DATA - Static variable in class org.eclipse.hono.util.RegistrationConstants
-
The name of the field containing a device's registration information.
- FIELD_DATA_VOLUME - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the configuration options for a tenant's data volume limits.
- FIELD_DATA_VOLUME - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that contains the configuration options for the data volume.
- FIELD_DEVICES - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the JSON array containing device registration information for a tenant.
- FIELD_DOWNSTREAM_MESSAGE_MAPPER - Static variable in class org.eclipse.hono.util.RegistrationConstants
-
The name of the downstream mapper used.
- FIELD_DOWNSTREAM_MESSAGE_MAPPER - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the name of a service that can be used to transform downstream messages uploaded by the device before they are forwarded to downstream consumers.
- FIELD_EFFECTIVE_SINCE - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the date on which the data volume limit came into effect.
- FIELD_EFFECTIVE_SINCE - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that contains the date on which the data volume limit came into effect.
- FIELD_ENABLED - Static variable in class org.eclipse.hono.util.RequestResponseApiConstants
-
The name of the field that contains a boolean indicating the status of an entity.
- FIELD_ERROR - Static variable in class org.eclipse.hono.util.RequestResponseApiConstants
-
The name of the field that contains additional information about an error that has occurred while processing a request message.
- FIELD_EXT - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the extension fields.
- FIELD_EXT - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the field that contains the extension fields.
- FIELD_EXT_INVALIDATE_CACHE_ON_UPDATE - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that indicates if cache invalidation is required on update operations.
- FIELD_EXT_MESSAGING_TYPE - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that defines the messaging type to be used for a tenant.
- FIELD_EXT_MESSAGING_TYPE - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that defines the messaging type to be used for a tenant.
- FIELD_FILTER_FIELD - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the JSON pointer corresponding to the field used for filtering entities.
- FIELD_FILTER_OPERATOR - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the operator used for filtering entities.
- FIELD_FILTER_VALUE - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the value used for filtering entities.
- FIELD_GATEWAY_ID - Static variable in class org.eclipse.hono.util.DeviceConnectionConstants
-
The name of the field that contains the identifier of a gateway.
- FIELD_GATEWAY_IDS - Static variable in class org.eclipse.hono.util.DeviceConnectionConstants
-
The name of the field that contains the array of gateway ids.
- FIELD_ID - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the identifier of an entity.
- FIELD_LAST_UPDATED - Static variable in class org.eclipse.hono.util.DeviceConnectionConstants
-
The name of the optional field in the result of the get last known gateway for device operation that contains the date when the last known gateway id was last updated.
- FIELD_MAX_BYTES - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the maximum number of bytes to be allowed for a tenant.
- FIELD_MAX_BYTES - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that contains the maximum number of bytes to be allowed for a tenant.
- FIELD_MAX_CONNECTIONS - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the maximum number of connections to be allowed for a tenant.
- FIELD_MAX_CONNECTIONS - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that contains the maximum number of connections to be allowed for a tenant.
- FIELD_MAX_CREDENTIALS_PER_DEVICE - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the maximum number of credentials allowed per device of a tenant.
- FIELD_MAX_DEVICES - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the maximum number of devices to be allowed for a tenant.
- FIELD_MAX_MINUTES - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the maximum connection duration in minutes to be allowed for a tenant.
- FIELD_MAX_MINUTES - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that contains the maximum connection duration in minutes to be allowed for a tenant.
- FIELD_MAX_TTD - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that contains the maximum time til disconnect (seconds) that protocol adapters should use for a tenant.
- FIELD_MAX_TTL - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the maximum time to live (seconds) for downstream events that protocol adapters should use for a tenant.
- FIELD_MAX_TTL - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that contains the maximum time to live (seconds) for downstream events that protocol adapters should use for a tenant.
- FIELD_MAX_TTL_COMMAND_RESPONSE - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
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.
- FIELD_MAX_TTL_COMMAND_RESPONSE - Static variable in class org.eclipse.hono.util.TenantConstants
-
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.
- FIELD_MAX_TTL_TELEMETRY_QOS0 - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
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.
- FIELD_MAX_TTL_TELEMETRY_QOS0 - Static variable in class org.eclipse.hono.util.TenantConstants
-
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.
- FIELD_MAX_TTL_TELEMETRY_QOS1 - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
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.
- FIELD_MAX_TTL_TELEMETRY_QOS1 - Static variable in class org.eclipse.hono.util.TenantConstants
-
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.
- FIELD_MECHANISM - Static variable in class org.eclipse.hono.util.AuthenticationConstants
-
The name of the field containing the SASL mechanism used for authentication.
- FIELD_MEMBER_OF - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the names of the gateway groups that the (gateway) device is a member of.
- FIELD_MINIMUM_MESSAGE_SIZE - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the minimum message size in bytes.
- FIELD_MINIMUM_MESSAGE_SIZE - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that contains the minimum message size in bytes.
- FIELD_OBJECT_ID - Static variable in class org.eclipse.hono.util.RequestResponseApiConstants
-
The name of the field that contains the identifier of the object.
- FIELD_PASSWORD - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the field that contains the password.
- FIELD_PAYLOAD - Static variable in class org.eclipse.hono.util.RequestResponseApiConstants
-
The name of the field that contains the payload of a request or response message.
- FIELD_PAYLOAD_AUTH_ID_TEMPLATE - Static variable in class org.eclipse.hono.util.RequestResponseApiConstants
-
The name of the property that defines the template for generating authentication identifier to be used during authentication and auto-provisioning.
- FIELD_PAYLOAD_CERT - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the Base64 encoded (binary) DER encoding of the trusted certificate configured for a tenant.
- FIELD_PAYLOAD_CERT - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that contains the Base64 encoded (binary) DER encoding of the trusted certificate configured for a tenant.
- FIELD_PAYLOAD_DEFAULTS - Static variable in class org.eclipse.hono.util.RequestResponseApiConstants
-
The name of the property which contains default properties that protocol adapters should add to messages published by a device.
- FIELD_PAYLOAD_DEVICE_ID - Static variable in class org.eclipse.hono.util.RequestResponseApiConstants
-
The name of the property that contains the identifier of a device.
- FIELD_PAYLOAD_KEY_ALGORITHM - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the algorithm used for a public key.
- FIELD_PAYLOAD_KEY_ALGORITHM - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that contains the algorithm used for a public key.
- FIELD_PAYLOAD_PUBLIC_KEY - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
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.
- FIELD_PAYLOAD_PUBLIC_KEY - Static variable in class org.eclipse.hono.util.TenantConstants
-
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.
- FIELD_PAYLOAD_SUBJECT_DN - Static variable in class org.eclipse.hono.util.RequestResponseApiConstants
-
The name of the property that contains the subject DN of the CA certificate that has been configured for a tenant.
- FIELD_PAYLOAD_TENANT_ID - Static variable in class org.eclipse.hono.util.RequestResponseApiConstants
-
The name of the property that contains the identifier of a tenant.
- FIELD_PAYLOAD_TRUSTED_CA - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the trusted certificate authority configured for a tenant.
- FIELD_PAYLOAD_TRUSTED_CA - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that contains the trusted certificate authority configured for a tenant.
- FIELD_PERIOD - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the period details for which the data usage is calculated.
- FIELD_PERIOD - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that contains the period details for which the data usage is calculated.
- FIELD_PERIOD_MODE - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the mode of the period for which the data usage is calculated.
- FIELD_PERIOD_MODE - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that contains the mode of the period for which the data usage is calculated.
- FIELD_PERIOD_NO_OF_DAYS - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the number of days for which the data usage is calculated.
- FIELD_PERIOD_NO_OF_DAYS - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that contains the number of days for which the data usage is calculated.
- FIELD_REGISTRATION_LIMITS - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the configuration options for the registration limits.
- FIELD_RESOURCE_LIMITS - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the configuration options for the resource limits.
- FIELD_RESOURCE_LIMITS - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that contains the configuration options for the resource limits.
- FIELD_RESULT_SET_PAGE - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the result of a search operation.
- FIELD_RESULT_SET_SIZE - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the total number of objects in the result set of a search operation.
- FIELD_SASL_RESPONSE - Static variable in class org.eclipse.hono.util.AuthenticationConstants
-
The name of the field containing the SASL response the client has provided.
- FIELD_SECRETS - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the field that contains the secret(s) of the credentials.
- FIELD_SECRETS - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the secret(s) of the credentials.
- FIELD_SECRETS_ALGORITHM - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the field that contains the password hash.
- FIELD_SECRETS_ALGORITHM - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the name of the algorithm used for the JWT validation.
- FIELD_SECRETS_COMMENT - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the comment about the secret.
- FIELD_SECRETS_HASH_FUNCTION - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the field that contains the name of the hash function used for a hashed password.
- FIELD_SECRETS_HASH_FUNCTION - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the name of the hash function used for a hashed password.
- FIELD_SECRETS_KEY - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the field that contains a (pre-shared) key.
- FIELD_SECRETS_KEY - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains a pre-shared or raw public key.
- FIELD_SECRETS_NOT_AFTER - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the field that contains the latest point in time a secret may be used for authentication.
- FIELD_SECRETS_NOT_AFTER - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the latest point in time a secret may be used for authentication.
- FIELD_SECRETS_NOT_BEFORE - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the field that contains the earliest point in time a secret may be used for authentication.
- FIELD_SECRETS_NOT_BEFORE - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the earliest point in time a secret may be used for authentication.
- FIELD_SECRETS_PWD_HASH - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the field that contains the password hash.
- FIELD_SECRETS_PWD_HASH - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the password hash.
- FIELD_SECRETS_PWD_PLAIN - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the field that contains the clear text password.
- FIELD_SECRETS_PWD_PLAIN - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the clear text password.
- FIELD_SECRETS_SALT - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the field that contains the salt for the password hash.
- FIELD_SECRETS_SALT - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the salt for the password hash.
- FIELD_SORT_DIRECTION - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains sort direction used by a search operation to sort the result set.
- FIELD_STATUS - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains meta information about an entity like creation date and time of last modification.
- FIELD_STATUS_CREATION_DATE - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the creation date of the device.
- FIELD_STATUS_LAST_UPDATE - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the last update date of the device.
- FIELD_STATUS_LAST_USER - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the last user that edited the device.
- FIELD_SUBJECT_DN - Static variable in class org.eclipse.hono.util.AuthenticationConstants
-
The name of the field containing the Subject DN of the certificate the client has used for EXTERNAL auth.
- FIELD_TENANT - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the JSON property containing the tenant ID.
- FIELD_TOKEN - Static variable in class org.eclipse.hono.util.AuthenticationConstants
-
The name of the field containing the JSON Web Token representing an authenticated client and its authorities.
- FIELD_TRACING - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that defines tenant-specific tracing options.
- FIELD_TRACING - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the property that defines tenant-specific tracing options.
- FIELD_TRACING_SAMPLING_MODE - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
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.
- FIELD_TRACING_SAMPLING_MODE - Static variable in class org.eclipse.hono.util.TenantConstants
-
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.
- FIELD_TRACING_SAMPLING_MODE_PER_AUTH_ID - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
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.
- FIELD_TRACING_SAMPLING_MODE_PER_AUTH_ID - Static variable in class org.eclipse.hono.util.TenantConstants
-
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.
- FIELD_TRUST_ANCHOR_GROUP - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the property that contains the trust anchor group name for a tenant.
- FIELD_TTL_COMMAND_RESPONSE - Static variable in class org.eclipse.hono.util.TenantConstants
-
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.
- FIELD_TTL_TELEMETRY_QOS0 - Static variable in class org.eclipse.hono.util.TenantConstants
-
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.
- FIELD_TTL_TELEMETRY_QOS1 - Static variable in class org.eclipse.hono.util.TenantConstants
-
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.
- FIELD_TYPE - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the field that contains the type of credentials.
- FIELD_TYPE - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the type of credentials.
- FIELD_UPSTREAM_MESSAGE_MAPPER - Static variable in class org.eclipse.hono.util.RegistrationConstants
-
The name of the upstream mapper used.
- FIELD_UPSTREAM_MESSAGE_MAPPER - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the name of a service that can be used to transform upstream commands to be sent to the device.
- FIELD_USERNAME - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the field that contains the user name.
- FIELD_VIA - Static variable in class org.eclipse.hono.util.RegistrationConstants
-
The name of the field in a response to the assert Device Registration operation that contains the identifiers of those gateways that may act on behalf of the device.
- FIELD_VIA - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the identifiers of those gateways that may act on behalf of the device.
- FIELD_VIA_GROUPS - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the field that contains the identifiers of groups of gateways that may act on behalf of the device.
- FileFormat - Enum Class in org.eclipse.hono.config
-
File formats for using key materials.
- from(int) - Static method in class org.eclipse.hono.util.CredentialsResult
-
Creates a new result for a status code.
- from(int) - Static method in enum class org.eclipse.hono.util.QoS
-
Gets the quality of service corresponding to a given integer.
- from(int) - Static method in class org.eclipse.hono.util.RegistrationResult
-
Creates a new result for a status code.
- from(int) - Static method in class org.eclipse.hono.util.TenantResult
-
Creates a new result for a status code.
- from(int, JsonObject) - Static method in class org.eclipse.hono.util.RegistrationResult
-
Creates a new result for a status code and a payload.
- from(int, JsonObject, CacheDirective) - Static method in class org.eclipse.hono.util.RegistrationResult
-
Creates a new result for a status code and a payload.
- from(int, JsonObject, CacheDirective, Map<String, Object>) - Static method in class org.eclipse.hono.util.RegistrationResult
-
Creates a new result for a status code and a payload.
- from(int, String) - Static method in class org.eclipse.hono.util.RegistrationResult
-
Creates a new result for a status code and a payload.
- from(int, T) - Static method in class org.eclipse.hono.util.CredentialsResult
-
Creates a new result for a status code and payload.
- from(int, T) - Static method in class org.eclipse.hono.util.TenantResult
-
Creates a new result for a status code and payload.
- from(int, T, CacheDirective) - Static method in class org.eclipse.hono.util.CredentialsResult
-
Creates a new result for a status code and payload.
- from(int, T, CacheDirective) - Static method in class org.eclipse.hono.util.TenantResult
-
Creates a new result for a status code and payload.
- from(int, T, CacheDirective, Map<String, Object>) - Static method in class org.eclipse.hono.util.CredentialsResult
-
Creates a new result for a status code and payload.
- from(int, T, CacheDirective, Map<String, Object>) - Static method in class org.eclipse.hono.util.TenantResult
-
Creates a new result for a status code and payload.
- from(Claims) - Static method in class org.eclipse.hono.auth.AuthoritiesImpl
-
Creates authorities from claims from a JWT.
- from(String) - Static method in class org.eclipse.hono.util.CacheDirective
-
Parses a cache directive.
- from(String) - Static method in enum class org.eclipse.hono.util.CommandRouterConstants.CommandRouterAction
-
Construct a CommandRouterAction from a subject.
- from(String) - Static method in enum class org.eclipse.hono.util.CredentialsConstants.CredentialsAction
-
Construct a CredentialsAction from a subject.
- from(String) - Static method in enum class org.eclipse.hono.util.TenantConstants.TenantAction
-
Construct a TenantAction from a subject.
- from(String) - Static method in class org.eclipse.hono.util.TenantObject
-
Creates an enabled tenant for a tenantId.
- from(String) - Static method in enum class org.eclipse.hono.util.TracingSamplingMode
-
Construct a TraceSamplingMode from a value.
- from(String, boolean) - Static method in class org.eclipse.hono.util.TenantObject
-
Creates a TenantObject for a tenantId and the enabled property.
- from(String, String, String) - Static method in class org.eclipse.hono.util.ResourceIdentifier
-
Creates a resource identifier for an endpoint, a tenantId and a resourceId.
- from(ResourceIdentifier, String, String) - Static method in class org.eclipse.hono.util.ResourceIdentifier
-
Creates a resource identifier for an endpoint based on another resource identifier.
- fromClearTextPassword(String, String, String, Instant, Instant) - Static method in class org.eclipse.hono.util.CredentialsObject
-
Creates a credentials object for a device based on a username and clear text password.
- fromClientCertificate(String, X509Certificate, Instant, Instant) - Static method in class org.eclipse.hono.util.CredentialsObject
-
Creates a credentials object for a device based on a client certificate.
- fromFiles(Vertx, String, String) - Static method in class org.eclipse.hono.config.KeyLoader
-
Creates a new loader for a key store.
- fromHashedPassword(String, String, String, String, Instant, Instant, byte[]) - Static method in class org.eclipse.hono.util.CredentialsObject
-
Creates a credentials object for a device based on a username and password hash.
- fromKeyStore(Vertx, String, char[]) - Static method in class org.eclipse.hono.config.KeyLoader
-
Creates a new loader for a key store.
- fromPath(String...) - Static method in class org.eclipse.hono.util.ResourceIdentifier
-
Creates a resource identifier from path segments.
- fromPresharedKey(String, String, byte[], Instant, Instant) - Static method in class org.eclipse.hono.util.CredentialsObject
-
Creates a credentials object for a device and auth ID.
- fromRawPublicKey(String, String, String, byte[], Instant, Instant) - Static method in class org.eclipse.hono.util.CredentialsObject
-
Creates a credentials object for a device, auth ID and raw public key.
- fromString(String) - Static method in class org.eclipse.hono.util.ResourceIdentifier
-
Creates a resource identifier from its string representation.
- fromSubjectDn(String, X500Principal, Instant, Instant) - Static method in class org.eclipse.hono.util.CredentialsObject
-
Creates a credentials object for a device based on a subject DN.
- Futures - Class in org.eclipse.hono.util
-
Helper class working with Java and vert.x futures.
- Futures.BlockingCode<T> - Interface in org.eclipse.hono.util
-
Interface representing blocking code to be executed.
G
- genericOptions() - Method in interface org.eclipse.hono.config.ServerOptions
-
Gets the generic options.
- GenericOptions - Interface in org.eclipse.hono.config
-
Generic configuration options shared by clients and server components.
- get - Enum constant in enum class org.eclipse.hono.util.CredentialsConstants.CredentialsAction
-
The AMQP subject property value to use for invoking the get Credentials operation.
- get - Enum constant in enum class org.eclipse.hono.util.TenantConstants.TenantAction
-
The get Tenant operation.
- get(String) - Method in interface org.eclipse.hono.util.ExecutionContext
-
Gets the value for a key.
- get(String) - Method in class org.eclipse.hono.util.MapBasedExecutionContext
- get(String, T) - Method in interface org.eclipse.hono.util.ExecutionContext
-
Gets the value for a key.
- get(String, T) - Method in class org.eclipse.hono.util.MapBasedExecutionContext
- getAdapter(String) - Method in class org.eclipse.hono.util.TenantObject
-
Gets the adapter configuration for the given type.
- getAdapters() - Method in class org.eclipse.hono.util.TenantObject
-
Gets the list of configured adapters for the tenant.
- getAuthenticationReply(String) - Static method in class org.eclipse.hono.util.AuthenticationConstants
-
Creates a message containing the JSON Web Token representing the successful authentication of a client.
- getAuthenticationRequest(String, byte[]) - Static method in class org.eclipse.hono.util.AuthenticationConstants
-
Creates a message for authenticating a client using SASL.
- getAuthId() - Method in class org.eclipse.hono.util.CredentialsObject
-
Gets the authentication identifier that these credentials are used for.
- getAuthIdTemplate(String) - Method in class org.eclipse.hono.util.TenantObject
-
Gets the template to generate authentication identifier for the given subject DN.
- getAuthorities() - Method in interface org.eclipse.hono.auth.HonoUser
-
Gets this user's granted authorities.
- getAuthorities() - Method in class org.eclipse.hono.auth.HonoUserAdapter
- getAuthorizedGateways() - Method in class org.eclipse.hono.util.RegistrationAssertion
-
Gets the gateway devices that are authorized to act on behalf of the device.
- getBasePath() - Method in class org.eclipse.hono.util.ResourceIdentifier
-
Gets a string representation of this resource identifier's endpoint and tenantId.
- getBindAddress() - Method in class org.eclipse.hono.config.ServerConfig
-
Gets the host name or literal IP address of the network interface that this server's secure port is configured to be bound to.
- getCacheDirective() - Method in class org.eclipse.hono.util.RequestResponseResult
-
Gets the cache directive specifying how the payload of this response may be cached.
- getCandidateSecrets() - Method in class org.eclipse.hono.util.CredentialsObject
-
Filters the currently valid secrets from the secrets on record.
- getCandidateSecrets(Function<JsonObject, T>) - Method in class org.eclipse.hono.util.CredentialsObject
-
Filters the currently valid secrets from the secrets on record.
- getCertificateChain() - Method in class org.eclipse.hono.config.KeyLoader
-
Gets the certificate chain.
- getCertPath() - Method in class org.eclipse.hono.config.AbstractConfig
-
Gets the absolute path to the PEM file containing the X.509 certificate chain for the RSA private key that should be used for authentication to peers.
- getCode() - Method in enum class org.eclipse.hono.auth.Activity
-
Gets the single character representation for this activity.
- getCommandEndpoint() - Method in class org.eclipse.hono.util.RegistrationAssertion
-
Gets the endpoint to use when sending commands.
- getCommonName(String) - Static method in class org.eclipse.hono.util.AuthenticationConstants
-
Extracts the Common Name (CN) from a subject Distinguished Name (DN).
- getConfig() - Method in class org.eclipse.hono.util.ConfigurationSupportingVerticle
-
Gets the properties that this Verticle has been configured with.
- getConnectionDuration() - Method in class org.eclipse.hono.util.ResourceLimits
-
Gets the properties that are required for the connection duration verification.
- getContext() - Method in class org.eclipse.hono.util.ConfigurationSupportingVerticle
-
Gets the vert.x context that this verticle is associated with.
- getCorsAllowedOrigin() - Method in class org.eclipse.hono.config.ServiceConfigProperties
-
Gets the allowed origin pattern for CORS handler.
- getDataVolume() - Method in class org.eclipse.hono.util.ResourceLimits
-
Gets the data volume properties which are required for the message limit verification.
- getDefaults() - Method in class org.eclipse.hono.util.RegistrationAssertion
-
Gets default properties to be used for augmenting messages from the device with missing information.
- getDefaults() - Method in class org.eclipse.hono.util.TenantObject
-
Gets the default property values used for all devices of this tenant.
- getDeviceId() - Method in class org.eclipse.hono.auth.Device
-
Gets this device's identifier.
- getDeviceId() - Method in class org.eclipse.hono.util.CredentialsObject
-
Gets the identifier of the device that these credentials belong to.
- getDeviceId() - Method in class org.eclipse.hono.util.RegistrationAssertion
-
Gets the identifier of the asserted device.
- getDeviceIdPattern() - Method in class org.eclipse.hono.config.ServiceConfigProperties
-
Gets the pattern defining valid device identifiers.
- getDownstreamMessageMapper() - Method in class org.eclipse.hono.util.RegistrationAssertion
-
Gets the name of the downstream mapper definition to use for the device.
- getEffectiveSince() - Method in class org.eclipse.hono.util.LimitedResource
-
Gets the point in time at which the limit became or will become effective.
- getElapsedAccountingPeriodDuration(Instant) - Method in class org.eclipse.hono.util.LimitedResource
-
Gets the already elapsed time of the most recent accounting period.
- getElapsedAccountingPeriodDuration(Instant, Instant) - Method in class org.eclipse.hono.util.ResourceLimitsPeriod
-
Gets the duration for which the most recent accounting period as defined by this specification overlaps with a given period of time.
- getEndpoint() - Method in class org.eclipse.hono.util.ResourceIdentifier
-
Gets the endpoint part of this identifier.
- getErrorLogItems(String, Throwable) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Creates a set of items to log for a message and an error.
- getEventLoopBlockedCheckTimeout() - Method in class org.eclipse.hono.config.ServiceConfigProperties
-
Gets the time to wait for completion after which a handler is considered to be blocking the vert.x event loop.
- getExpirationTime() - Method in interface org.eclipse.hono.auth.HonoUser
-
Gets the point in time after which this user's authorities should be considered invalid.
- getExpirationTime() - Method in class org.eclipse.hono.auth.HonoUserAdapter
- getExtensions() - Method in class org.eclipse.hono.util.Adapter
-
Gets the extension properties of this tenant.
- getExtensions() - Method in class org.eclipse.hono.util.ResourceLimits
-
Gets the extension properties for this resource limits.
- getFieldValue() - Method in enum class org.eclipse.hono.util.TracingSamplingMode
-
Gets the JSON field value for this TraceSamplingMode.
- getFormattedUri(String) - Method in class org.eclipse.hono.util.CommandEndpoint
-
Returns the configured uri formatted with the deviceId.
- getHashFunction(JsonObject) - Static method in class org.eclipse.hono.util.CredentialsConstants
-
Gets the hash function of a hashed-password secret.
- getHeaders() - Method in class org.eclipse.hono.util.CommandEndpoint
-
Gets headers to be used when sending a command to this endpoint.
- getHostname() - Static method in class org.eclipse.hono.util.Hostnames
-
Return the hostname.
- getInsecurePort() - Method in class org.eclipse.hono.config.ServerConfig
-
Gets the insecure port this server is configured to listen on.
- getInsecurePort(int) - Method in class org.eclipse.hono.config.ServerConfig
-
Gets the insecure port this server is configured to listen on.
- getInsecurePortBindAddress() - Method in class org.eclipse.hono.config.ServerConfig
-
Gets the host name or literal IP address of the network interface that this server's insecure port is configured to be bound to.
- getKeyCertOptions() - Method in class org.eclipse.hono.config.AbstractConfig
-
Gets the key & certificate options derived from the key store properties.
- getKeyFormat() - Method in class org.eclipse.hono.config.AbstractConfig
-
Get the specified format of the key files.
- getKeyPath() - Method in class org.eclipse.hono.config.AbstractConfig
-
Gets the absolute path to the PEM file containing the RSA private key that will be used for authentication to peers.
- getKeyStorePassword() - Method in class org.eclipse.hono.config.AbstractConfig
-
Gets the password for the key store containing the private key and certificate chain that should be used for authentication to peers.
- getKeyStorePath() - Method in class org.eclipse.hono.config.AbstractConfig
-
Gets the absolute path to the key store containing the private key and certificate chain that will be used for authentication to peers.
- getMaxAge() - Method in class org.eclipse.hono.util.CacheDirective
-
Gets the maximum period of time for which a resource may be cached.
- getMaxBytes() - Method in class org.eclipse.hono.util.DataVolume
-
Gets the amount of data that devices of a tenant may transfer per accounting period.
- getMaxConnections() - Method in class org.eclipse.hono.util.ResourceLimits
-
Gets the maximum number of connected devices a tenant supports.
- getMaxMinutes() - Method in class org.eclipse.hono.util.ConnectionDuration
-
Gets the maximum device connection duration in minutes to be allowed for the time period defined by the
TenantConstants.FIELD_PERIOD_MODE
andTenantConstants.FIELD_PERIOD_NO_OF_DAYS
. - getMaxPayloadSize() - Method in class org.eclipse.hono.config.ServiceConfigProperties
-
Gets the maximum size of a message payload this server accepts from clients.
- getMaxTimeUntilDisconnect(String) - Method in class org.eclipse.hono.util.TenantObject
-
Gets the maximum number of seconds that a protocol adapter should wait for a command targeted at a device.
- getMaxTtl() - Method in class org.eclipse.hono.util.ResourceLimits
-
Gets the maximum time-to-live to use for events published by devices of a tenant.
- getMaxTtl(String, QoS) - Method in class org.eclipse.hono.util.ResourceLimits
-
Gets the maximum time-to-live to use for messages published by devices of a tenant to a given endpoint.
- getMaxTtlCommandResponse() - Method in class org.eclipse.hono.util.ResourceLimits
-
Gets the maximum time-to-live to use for command responses published by devices of a tenant.
- getMaxTtlTelemetryQoS0() - Method in class org.eclipse.hono.util.ResourceLimits
-
Gets the maximum time-to-live to use for telemetry messages published by devices of a tenant with QoS 0.
- getMaxTtlTelemetryQoS1() - Method in class org.eclipse.hono.util.ResourceLimits
-
Gets the maximum time-to-live to use for telemetry messages published by devices of a tenant with QoS 1.
- getMessagingType() - Method in interface org.eclipse.hono.util.MessagingClient
-
Gets the messaging type this client supports.
- getMinimumMessageSize() - Method in class org.eclipse.hono.util.TenantObject
-
Gets the minimum message size in bytes.
- getMode() - Method in class org.eclipse.hono.util.ResourceLimitsPeriod
-
Gets the mode of period for resource limit calculation.
- getName() - Method in class org.eclipse.hono.auth.Device
- getName() - Method in class org.eclipse.hono.auth.HonoUserAdapter
- getNoOfDays() - Method in class org.eclipse.hono.util.ResourceLimitsPeriod
-
Gets the number of days for which resource usage is calculated.
- getNotAfter(JsonObject) - Static method in class org.eclipse.hono.util.CredentialsObject
-
Gets the not after instant of a secret.
- getNotBefore(JsonObject) - Static method in class org.eclipse.hono.util.CredentialsObject
-
Gets the not before instant of a secret.
- getPassword(String, String) - Method in class org.eclipse.hono.config.AbstractConfig
-
Gets the password represented by a property value.
- getPasswordHash(JsonObject) - Static method in class org.eclipse.hono.util.CredentialsConstants
-
Gets the password hash of a hashed-password secret.
- getPasswordSalt(JsonObject) - Static method in class org.eclipse.hono.util.CredentialsConstants
-
Gets the password salt of a hashed-password secret.
- getPathSeparator() - Method in class org.eclipse.hono.config.AbstractConfig
-
Gets the character separating the segments of target addresses.
- getPathWithoutBase() - Method in class org.eclipse.hono.util.ResourceIdentifier
-
Gets a string representation of the resource identifiers' parts without the base path.
- getPayload() - Method in class org.eclipse.hono.config.PemReader.Entry
-
Gets the PEM entry payload.
- getPayload() - Method in class org.eclipse.hono.util.RequestResponseResult
-
Gets the payload to convey to the sender of the request.
- getPayloadProperties() - Method in class org.eclipse.hono.util.CommandEndpoint
-
Gets payload properties to be used when sending a command to this endpoint.
- getPeriod() - Method in class org.eclipse.hono.util.LimitedResource
-
Gets the definition of the accounting periods used for this specification.
- getPort() - Method in class org.eclipse.hono.config.ServerConfig
-
Gets the secure port this server is configured to listen on.
- getPort(int) - Method in class org.eclipse.hono.config.ServerConfig
-
Gets the secure port this server is configured to listen on.
- getPrivateKey() - Method in class org.eclipse.hono.config.KeyLoader
-
Gets the private key.
- getProperty(JsonObject, String, Class<T>) - Static method in class org.eclipse.hono.util.CredentialsObject
-
Gets a property value.
- getProperty(JsonObject, String, Class<T>, T) - Static method in class org.eclipse.hono.util.CredentialsObject
-
Gets a property value.
- getProperty(String, Class<T>) - Method in class org.eclipse.hono.util.CredentialsObject
-
Gets a property value.
- getProperty(String, Class<T>, T) - Method in class org.eclipse.hono.util.CredentialsObject
-
Gets a property value.
- getPublicKey() - Method in class org.eclipse.hono.config.KeyLoader
-
Gets the public key.
- getReceiverLinkCredit() - Method in class org.eclipse.hono.config.ServiceConfigProperties
-
Gets the number of AMQP message credits this service flows to a client when the client opens a sender link to this service.
- getResourceId() - Method in class org.eclipse.hono.util.ResourceIdentifier
-
Gets the resourceId part of this identifier.
- getResourceLimits() - Method in class org.eclipse.hono.util.TenantObject
-
Gets the resource limits for the tenant.
- getResourcePath() - Method in class org.eclipse.hono.util.ResourceIdentifier
-
Gets a copy of the full resource path of this identifier, including extended elements.
- getResponseProperties() - Method in class org.eclipse.hono.util.RequestResponseResult
-
Gets read-only access to the response message's additional properties.
- getSamplingMode() - Method in class org.eclipse.hono.util.TenantTracingConfig
-
Gets the sampling mode that defines in how far spans created when processing messages for a tenant shall be recorded (sampled) by the tracing system.
- getSamplingMode(String) - Method in class org.eclipse.hono.util.TenantTracingConfig
-
Gets the sampling mode for a specific device.
- getSamplingModePerAuthId() - Method in class org.eclipse.hono.util.TenantTracingConfig
-
Gets the sampling modes defined for specific devices.
- getSearchCriteria(String, String) - Static method in class org.eclipse.hono.util.CredentialsConstants
-
Creates a JSON object containing search criteria for Credentials.
- getSecrets() - Method in class org.eclipse.hono.util.CredentialsObject
-
Gets this credentials' secret(s).
- getSecureProtocols() - Method in class org.eclipse.hono.config.AbstractConfig
-
Gets the secure protocols that are enabled for TLS connections.
- getSendTimeOut() - Method in class org.eclipse.hono.config.ServiceConfigProperties
-
Gets the send timeout value in milliseconds, which is to be used when sending a message on the vert.x event bus.
- getStatus() - Method in class org.eclipse.hono.util.RequestResponseResult
-
Gets the status code indicating the outcome of the request.
- getSubject() - Method in enum class org.eclipse.hono.util.CommandRouterConstants.CommandRouterAction
-
Gets the AMQP message subject corresponding to this action.
- getSupportedCipherSuites() - Method in class org.eclipse.hono.config.AbstractConfig
-
Gets the names of the cipher suites that may be used in TLS connections.
- getTenantId() - Method in class org.eclipse.hono.auth.Device
-
Gets the identifier of the tenant this device belongs to.
- getTenantId() - Method in class org.eclipse.hono.util.ResourceIdentifier
-
Gets the tenant part of this identifier.
- getTenantId() - Method in class org.eclipse.hono.util.TenantObject
-
Gets this tenant's identifier.
- getTenantIdPattern() - Method in class org.eclipse.hono.config.ServiceConfigProperties
-
Gets the pattern defining valid tenant identifiers.
- getToken() - Method in interface org.eclipse.hono.auth.HonoUser
-
Gets a JSON Web Token representing this user's claims.
- getToken() - Method in class org.eclipse.hono.auth.HonoUserAdapter
- getTraceSamplingPriority(TenantObject, String) - Static method in class org.eclipse.hono.tracing.TenantTraceSamplingHelper
-
Gets the trace sampling priority configured for the given tenant and authentication identifier.
- getTracingConfig() - Method in class org.eclipse.hono.util.TenantObject
-
Gets this tenant's tracing configuration.
- getTracingContext() - Method in interface org.eclipse.hono.util.ExecutionContext
-
Gets the OpenTracing context that is used to track the processing of this context.
- getTracingContext() - Method in class org.eclipse.hono.util.MapBasedExecutionContext
- getTracingSpan() - Method in interface org.eclipse.hono.util.ExecutionContext
-
Gets the OpenTracing root span that is used to track the processing of this context.
- getTracingSpan() - Method in class org.eclipse.hono.util.MapBasedExecutionContext
-
Gets the OpenTracing root span that is used to track the processing of this context.
- getTrustAnchors() - Method in class org.eclipse.hono.util.TenantObject
-
Gets the trust anchors for this tenant.
- getTrustOptions() - Method in class org.eclipse.hono.config.AbstractConfig
-
Gets the trust options derived from the trust store properties.
- getTrustStoreFormat() - Method in class org.eclipse.hono.config.AbstractConfig
-
Get the specified format of the trust store.
- getTrustStorePassword() - Method in class org.eclipse.hono.config.AbstractConfig
-
Gets the password for accessing the key store containing the certificates of trusted CAs.
- getTrustStorePath() - Method in class org.eclipse.hono.config.AbstractConfig
-
Gets the path to the key store to load certificates of trusted CAs from.
- getType() - Method in class org.eclipse.hono.config.PemReader.Entry
-
Gets the PEM entry type.
- getType() - Method in class org.eclipse.hono.util.Adapter
-
Gets the type name of the protocol adapter this is the configuration for.
- getType() - Method in class org.eclipse.hono.util.CredentialsObject
-
Gets the type of these credentials.
- getUpstreamMessageMapper() - Method in class org.eclipse.hono.util.RegistrationAssertion
-
Gets the name of the upstream mapper definition to use for the device.
- getUri() - Method in class org.eclipse.hono.util.CommandEndpoint
-
Gets the URI to be used when sending a command to this endpoint.
- getValue(JsonObject, String, Class<T>, T) - Static method in class org.eclipse.hono.util.JsonHelper
-
Gets a value from the given JSON object.
H
- hasEventEndpoint() - Method in class org.eclipse.hono.util.ResourceIdentifier
-
Checks if this resource identifier contains the event endpoint.
- HASH_FUNCTION_BCRYPT - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the BCrypt hash function.
- HASH_FUNCTION_BCRYPT - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the BCrypt hash function.
- HASH_FUNCTION_SHA256 - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the SHA-256 hash function.
- HASH_FUNCTION_SHA256 - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the SHA-256 hash function.
- HASH_FUNCTION_SHA512 - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the SHA-512 hash function.
- hashCode() - Method in class org.eclipse.hono.util.CacheDirective
- hashCode() - Method in class org.eclipse.hono.util.Pair
- hashCode() - Method in class org.eclipse.hono.util.ResourceIdentifier
- hashCode() - Method in class org.eclipse.hono.util.TriTuple
- hashedPasswordSecretForClearTextPassword(String, Instant, Instant) - Static method in class org.eclipse.hono.util.CredentialsObject
-
Creates a hashed-password secret for a clear text password.
- hashedPasswordSecretForPasswordHash(String, String, Instant, Instant, byte[]) - Static method in class org.eclipse.hono.util.CredentialsObject
-
Creates a hashed-password secret for a password hash.
- hashedPasswordSecretForPasswordHash(String, String, Instant, Instant, String) - Static method in class org.eclipse.hono.util.CredentialsObject
-
Creates a hashed-password secret for a password hash.
- hasTelemetryEndpoint() - Method in class org.eclipse.hono.util.ResourceIdentifier
-
Checks if this resource identifier contains the telemetry endpoint.
- HEADER_COMMAND - Static variable in class org.eclipse.hono.util.Constants
-
The header name defined for setting the command that is sent to the device.
- HEADER_COMMAND_REQUEST_ID - Static variable in class org.eclipse.hono.util.Constants
-
The header name defined for setting the request id for device responses to a command.
- HEADER_COMMAND_RESPONSE_STATUS - Static variable in class org.eclipse.hono.util.Constants
-
The header name defined for setting the status code of a device respond to a command that was previously received by the device.
- HEADER_COMMAND_TARGET_DEVICE - Static variable in class org.eclipse.hono.util.Constants
-
The header name defined for setting the target device id when sending a command to a gateway acting on behalf of the device.
- HEADER_QOS_LEVEL - Static variable in class org.eclipse.hono.util.Constants
-
The "QoS-Level" request header indicating the quality of service level supported by the HTTP Adapter.
- HEADER_TIME_TILL_DISCONNECT - Static variable in class org.eclipse.hono.util.Constants
-
The header name defined for setting the time till disconnect for device command readiness notification events.
- HEADER_TIME_TO_LIVE - Static variable in class org.eclipse.hono.util.Constants
-
The header name defined for setting the time-to-live for the event messages.
- HonoTimestamp - Annotation Interface in org.eclipse.hono.annotation
-
An annotation to indicate that an
Instant
valued field should be de-/serialized from/to a string in ISO-8601 extended offset date-time format. - HonoUser - Interface in org.eclipse.hono.auth
-
A principal representing a client of a Hono service API.
- HonoUserAdapter - Class in org.eclipse.hono.auth
-
An empty default implementation to be selectively overridden by subclasses.
- HonoUserAdapter() - Constructor for class org.eclipse.hono.auth.HonoUserAdapter
- Hostnames - Class in org.eclipse.hono.util
-
Helper class for working with hostnames.
I
- IdentityTemplate - Class in org.eclipse.hono.util
-
A utility class for handling template used for generating device and authentication identifiers during auto-provisioning.
- IdentityTemplate(String) - Constructor for class org.eclipse.hono.util.IdentityTemplate
-
Creates a new identity template.
- injectSpanContext(Tracer, SpanContext, DeliveryOptions) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Injects a
SpanContext
into the headers of vert.xDeliveryOptions
. - injectSpanContext(Tracer, SpanContext, JsonObject) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Injects a
SpanContext
into a JSON object. - injectSpanContext(Tracer, SpanContext, BiConsumer<String, String>) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Injects a
SpanContext
as key-value pairs into a given operation. - insecurePort() - Method in interface org.eclipse.hono.config.ServerOptions
-
Gets the insecure port this server is configured to listen on.
- insecurePortBindAddress() - Method in interface org.eclipse.hono.config.ServerOptions
-
Gets the host name or literal IP address of the network interface that this server's insecure port is configured to be bound to.
- insecurePortEnabled() - Method in interface org.eclipse.hono.config.ServerOptions
-
Checks if this server is configured to listen on an insecure port (i.e.
- INTERNAL_COMMAND_ENDPOINT - Static variable in class org.eclipse.hono.util.CommandConstants
-
The name of the internal Command and Control API endpoint provided by protocol adapters for delegating commands from one adapter to another.
- INTERNAL_COMMAND_SPAN_OPERATION_NAME - Static variable in class org.eclipse.hono.util.CommandConstants
-
The operation name of the span used by the internal command sender.
- isAdapterEnabled(String) - Method in class org.eclipse.hono.util.TenantObject
-
Checks if this tenant is enabled and if a given protocol adapter is enabled for this tenant.
- isAuthorized(ResourceIdentifier, String) - Method in interface org.eclipse.hono.auth.Authorities
-
Checks if these authorities include claims allowing execution of an operation of a resource.
- isAuthorized(ResourceIdentifier, String) - Method in class org.eclipse.hono.auth.AuthoritiesImpl
- isAuthorized(ResourceIdentifier, Activity) - Method in interface org.eclipse.hono.auth.Authorities
-
Checks if these authorities include claims allowing an intended activity on a resource.
- isAuthorized(ResourceIdentifier, Activity) - Method in class org.eclipse.hono.auth.AuthoritiesImpl
- isAutoProvisioningEnabled(String) - Method in class org.eclipse.hono.util.TenantObject
-
Checks whether auto-provisioning is enabled for a CA.
- isCachingAllowed() - Method in class org.eclipse.hono.util.CacheDirective
-
Checks if this directive allows caching.
- isCommandEndpoint(String) - Static method in class org.eclipse.hono.util.CommandConstants
-
Returns
true
if the passed endpoint denotes a command endpoint (full or short version). - isDeviceAuthenticationRequired() - Method in class org.eclipse.hono.util.Adapter
-
Checks whether devices are required to authenticate when connecting to this protocol adapter.
- isEmptyNotificationType(String) - Static method in class org.eclipse.hono.util.EventConstants
-
Checks if a given content type is the empty notification type.
- isEnabled() - Method in class org.eclipse.hono.util.Adapter
-
Checks whether devices are able to connect to Hono using this protocol adapter.
- isEnabled() - Method in class org.eclipse.hono.util.CredentialsObject
-
Checks whether these credentials are enabled.
- isEnabled() - Method in class org.eclipse.hono.util.TenantObject
-
Checks if this tenant is enabled.
- isError() - Method in class org.eclipse.hono.util.RequestResponseResult
-
Checks if this result's status code represents an error.
- isEventEndpoint(String) - Static method in class org.eclipse.hono.util.EventConstants
-
Checks if a given endpoint name is the Event endpoint.
- isExpired() - Method in interface org.eclipse.hono.auth.HonoUser
-
Checks if the validity period of this user's asserted claims has expired.
- isExpired() - Method in class org.eclipse.hono.auth.HonoUserAdapter
- isInsecurePortEnabled() - Method in class org.eclipse.hono.config.ServerConfig
-
Checks whether this service should listen to the insecure port.
- isInValidityPeriod(JsonObject, Instant) - Static method in class org.eclipse.hono.util.CredentialsObject
-
Checks if a given instant of time falls into a secret's validity period.
- isKeyStoreFormat(FileFormat) - Static method in enum class org.eclipse.hono.config.FileFormat
-
Checks if a given file format represents a key store.
- isLimited() - Method in class org.eclipse.hono.util.ConnectionDuration
-
Checks if the device connection duration is effectively limited.
- isLimited() - Method in class org.eclipse.hono.util.DataVolume
-
Checks if the amount of data that devices of a tenant may transfer per accounting period is limited.
- isNativeTlsRequired() - Method in class org.eclipse.hono.config.ServerConfig
-
Checks if this server requires the usage of a native TLS implementation.
- isNetworkDebugLoggingEnabled() - Method in class org.eclipse.hono.config.ServiceConfigProperties
-
Checks whether the server is configured to log TCP traffic.
- isNorthboundCommandResponseEndpoint(String) - Static method in class org.eclipse.hono.util.CommandConstants
-
Returns
true
if the passed endpoint denotes a command response endpoint as used by northbound applications. - isNotFound() - Method in class org.eclipse.hono.util.RequestResponseResult
-
Checks if this result's status is Not Found.
- isNullOrEmpty(Object) - Static method in class org.eclipse.hono.util.Strings
-
Check if the provided value for null and emptiness.
- isOk() - Method in class org.eclipse.hono.util.RequestResponseResult
-
Checks if this result's status is OK.
- isSecurePortEnabled() - Method in class org.eclipse.hono.config.ServerConfig
-
Checks whether this service should listen to the secure port.
- isSni() - Method in class org.eclipse.hono.config.ServerConfig
-
Checks if the server supports Server Name Indication for TLS connections.
- isStarted() - Method in class org.eclipse.hono.util.LifecycleStatus
-
Checks if the component is started.
- isStarting() - Method in class org.eclipse.hono.util.LifecycleStatus
-
Checks if the component is in the process of starting up.
- isStopped() - Method in class org.eclipse.hono.util.LifecycleStatus
-
Checks if the component is stopped.
- isStopping() - Method in class org.eclipse.hono.util.LifecycleStatus
-
Checks if the component is in the process of shutting down.
- isSubstrateVm() - Method in class org.eclipse.hono.config.ServerConfig
-
Checks if the current thread is running on the Graal Substrate VM.
- isTelemetryEndpoint(String) - Static method in class org.eclipse.hono.util.TelemetryConstants
-
Checks if a given endpoint name is the Telemetry endpoint.
- isUriValid() - Method in class org.eclipse.hono.util.CommandEndpoint
-
Checks whether the configured uri is valid.
- isValid(String) - Static method in enum class org.eclipse.hono.util.CommandRouterConstants.CommandRouterAction
-
Helper method to check if a subject is a valid Command Router API action.
- isValid(String) - Static method in enum class org.eclipse.hono.util.CredentialsConstants.CredentialsAction
-
Helper method to check if a subject is a valid Credentials API action.
- isValid(String) - Static method in class org.eclipse.hono.util.ResourceIdentifier
-
Checks whether the given string is a valid resource identifier string representation.
- isValidPort(int) - Method in class org.eclipse.hono.config.AbstractConfig
-
Checks if a given port number is valid.
- isValidPort(int) - Static method in class org.eclipse.hono.util.PortConfigurationHelper
-
Checks if a given port number is valid.
- isWaitForDownstreamConnectionEnabled() - Method in class org.eclipse.hono.config.ServiceConfigProperties
-
Checks whether the server waits for downstream connections to be established during startup.
- iterator() - Method in class org.eclipse.hono.tracing.JsonObjectExtractAdapter
- iterator() - Method in class org.eclipse.hono.tracing.JsonObjectInjectAdapter
- iterator() - Method in class org.eclipse.hono.tracing.MultiMapExtractAdapter
- iterator() - Method in class org.eclipse.hono.tracing.MultiMapInjectAdapter
J
- JKS - Enum constant in enum class org.eclipse.hono.config.FileFormat
-
Java Key Store.
- json - Variable in class org.eclipse.hono.util.CredentialsObject
-
The JSON object to map all values to/from.
- JSON_FIELD_DESCRIPTION - Static variable in class org.eclipse.hono.util.Constants
-
The field name of a JSON payload containing a description.
- JSON_FIELD_DEVICE_ID - Static variable in class org.eclipse.hono.util.Constants
-
The field name of JSON payloads containing a device ID.
- JSON_FIELD_TENANT_ID - Static variable in class org.eclipse.hono.util.Constants
-
The field name of JSON payloads containing a tenant ID.
- JsonHelper - Class in org.eclipse.hono.util
-
A helper class for working with
JsonObject
s. - JsonObjectExtractAdapter - Class in org.eclipse.hono.tracing
-
An adapter for extracting properties from a JSON object.
- JsonObjectExtractAdapter(JsonObject) - Constructor for class org.eclipse.hono.tracing.JsonObjectExtractAdapter
-
Creates an adapter for a JSON object.
- JsonObjectInjectAdapter - Class in org.eclipse.hono.tracing
-
An adapter for injecting properties into a JSON object.
- JsonObjectInjectAdapter(JsonObject) - Constructor for class org.eclipse.hono.tracing.JsonObjectInjectAdapter
-
Creates an adapter for a JSON object.
K
- kafka - Enum constant in enum class org.eclipse.hono.util.MessagingType
-
Apache Kafka based messaging infrastructure.
- keyFormat() - Method in interface org.eclipse.hono.config.GenericOptions
-
Get the specified format of the key files.
- KeyLoader - Class in org.eclipse.hono.config
-
A utility class for loading keys from files.
- keyPath() - Method in interface org.eclipse.hono.config.GenericOptions
-
Gets the absolute path to the PEM file containing the RSA private key that will be used for authentication to peers.
- keyStorePassword() - Method in interface org.eclipse.hono.config.GenericOptions
-
Gets the password for the key store containing the private key and certificate chain that should be used for authentication to peers.
- keyStorePath() - Method in interface org.eclipse.hono.config.GenericOptions
-
Gets the absolute path to the key store containing the private key and certificate chain that will be used for authentication to peers.
L
- length() - Method in class org.eclipse.hono.util.ResourceIdentifier
-
Gets the number of elements in the resource path.
- Lifecycle - Interface in org.eclipse.hono.util
-
Methods for managing the life cycle of a component.
- LifecycleStatus - Class in org.eclipse.hono.util
-
Tracks the states that a component goes through during its life cycle.
- LifecycleStatus() - Constructor for class org.eclipse.hono.util.LifecycleStatus
- LifecycleStatus.Status - Enum Class in org.eclipse.hono.util
-
The state in a component's life cycle.
- LimitedResource - Class in org.eclipse.hono.util
-
Common parameters for defining limits on the usage of a resource.
- LimitedResource(Instant, ResourceLimitsPeriod) - Constructor for class org.eclipse.hono.util.LimitedResource
-
Creates an instance.
- LOG - Variable in class org.eclipse.hono.config.AbstractConfig
-
A logger to be shared with subclasses.
- logError(Span, String) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Marks an OpenTracing span as erroneous and logs a message.
- logError(Span, String, Throwable) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Marks an OpenTracing span as erroneous, logs a message and an error.
- logError(Span, String, Throwable, boolean) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Marks an OpenTracing span as erroneous, logs a message and an error.
- logError(Span, Throwable) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Marks an OpenTracing span as erroneous and logs an exception.
- logError(Span, Map<String, ?>) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Marks an OpenTracing span as erroneous and logs several items.
- LOOPBACK_DEVICE_ADDRESS - Static variable in class org.eclipse.hono.util.Constants
-
The loopback device address.
M
- map(Function<? super T, ? extends U>) - Method in class org.eclipse.hono.util.TenantResult
-
Map the payload type, if set.
- MapBasedExecutionContext - Class in org.eclipse.hono.util
-
An execution context that stores properties in a
Map
. - MapBasedExecutionContext(Span) - Constructor for class org.eclipse.hono.util.MapBasedExecutionContext
-
Creates a new MapBasedExecutionContext instance.
- maxAgeDirective(long) - Static method in class org.eclipse.hono.util.CacheDirective
-
Creates a new max-age directive.
- maxAgeDirective(Duration) - Static method in class org.eclipse.hono.util.CacheDirective
-
Creates a new max-age directive.
- maxPayloadSize() - Method in interface org.eclipse.hono.config.ServiceOptions
-
Gets the maximum size of a message payload this server accepts from clients.
- MECHANISM_EXTERNAL - Static variable in class org.eclipse.hono.util.AuthenticationConstants
-
The EXTERNAL SASL mechanism name.
- MECHANISM_PLAIN - Static variable in class org.eclipse.hono.util.AuthenticationConstants
-
The PLAIN SASL mechanism name.
- MessageHelper - Class in org.eclipse.hono.util
-
Constants for working with Hono API messages.
- MessagingClient - Interface in org.eclipse.hono.util
-
A client for a messaging system.
- MessagingType - Enum Class in org.eclipse.hono.util
-
The particular type of messaging infrastructure being used.
- MIN_SEND_TIMEOUT_IN_MS - Static variable in class org.eclipse.hono.config.ServiceConfigProperties
-
The minimum send timeout value in milliseconds is 500 ms and any value less than this minimum value is not accepted.
- monthly - Enum constant in enum class org.eclipse.hono.util.ResourceLimitsPeriod.PeriodMode
-
The mode of the data volume calculation is monthly.
- MSG_PROPERTY_ADAPTER_INSTANCE_ID - Static variable in class org.eclipse.hono.util.CommandConstants
-
The name of the message property containing the identifier of a protocol adapter instance.
- MSG_PROPERTY_DEVICE_TTD - Static variable in class org.eclipse.hono.util.CommandConstants
-
The name of the message property containing the time (in seconds) until a device will be available for receiving an upstream (command) message (short for Time till Disconnect).
- MultiMapExtractAdapter - Class in org.eclipse.hono.tracing
-
An adapter for extracting properties from a
MultiMap
object. - MultiMapExtractAdapter(MultiMap) - Constructor for class org.eclipse.hono.tracing.MultiMapExtractAdapter
-
Creates an adapter for a
MultiMap
object. - MultiMapInjectAdapter - Class in org.eclipse.hono.tracing
-
An adapter for injecting properties into a
MultiMap
object. - MultiMapInjectAdapter(MultiMap) - Constructor for class org.eclipse.hono.tracing.MultiMapInjectAdapter
-
Creates an adapter for a
MultiMap
object.
N
- nativeTlsRequired() - Method in interface org.eclipse.hono.config.ServerOptions
-
Checks if this server requires the usage of a native TLS implementation.
- networkDebugLoggingEnabled() - Method in interface org.eclipse.hono.config.ServiceOptions
-
Checks whether the server is configured to log TCP traffic.
- NEW - Enum constant in enum class org.eclipse.hono.util.EventConstants.RegistrationStatus
-
Status indicating a newly registered device.
- noCacheDirective() - Static method in class org.eclipse.hono.util.CacheDirective
-
Creates a new no-cache directive.
- NONE - Enum constant in enum class org.eclipse.hono.util.TracingSamplingMode
- NORTHBOUND_COMMAND_REQUEST_ENDPOINT - Static variable in class org.eclipse.hono.util.CommandConstants
-
The name of the northbound Command and Control API request endpoint used by northbound applications.
- NORTHBOUND_COMMAND_RESPONSE_ENDPOINT - Static variable in class org.eclipse.hono.util.CommandConstants
-
The name of the northbound Command and Control API response endpoint used by northbound applications.
O
- of(A, B) - Static method in class org.eclipse.hono.util.Pair
-
Creates a new pair for two values of arbitrary type.
- of(A, B, C) - Static method in class org.eclipse.hono.util.TriTuple
-
Creates a new tuple for values of arbitrary type.
- onCurrentContextCompletionHandler(Handler<AsyncResult<T>>) - Static method in class org.eclipse.hono.util.Futures
-
Gets a handler that completes the given handler on the current Vert.x context (if set).
- one() - Method in class org.eclipse.hono.util.Pair
-
Gets this pair's first value.
- one() - Method in class org.eclipse.hono.util.TriTuple
-
Gets this tuple's first value.
- orDetect(FileFormat, String) - Static method in enum class org.eclipse.hono.config.FileFormat
-
Use the provided file format or detect.
- org.eclipse.hono.annotation - package org.eclipse.hono.annotation
- org.eclipse.hono.auth - package org.eclipse.hono.auth
- org.eclipse.hono.config - package org.eclipse.hono.config
- org.eclipse.hono.tracing - package org.eclipse.hono.tracing
- org.eclipse.hono.util - package org.eclipse.hono.util
P
- Pair<A,
B> - Class in org.eclipse.hono.util -
A pair of two values of arbitrary type.
- PARAM_FILTER_JSON - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the query parameter that contains the filter JSON object for a search operation.
- PARAM_PAGE_OFFSET - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the query parameter that contains the page offset for a search operation.
- PARAM_PAGE_SIZE - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the query parameter that contains the page size for a search operation.
- PARAM_SORT_JSON - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the query parameter that contains the sort JSON object used by a search operation to sort the result set.
- parseSaslResponse(byte[]) - Static method in class org.eclipse.hono.util.AuthenticationConstants
-
Parses the SASL response and extracts the authzid, authcid and pwd from the response.
- pathSeparator() - Method in interface org.eclipse.hono.config.GenericOptions
-
Gets the character separating the segments of target addresses.
- PATTERN_TYPE_VALUE - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The regular expression to validate that the type field supplied in credentials is legal.
- PEM - Enum constant in enum class org.eclipse.hono.config.FileFormat
-
PEM encoded PKCS#1 or PKCS#8.
- PemReader - Class in org.eclipse.hono.config
-
A reader for PEM files.
- PemReader.Entry - Class in org.eclipse.hono.config
-
An entry in a PEM file.
- PKCS12 - Enum constant in enum class org.eclipse.hono.config.FileFormat
-
PKCS#12 key store.
- PLACEHOLDER_SUBJECT_CN - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the place holder for subject DN's Common Name in the device-id template used during auto-provisioning.
- PLACEHOLDER_SUBJECT_DN - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the place holder for subject DN in the device-id template used during auto-provisioning.
- PLACEHOLDER_SUBJECT_O - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the placeholder for subject DN's attribute Organization Name (O).
- PLACEHOLDER_SUBJECT_OU - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the placeholder for subject DN's attribute Organizational Unit Name (OU).
- port() - Method in interface org.eclipse.hono.config.ServerOptions
-
Gets the secure port this server is configured to listen on.
- PORT_AMQP - Static variable in class org.eclipse.hono.util.Constants
-
The AMQP 1.0 port defined by IANA for unencrypted connections.
- PORT_AMQPS - Static variable in class org.eclipse.hono.util.Constants
-
The AMQP 1.0 port defined by IANA for TLS encrypted connections.
- PORT_AMQPS_STRING - Static variable in class org.eclipse.hono.util.Constants
-
The AMQP 1.0 port defined by IANA for TLS encrypted connections.
- PORT_UNCONFIGURED - Static variable in class org.eclipse.hono.util.Constants
-
Default value for a port that is not explicitly configured.
- PORT_UNCONFIGURED_STRING - Static variable in class org.eclipse.hono.util.Constants
-
Default value for a port that is not explicitly configured.
- PortConfigurationHelper - Class in org.eclipse.hono.util
-
Helper class for port configuration.
- PREFIX_FILE - Static variable in class org.eclipse.hono.config.AbstractConfig
-
The prefix indicating a file path.
- PREFIX_OPERATION - Static variable in class org.eclipse.hono.auth.AuthoritiesImpl
-
The prefix used to indicate an authority on an operation.
- PREFIX_RESOURCE - Static variable in class org.eclipse.hono.auth.AuthoritiesImpl
-
The prefix used to indicate an authority on a resource.
- principal() - Method in class org.eclipse.hono.auth.Device
-
Get the underlying principal of the device.
- PROTOCOL_ADAPTER_TYPE_AMQP - Static variable in class org.eclipse.hono.util.Constants
-
The type of the AMQP protocol adapter.
- PROTOCOL_ADAPTER_TYPE_COAP - Static variable in class org.eclipse.hono.util.Constants
-
The type of the CoAP protocol adapter.
- PROTOCOL_ADAPTER_TYPE_DEVICE_REGISTRY - Static variable in class org.eclipse.hono.util.Constants
-
The type of the protocol adapter which actually denotes the device registry.
- PROTOCOL_ADAPTER_TYPE_HTTP - Static variable in class org.eclipse.hono.util.Constants
-
The type of the HTTP protocol adapter.
- PROTOCOL_ADAPTER_TYPE_LORA - Static variable in class org.eclipse.hono.util.Constants
-
The type of the LoRaWAN protocol adapter.
- PROTOCOL_ADAPTER_TYPE_MQTT - Static variable in class org.eclipse.hono.util.Constants
-
The type of the MQTT protocol adapter.
- PROTOCOL_ADAPTER_TYPE_SIGFOX - Static variable in class org.eclipse.hono.util.Constants
-
The type of the sigfox protocol adapter.
- pubsub - Enum constant in enum class org.eclipse.hono.util.MessagingType
-
Pub/Sub based messaging infrastructure.
- put(String, Object) - Method in interface org.eclipse.hono.util.ExecutionContext
-
Sets a value for a key.
- put(String, Object) - Method in class org.eclipse.hono.util.MapBasedExecutionContext
- put(String, String) - Method in class org.eclipse.hono.tracing.JsonObjectExtractAdapter
- put(String, String) - Method in class org.eclipse.hono.tracing.JsonObjectInjectAdapter
- put(String, String) - Method in class org.eclipse.hono.tracing.MultiMapExtractAdapter
- put(String, String) - Method in class org.eclipse.hono.tracing.MultiMapInjectAdapter
- putExtension(String, Object) - Method in class org.eclipse.hono.util.Adapter
-
Adds an extension property to this adapter.
- putExtension(String, Object) - Method in class org.eclipse.hono.util.ResourceLimits
-
Adds an extension property to this resource limit.
Q
- QoS - Enum Class in org.eclipse.hono.util
-
Denotes the quality-of-service level (in Hono's terms) used for sending a message.
- QUALIFIER_AMQP - Static variable in class org.eclipse.hono.util.Constants
-
The qualifier to use for referring to AMQP based components.
- QUALIFIER_AUTHENTICATION - Static variable in class org.eclipse.hono.util.AuthenticationConstants
-
The qualifier to use for referring to components scoped to authentication.
- QUALIFIER_HTTP - Static variable in class org.eclipse.hono.util.Constants
-
The qualifier to use for referring to HTTP based components.
- QUALIFIER_MESSAGING - Static variable in class org.eclipse.hono.util.Constants
-
The qualifier to use for referring to the AMQP Messaging Network.
R
- READ - Enum constant in enum class org.eclipse.hono.auth.Activity
-
Permission required for receiving message from a node.
- readAll(Vertx, Path, Handler<AsyncResult<List<PemReader.Entry>>>) - Static method in class org.eclipse.hono.config.PemReader
-
Asynchronously reads a PEM file using vertx and report its entries.
- readAll(Reader) - Static method in class org.eclipse.hono.config.PemReader
-
Reads a PEM file and return its entries.
- readAll(Path) - Static method in class org.eclipse.hono.config.PemReader
-
Reads a PEM file and return its entries.
- readAllBlocking(Vertx, Path) - Static method in class org.eclipse.hono.config.PemReader
-
Reads a PEM file using vertx in blocking mode and return its entries.
- receiverLinkCredit() - Method in interface org.eclipse.hono.config.ServiceOptions
-
Gets the number of AMQP message credits this service flows to a client when the client opens a sender link to this service.
- REGISTER_COMMAND_CONSUMER - Enum constant in enum class org.eclipse.hono.util.CommandRouterConstants.CommandRouterAction
-
The register command consumer operation.
- REGISTRATION_ENDPOINT - Static variable in class org.eclipse.hono.util.RegistrationConstants
-
The name of the Device Registration API endpoint.
- RegistrationAssertion - Class in org.eclipse.hono.util
-
Encapsulates the registration assertion information for a device as defined by the Device Registration API.
- RegistrationAssertion(String) - Constructor for class org.eclipse.hono.util.RegistrationAssertion
-
Creates a new registration assertion for a device.
- RegistrationConstants - Class in org.eclipse.hono.util
-
Constants & utility methods used throughout the Registration API.
- RegistrationResult - Class in org.eclipse.hono.util
-
A container for the result returned by Hono's registration API.
- RegistryManagementConstants - Class in org.eclipse.hono.util
-
Constants & utility methods used throughout the Device Management API.
- remove - Enum constant in enum class org.eclipse.hono.util.TenantConstants.TenantAction
-
The remove Tenant operation.
- RequestResponseApiConstants - Class in org.eclipse.hono.util
-
Constants & utility methods that are common to APIs that follow the request response pattern.
- RequestResponseApiConstants() - Constructor for class org.eclipse.hono.util.RequestResponseApiConstants
-
Empty default constructor.
- RequestResponseResult<T> - Class in org.eclipse.hono.util
-
A container for the result returned by a Hono API that implements the request response pattern.
- RequestResponseResult(int, T, CacheDirective, Map<String, Object>) - Constructor for class org.eclipse.hono.util.RequestResponseResult
-
Creates a new result for a status code and payload.
- ResourceIdentifier - Class in org.eclipse.hono.util
-
A unique identifier for a resource within Hono.
- ResourceLimits - Class in org.eclipse.hono.util
-
Resource limits definition.
- ResourceLimits() - Constructor for class org.eclipse.hono.util.ResourceLimits
- ResourceLimitsPeriod - Class in org.eclipse.hono.util
-
The period definition corresponding to a resource limit for a tenant.
- ResourceLimitsPeriod(ResourceLimitsPeriod.PeriodMode) - Constructor for class org.eclipse.hono.util.ResourceLimitsPeriod
-
Creates a new period object for a mode.
- ResourceLimitsPeriod.PeriodMode - Enum Class in org.eclipse.hono.util
-
The mode of the data volume calculation.
- RSA_ALG - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the supported rsa algorithm.
- run() - Method in interface org.eclipse.hono.util.Futures.BlockingCode
-
Blocking method to run.
- runStopAttempt(Supplier<Future<Void>>) - Method in class org.eclipse.hono.util.LifecycleStatus
-
Executes an attempt to stop the tracked component.
S
- SECRETS_TYPE_HASHED_PASSWORD - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The type name that indicates a hashed password secret.
- SECRETS_TYPE_HASHED_PASSWORD - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The type name that indicates a hashed password secret.
- SECRETS_TYPE_PRESHARED_KEY - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The type name that indicates a pre-shared key secret.
- SECRETS_TYPE_PRESHARED_KEY - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The type name that indicates a pre-shared key secret.
- SECRETS_TYPE_RAW_PUBLIC_KEY - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The type name that indicates a raw public key secret.
- SECRETS_TYPE_RAW_PUBLIC_KEY - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The type name that indicates a raw public key secret.
- SECRETS_TYPE_X509_CERT - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The type name that indicates an X.509 client certificate secret.
- SECRETS_TYPE_X509_CERT - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The type name that indicates an X.509 client certificate secret.
- securePortEnabled() - Method in interface org.eclipse.hono.config.ServerOptions
-
Checks if this service has been configured to bind to the secure port during startup.
- secureProtocols() - Method in interface org.eclipse.hono.config.GenericOptions
-
Gets the secure protocols that are enabled for TLS connections.
- sendTimeOut() - Method in interface org.eclipse.hono.config.ServiceOptions
-
Gets the send timeout value in milliseconds, which is to be used when sending a message on the vert.x event bus.
- SERVER_ROLE_UNKNOWN - Static variable in class org.eclipse.hono.util.Constants
-
The unknown server role name.
- ServerConfig - Class in org.eclipse.hono.config
-
Configuration of properties that are common for components accepting requests/connections on a network socket.
- ServerConfig() - Constructor for class org.eclipse.hono.config.ServerConfig
-
Creates new properties using default values.
- ServerConfig(ServerOptions) - Constructor for class org.eclipse.hono.config.ServerConfig
-
Creates a new instance from existing options.
- serverOptions() - Method in interface org.eclipse.hono.config.ServiceOptions
-
Gets the server options.
- ServerOptions - Interface in org.eclipse.hono.config
-
Common options for configuring components accepting requests/connections on a network socket.
- SERVICE_NAME_AUTH - Static variable in class org.eclipse.hono.util.Constants
-
The (short) name of the Auth Server component.
- SERVICE_NAME_COMMAND_ROUTER - Static variable in class org.eclipse.hono.util.Constants
-
The (short) name of the Command Router service.
- SERVICE_NAME_DEVICE_REGISTRY - Static variable in class org.eclipse.hono.util.Constants
-
The (short) name of the Device Registry component.
- ServiceConfigProperties - Class in org.eclipse.hono.config
-
A POJO for configuring common properties of server components.
- ServiceConfigProperties() - Constructor for class org.eclipse.hono.config.ServiceConfigProperties
-
Creates new properties using default values.
- ServiceConfigProperties(ServiceOptions) - Constructor for class org.eclipse.hono.config.ServiceConfigProperties
-
Creates a new instance from existing options.
- ServiceOptions - Interface in org.eclipse.hono.config
-
Options for configuring Hono service components.
- SET_LAST_KNOWN_GATEWAY - Enum constant in enum class org.eclipse.hono.util.CommandRouterConstants.CommandRouterAction
-
The set last known gateway for device operation.
- setAdapters(List<Adapter>) - Method in class org.eclipse.hono.util.TenantObject
-
Sets the given list of adapters for the tenant.
- setAuthId(String) - Method in class org.eclipse.hono.util.CredentialsObject
-
Sets the authentication identifier that these these credentials are used for.
- setAuthorizedGateways(List<String>) - Method in class org.eclipse.hono.util.RegistrationAssertion
-
Sets the gateway devices that are authorized to act on behalf of the device.
- setBindAddress(String) - Method in class org.eclipse.hono.config.ServerConfig
-
Sets the host name or literal IP address of the network interface that this server's secure port should be bound to.
- setCertPath(String) - Method in class org.eclipse.hono.config.AbstractConfig
-
Sets the absolute path to the PEM file containing the X.509 certificate chain for the RSA private key that should be used for authentication to peers.
- setCommandEndpoint(CommandEndpoint) - Method in class org.eclipse.hono.util.RegistrationAssertion
-
Sets the command endpoint to be used when sending commands.
- setConfig(T) - Method in class org.eclipse.hono.util.ConfigurationSupportingVerticle
-
Sets the properties to use for configuring this Verticle.
- setConnectionDuration(ConnectionDuration) - Method in class org.eclipse.hono.util.ResourceLimits
-
Sets the properties that are required for the connection duration verification.
- setCorsAllowedOrigin(String) - Method in class org.eclipse.hono.config.ServiceConfigProperties
-
Sets the allowed origin pattern for CORS handler.
- setDataVolume(DataVolume) - Method in class org.eclipse.hono.util.ResourceLimits
-
Sets the data volume properties which are required for the message limit verification.
- setDefaults(JsonObject) - Method in class org.eclipse.hono.util.TenantObject
-
Sets the default property values to use for all devices of this tenant.
- setDefaults(Map<String, Object>) - Method in class org.eclipse.hono.util.RegistrationAssertion
-
Sets default properties to be used for augmenting messages from the device with missing information.
- setDeviceAuthenticationRequired(boolean) - Method in class org.eclipse.hono.util.Adapter
-
Sets whether devices are required to authenticate when connecting to this protocol adapter.
- setDeviceId(String) - Method in class org.eclipse.hono.util.CredentialsObject
-
Sets the identifier of the device that these credentials belong to.
- setDeviceIdPattern(String) - Method in class org.eclipse.hono.config.ServiceConfigProperties
-
Sets the regular expression defining valid device identifiers.
- setDeviceTags(Span, String, String) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Sets the tags identifying a device.
- setDeviceTags(Span, String, String, String) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Sets the tags identifying a device.
- setDownstreamMessageMapper(String) - Method in class org.eclipse.hono.util.RegistrationAssertion
-
Sets the name of the downstream mapper definition to use for the device.
- setEnabled(boolean) - Method in class org.eclipse.hono.util.Adapter
-
Sets whether devices should be able to connect to Hono using this protocol adapter.
- setEnabled(boolean) - Method in class org.eclipse.hono.util.CredentialsObject
-
Sets whether these credentials are enabled.
- setEventLoopBlockedCheckTimeout(long) - Method in class org.eclipse.hono.config.ServiceConfigProperties
-
Sets the time to wait for completion after which a handler is to be considered to be blocking the vert.x event loop.
- setExtensions(Map<String, Object>) - Method in class org.eclipse.hono.util.Adapter
-
Sets the extension properties for this adapter.
- setExtensions(Map<String, Object>) - Method in class org.eclipse.hono.util.ResourceLimits
-
Sets the extension properties for this resource limits.
- setHeaders(Map<String, String>) - Method in class org.eclipse.hono.util.CommandEndpoint
-
Sets headers to be used when sending a command to this endpoint.
- setInsecurePort(int) - Method in class org.eclipse.hono.config.ServerConfig
-
Sets the insecure port that this server should listen on.
- setInsecurePortBindAddress(String) - Method in class org.eclipse.hono.config.ServerConfig
-
Sets the host name or literal IP address of the network interface that this server's insecure port should be bound to.
- setInsecurePortEnabled(boolean) - Method in class org.eclipse.hono.config.ServerConfig
-
Sets whether this server should listen on the insecure port.
- setKeyFormat(FileFormat) - Method in class org.eclipse.hono.config.AbstractConfig
-
Specify the format of the key material explicitly.
- setKeyPath(String) - Method in class org.eclipse.hono.config.AbstractConfig
-
Sets the absolute path to the PEM file containing the RSA private key that should be used for authentication to peers.
- setKeyStorePassword(String) - Method in class org.eclipse.hono.config.AbstractConfig
-
Sets the password for the key store containing the private key and certificate chain that should be used for authentication to peers.
- setKeyStorePath(String) - Method in class org.eclipse.hono.config.AbstractConfig
-
Sets the absolute path to the key store containing the private key and certificate chain that should be used for authentication to peers.
- setMaxConnections(int) - Method in class org.eclipse.hono.util.ResourceLimits
-
Sets the maximum number of connected devices a tenant supports.
- setMaxPayloadSize(int) - Method in class org.eclipse.hono.config.ServiceConfigProperties
-
Sets the maximum size of a message payload this server accepts from clients.
- setMaxTtl(long) - Method in class org.eclipse.hono.util.ResourceLimits
-
Sets the maximum time-to-live to use for events published by devices of a tenant.
- setMaxTtlCommandResponse(long) - Method in class org.eclipse.hono.util.ResourceLimits
-
Sets the maximum time-to-live to use for command responses published by devices of a tenant.
- setMaxTtlTelemetryQoS0(long) - Method in class org.eclipse.hono.util.ResourceLimits
-
Sets the maximum time-to-live to use for telemetry messages published by devices of a tenant with QoS 0.
- setMaxTtlTelemetryQoS1(long) - Method in class org.eclipse.hono.util.ResourceLimits
-
Sets the maximum time-to-live to use for telemetry messages published by devices of a tenant with QoS 1.
- setMinimumMessageSize(int) - Method in class org.eclipse.hono.util.TenantObject
-
Sets the minimum message size in bytes.
- setNativeTlsRequired(boolean) - Method in class org.eclipse.hono.config.ServerConfig
-
Sets if this server should require the usage of a native TLS implementation.
- setNetworkDebugLoggingEnabled(boolean) - Method in class org.eclipse.hono.config.ServiceConfigProperties
-
Sets whether the server should log TCP traffic.
- setNoOfDays(int) - Method in class org.eclipse.hono.util.ResourceLimitsPeriod
-
Sets the number of days for which resource usage is calculated.
- setPathSeparator(String) - Method in class org.eclipse.hono.config.AbstractConfig
-
Sets the character separating the segments of target addresses.
- setPayloadProperties(Map<String, String>) - Method in class org.eclipse.hono.util.CommandEndpoint
-
Sets payload properties to be used when sending a command to this endpoint.
- setPort(int) - Method in class org.eclipse.hono.config.ServerConfig
-
Sets the secure port that this server should listen on.
- setProperty(String, Object) - Method in class org.eclipse.hono.util.CredentialsObject
-
Adds a property to these credentials.
- setProperty(String, Object) - Method in class org.eclipse.hono.util.TenantObject
-
Adds a property to this tenant.
- setReceiverLinkCredit(int) - Method in class org.eclipse.hono.config.ServiceConfigProperties
-
Sets the number of AMQP message credits this service flows to a client when the client opens a sender link to this service.
- setResourceLimits(JsonObject) - Method in class org.eclipse.hono.util.TenantObject
-
Sets the resource limits for the tenant.
- setResourceLimits(ResourceLimits) - Method in class org.eclipse.hono.util.TenantObject
-
Sets the resource limits for the tenant.
- setSamplingMode(TracingSamplingMode) - Method in class org.eclipse.hono.util.TenantTracingConfig
-
Sets the sampling mode that defines in how far spans created when processing messages for a tenant shall be recorded (sampled) by the tracing system.
- setSamplingModePerAuthId(Map<String, TracingSamplingMode>) - Method in class org.eclipse.hono.util.TenantTracingConfig
-
Sets the sampling modes defined for specific devices.
- setSecureProtocols(List<String>) - Method in class org.eclipse.hono.config.AbstractConfig
-
Sets the secure protocols that are enabled for TLS connections.
- setSendTimeOut(long) - Method in class org.eclipse.hono.config.ServiceConfigProperties
-
Sets the send timeout value in milliseconds, which is to be used when sending a message on the vert.x event bus.
- setSni(boolean) - Method in class org.eclipse.hono.config.ServerConfig
-
Sets whether the server should support Server Name Indication for TLS connections.
- setStarted() - Method in class org.eclipse.hono.util.LifecycleStatus
-
Marks the tracked component as being started up.
- setStarting() - Method in class org.eclipse.hono.util.LifecycleStatus
-
Marks the tracked component as being in the process of starting up.
- setStopped() - Method in class org.eclipse.hono.util.LifecycleStatus
-
Marks the tracked component as being shut down.
- setStopped(AsyncResult<Void>) - Method in class org.eclipse.hono.util.LifecycleStatus
-
Marks the tracked component as being shut down.
- setStopping() - Method in class org.eclipse.hono.util.LifecycleStatus
-
Marks the tracked component as being in the process of shutting down.
- setSupportedCipherSuites(List<String>) - Method in class org.eclipse.hono.config.AbstractConfig
-
Sets the names of the cipher suites that may be used in TLS connections.
- setTenantIdPattern(String) - Method in class org.eclipse.hono.config.ServiceConfigProperties
-
Sets the regular expression defining valid tenant identifiers.
- setTraceSamplingPriority(Span, int) - Static method in class org.eclipse.hono.tracing.TracingHelper
-
Sets a "sampling.priority" tag and baggage item with the given samplingPriority value in the given span.
- setTracingConfig(TenantTracingConfig) - Method in class org.eclipse.hono.util.TenantObject
-
Sets this tenant's tracing configuration.
- setTrustAnchor(PublicKey, X500Principal) - Method in class org.eclipse.hono.util.TenantObject
-
Sets the trusted certificate authority to use for authenticating devices of this tenant.
- setTrustStoreFormat(FileFormat) - Method in class org.eclipse.hono.config.AbstractConfig
-
Specify the format of the trust store explicitly.
- setTrustStorePassword(String) - Method in class org.eclipse.hono.config.AbstractConfig
-
Sets the password for accessing the key store containing the certificates of trusted CAs.
- setTrustStorePath(String) - Method in class org.eclipse.hono.config.AbstractConfig
-
Sets the path to the key store to load certificates of trusted CAs from.
- setType(String) - Method in class org.eclipse.hono.util.CredentialsObject
-
Sets the type of these credentials.
- setUpstreamMessageMapper(String) - Method in class org.eclipse.hono.util.RegistrationAssertion
-
Sets the name of the upstream mapper definition to use for the device.
- setUri(String) - Method in class org.eclipse.hono.util.CommandEndpoint
-
Sets the URI to be used when sending a command to this endpoint.
- setWaitForDownstreamConnectionEnabled(boolean) - Method in class org.eclipse.hono.config.ServiceConfigProperties
-
Sets whether the server should wait for downstream connections to be established during startup.
- sni() - Method in interface org.eclipse.hono.config.ServerOptions
-
Checks if the server supports Server Name Indication for TLS connections.
- SPECIFIER_WILDCARD - Static variable in class org.eclipse.hono.util.CredentialsConstants
-
The name of the field that contains the pattern to use for matching authentication identifiers.
- start() - Method in interface org.eclipse.hono.util.Lifecycle
-
Starts this component.
- start(Promise<Void>) - Method in class org.eclipse.hono.util.WrappedLifecycleComponentVerticle
- STARTED - Enum constant in enum class org.eclipse.hono.util.LifecycleStatus.Status
-
The state representing a component that has been started.
- STARTING - Enum constant in enum class org.eclipse.hono.util.LifecycleStatus.Status
-
The state representing the process of starting up a component.
- stop() - Method in interface org.eclipse.hono.util.Lifecycle
-
Stops this component.
- stop(Promise<Void>) - Method in class org.eclipse.hono.util.WrappedLifecycleComponentVerticle
- STOPPED - Enum constant in enum class org.eclipse.hono.util.LifecycleStatus.Status
-
The state representing a component that has not been started yet or that has been stopped again.
- STOPPING - Enum constant in enum class org.eclipse.hono.util.LifecycleStatus.Status
-
The state representing the process of shutting down a component.
- Strings - Class in org.eclipse.hono.util
-
A helper class for working with
String
s. - supportedCipherSuites() - Method in interface org.eclipse.hono.config.GenericOptions
-
Gets the names of the cipher suites that may be used in TLS connections.
- SUSPECTED_DEAD - Enum constant in enum class org.eclipse.hono.util.AdapterInstanceStatus
-
Adapter instance has probably been terminated.
- SYS_HEADER_PROPERTY_DELIVERY_COUNT - Static variable in class org.eclipse.hono.util.MessageHelper
-
The AMQP 1.0 delivery-count message header property.
- SYS_HEADER_PROPERTY_DURABLE - Static variable in class org.eclipse.hono.util.MessageHelper
-
The AMQP 1.0 durable message header property.
- SYS_HEADER_PROPERTY_FIRST_ACQUIRER - Static variable in class org.eclipse.hono.util.MessageHelper
-
The AMQP 1.0 first-acquirer message header property.
- SYS_HEADER_PROPERTY_PRIORITY - Static variable in class org.eclipse.hono.util.MessageHelper
-
The AMQP 1.0 priority message header property.
- SYS_HEADER_PROPERTY_TTL - Static variable in class org.eclipse.hono.util.MessageHelper
-
The AMQP 1.0 ttl message header property.
- SYS_PROPERTY_ABSOLUTE_EXPIRY_TIME - Static variable in class org.eclipse.hono.util.MessageHelper
-
The AMQP 1.0 absolute-expiry-time message property.
- SYS_PROPERTY_CONTENT_ENCODING - Static variable in class org.eclipse.hono.util.MessageHelper
-
The AMQP 1.0 content-encoding message property.
- SYS_PROPERTY_CONTENT_TYPE - Static variable in class org.eclipse.hono.util.MessageHelper
-
The AMQP 1.0 content-type message property.
- SYS_PROPERTY_CORRELATION_ID - Static variable in class org.eclipse.hono.util.MessageHelper
-
The AMQP 1.0 correlation-id message property.
- SYS_PROPERTY_CREATION_TIME - Static variable in class org.eclipse.hono.util.MessageHelper
-
The AMQP 1.0 creation-time message property.
- SYS_PROPERTY_GROUP_ID - Static variable in class org.eclipse.hono.util.MessageHelper
-
The AMQP 1.0 group-id message property.
- SYS_PROPERTY_GROUP_SEQUENCE - Static variable in class org.eclipse.hono.util.MessageHelper
-
The AMQP 1.0 group-sequence message property.
- SYS_PROPERTY_MESSAGE_ID - Static variable in class org.eclipse.hono.util.MessageHelper
-
The AMQP 1.0 message-id message property.
- SYS_PROPERTY_REPLY_TO - Static variable in class org.eclipse.hono.util.MessageHelper
-
The AMQP 1.0 reply-to message property.
- SYS_PROPERTY_REPLY_TO_GROUP_ID - Static variable in class org.eclipse.hono.util.MessageHelper
-
The AMQP 1.0 reply-to-group-id message property.
- SYS_PROPERTY_SUBJECT - Static variable in class org.eclipse.hono.util.MessageHelper
-
The AMQP 1.0 subject message property.
- SYS_PROPERTY_TO - Static variable in class org.eclipse.hono.util.MessageHelper
-
The AMQP 1.0 to message property.
- SYS_PROPERTY_USER_ID - Static variable in class org.eclipse.hono.util.MessageHelper
-
The AMQP 1.0 user-id message property.
- SYSTEM_PROPERTY_USERNAME_REGEX - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the system property that contains the regular expression to use for validating authentication IDs of hashed-password secrets.
T
- TAG_ADAPTER_INSTANCE_ID - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing tag indicating the identifier of a protocol adapter instance.
- TAG_AUTH_ID - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing tag that contains the authentication identifier used by a device.
- TAG_AUTHENTICATED - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing tag indicating if a client (device) has been authenticated.
- TAG_CACHE_HIT - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing tag that is used to indicate if the result of an operation has been taken from a local cache.
- TAG_CLIENT_ID - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing tag that contains the (transport protocol specific) identifier of a client connecting to a server.
- TAG_CORRELATION_ID - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing tag that contains the identifier used to correlate a response with a request message.
- TAG_CREDENTIALS_TYPE - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing tag that contains the type of credentials used by a device.
- TAG_CREDIT - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing tag that contains the number of available credits for a sender link.
- TAG_DEVICE_ID - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing tag that contains the device identifier.
- TAG_DEVICE_TTD - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing tag that contains the time that a device will wait for an upstream message before disconnecting.
- TAG_GATEWAY_ID - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing tag that contains the gateway identifier.
- TAG_MESSAGE_ID - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing tag that contains the identifier of a (request) message.
- TAG_PEER_CONTAINER - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing tag that indicates the container id of a remote peer.
- TAG_QOS - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing tag that contains the QoS that a device has used for publishing a message.
- TAG_REMOTE_STATE - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing tag that indicates the remote delivery state of an AMQP 1.0 message transfer.
- TAG_RESOURCE_VERSION - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing tag that contains the version of a resource, for example a record in a database.
- TAG_SUBJECT_DN - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing tag that contains an X.500 Subject DN.
- TAG_TENANT_ID - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing tag that contains the tenant identifier.
- TAG_TLS - Static variable in class org.eclipse.hono.tracing.TracingHelper
-
An OpenTracing tag indicating if a client's connection is secured using TLS.
- TELEMETRY_ENDPOINT - Static variable in class org.eclipse.hono.util.TelemetryConstants
-
The name of the Telemetry API endpoint.
- TELEMETRY_ENDPOINT_SHORT - Static variable in class org.eclipse.hono.util.TelemetryConstants
-
The short name of the Telemetry API endpoint.
- TelemetryConstants - Class in org.eclipse.hono.util
-
Constants & utility methods used throughout the Telemetry API.
- TENANT_ENDPOINT - Static variable in class org.eclipse.hono.util.TenantConstants
-
The name of the Tenant API endpoint.
- TENANT_HTTP_ENDPOINT - Static variable in class org.eclipse.hono.util.RegistryManagementConstants
-
The name of the HTTP endpoint for the Tenant API.
- TenantConstants - Class in org.eclipse.hono.util
-
Constants & utility methods used throughout the Tenant API.
- TenantConstants.TenantAction - Enum Class in org.eclipse.hono.util
-
Request actions that belong to the Tenant API.
- tenantIdPattern() - Method in interface org.eclipse.hono.config.ServiceOptions
-
Gets the pattern defining valid tenant identifiers.
- TenantObject - Class in org.eclipse.hono.util
-
Encapsulates the tenant information that was found by the get operation of the Tenant API.
- TenantObject(String, boolean) - Constructor for class org.eclipse.hono.util.TenantObject
-
Creates a new tenant.
- TenantResult<T> - Class in org.eclipse.hono.util
-
A container for the result returned by Hono's Tenant API.
- TenantTraceSamplingHelper - Class in org.eclipse.hono.tracing
-
A helper class for applying the tenant specific trace sampling configuration.
- TenantTracingConfig - Class in org.eclipse.hono.util
-
A tenant specific tracing configuration.
- TenantTracingConfig() - Constructor for class org.eclipse.hono.util.TenantTracingConfig
- three() - Method in class org.eclipse.hono.util.TriTuple
-
Gets this tuple's third value.
- toPath() - Method in class org.eclipse.hono.util.ResourceIdentifier
-
Gets this resource identifier as path segments.
- TOPIC_POSITION_RESPONSE_REQ_ID - Static variable in class org.eclipse.hono.util.CommandConstants
-
Position of the request id in the MQTT command response topic.
- TOPIC_POSITION_RESPONSE_STATUS - Static variable in class org.eclipse.hono.util.CommandConstants
-
Position of the status code in the MQTT command response topic.
- toString() - Method in class org.eclipse.hono.auth.Device
- toString() - Method in class org.eclipse.hono.util.CacheDirective
-
Creates a string representation of this directive.
- toString() - Method in class org.eclipse.hono.util.IdentityTemplate
- toString() - Method in class org.eclipse.hono.util.Pair
- toString() - Method in class org.eclipse.hono.util.ResourceIdentifier
-
Gets a string representation of this resource identifier.
- toString() - Method in class org.eclipse.hono.util.TriTuple
- TracingHelper - Class in org.eclipse.hono.tracing
-
A helper class providing utility methods for interacting with the OpenTracing API.
- TracingSamplingMode - Enum Class in org.eclipse.hono.util
-
Value that defines in how far OpenTracing spans shall be recorded (sampled) by the tracing system.
- TriTuple<A,
B, C> - Class in org.eclipse.hono.util -
A tuple of three values of arbitrary type.
- trustStoreFormat() - Method in interface org.eclipse.hono.config.GenericOptions
-
Get the specified format of the trust store.
- trustStorePassword() - Method in interface org.eclipse.hono.config.GenericOptions
-
Gets the password for accessing the key store containing the certificates of trusted CAs.
- trustStorePath() - Method in interface org.eclipse.hono.config.GenericOptions
-
Gets the path to the key store to load certificates of trusted CAs from.
- tryHandleResult(Promise<T>, AsyncResult<T>) - Static method in class org.eclipse.hono.util.Futures
-
Applies the given result on the given promise using
Promise.tryComplete(Object)
orPromise.tryFail(Throwable)
. - TTD_VALUE_UNLIMITED - Static variable in class org.eclipse.hono.util.MessageHelper
-
The time-til-disconnect value to use for indicating that a device will remain connected until further notice.
- two() - Method in class org.eclipse.hono.util.Pair
-
Gets this pair's second value.
- two() - Method in class org.eclipse.hono.util.TriTuple
-
Gets this tuple's second value.
- TYPE_AMQP_JWT - Static variable in class org.eclipse.hono.util.AuthenticationConstants
-
The type indicating a JSON Web Token being contained in a message body.
U
- unknown - Enum constant in enum class org.eclipse.hono.util.CredentialsConstants.CredentialsAction
-
The name that all unknown operations are mapped to.
- unknown - Enum constant in enum class org.eclipse.hono.util.ResourceLimitsPeriod.PeriodMode
-
The unknown mode.
- UNKNOWN - Enum constant in enum class org.eclipse.hono.util.AdapterInstanceStatus
-
State of adapter instance can't be determined.
- UNKNOWN - Enum constant in enum class org.eclipse.hono.util.CommandRouterConstants.CommandRouterAction
-
The unknown operation.
- UNLIMITED_BYTES - Static variable in class org.eclipse.hono.util.TenantConstants
-
The value indicating an unlimited number of bytes to be allowed for a tenant.
- UNLIMITED_CONNECTIONS - Static variable in class org.eclipse.hono.util.TenantConstants
-
The value indicating an unlimited number of connections to be allowed for a tenant.
- UNLIMITED_MINUTES - Static variable in class org.eclipse.hono.util.TenantConstants
-
The value indicating an unlimited number of minutes to be allowed for a tenant.
- UNLIMITED_TTL - Static variable in class org.eclipse.hono.util.TenantConstants
-
The value indicating unlimited time-to-live for downstream events.
- UNREGISTER_COMMAND_CONSUMER - Enum constant in enum class org.eclipse.hono.util.CommandRouterConstants.CommandRouterAction
-
The unregister command consumer operation.
- update - Enum constant in enum class org.eclipse.hono.util.CredentialsConstants.CredentialsAction
-
The AMQP subject property value to use for invoking the update Credentials operation.
- update - Enum constant in enum class org.eclipse.hono.util.TenantConstants.TenantAction
-
The update Tenant operation.
V
- valueOf(String) - Static method in enum class org.eclipse.hono.auth.Activity
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.hono.config.FileFormat
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.hono.util.AdapterInstanceStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.hono.util.CommandRouterConstants.CommandRouterAction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.hono.util.CredentialsConstants.CredentialsAction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.hono.util.EventConstants.RegistrationStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.hono.util.LifecycleStatus.Status
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.hono.util.MessagingType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.hono.util.QoS
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.hono.util.ResourceLimitsPeriod.PeriodMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.hono.util.TenantConstants.TenantAction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.hono.util.TracingSamplingMode
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.eclipse.hono.auth.Activity
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.hono.config.FileFormat
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.hono.util.AdapterInstanceStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.hono.util.CommandRouterConstants.CommandRouterAction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.hono.util.CredentialsConstants.CredentialsAction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.hono.util.EventConstants.RegistrationStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.hono.util.LifecycleStatus.Status
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.hono.util.MessagingType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.hono.util.QoS
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.hono.util.ResourceLimitsPeriod.PeriodMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.hono.util.TenantConstants.TenantAction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.hono.util.TracingSamplingMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- waitForDownstreamConnectionEnabled() - Method in interface org.eclipse.hono.config.ServiceOptions
-
Checks whether the server waits for downstream connections to be established during startup.
- WrappedLifecycleComponentVerticle - Class in org.eclipse.hono.util
-
Enables a component with life cycle support to be used as a vert.x verticle.
- WrappedLifecycleComponentVerticle(Lifecycle) - Constructor for class org.eclipse.hono.util.WrappedLifecycleComponentVerticle
-
Creates a new WrappedLifecycleComponentVerticle.
- WRITE - Enum constant in enum class org.eclipse.hono.auth.Activity
-
Permission required for sending messages to a node.
All Classes and Interfaces|All Packages|Constant Field Values