Package org.eclipse.hono.adapter.mqtt

Class MqttProtocolAdapterProperties

  • public class MqttProtocolAdapterProperties
extends org.eclipse.hono.config.ProtocolAdapterProperties
    Properties for configuring an MQTT based protocol adapter.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected static int DEFAULT_COMMAND_ACK_TIMEOUT
      The default number of milliseconds to wait for PUBACK.
      protected static long DEFAULT_SEND_MESSAGE_TO_DEVICE_TIMEOUT
      The amount of time (in milliseconds) to wait for a device to acknowledge receiving a command message.

      • Fields inherited from class org.eclipse.hono.config.ProtocolAdapterProperties

        DEFAULT_TENANT_IDLE_TIMEOUT

      • Fields inherited from class org.eclipse.hono.config.ServiceConfigProperties

        DEFAULT_MAX_PAYLOAD_SIZE, DEFAULT_RECEIVER_LINK_CREDITS, DEFAULT_SEND_TIMEOUT_IN_MS

      • Fields inherited from class org.eclipse.hono.config.AbstractConfig

        LOG, PREFIX_FILE

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      int getCommandAckTimeout()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use getSendMessageToDeviceTimeout() instead.
      long getSendMessageToDeviceTimeout()
      Gets the waiting for acknowledgement timeout in milliseconds for commands published with QoS 1.
      void setCommandAckTimeout​(int timeout)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use setSendMessageToDeviceTimeout(long) ()} instead.
      void setSendMessageToDeviceTimeout​(long sendMessageToDeviceTimeout)
      Sets the waiting for acknowledgement timeout in milliseconds for commands published with QoS 1.

      • Methods inherited from class org.eclipse.hono.config.ProtocolAdapterProperties

        getMapperEndpoint, getMaxConnections, getTenantIdleTimeout, isAuthenticationRequired, isConnectionLimitConfigured, isDefaultsEnabled, isJmsVendorPropsEnabled, setAuthenticationRequired, setDefaultsEnabled, setJmsVendorPropsEnabled, setMapperEndpoints, setMaxConnections, setTenantIdleTimeout

      • Methods inherited from class org.eclipse.hono.config.ServiceConfigProperties

        getCorsAllowedOrigin, getDeviceIdPattern, getEventLoopBlockedCheckTimeout, getMaxPayloadSize, getReceiverLinkCredit, getSendTimeOut, getTenantIdPattern, isNetworkDebugLoggingEnabled, isWaitForDownstreamConnectionEnabled, setCorsAllowedOrigin, setDeviceIdPattern, setEventLoopBlockedCheckTimeout, setMaxPayloadSize, setNetworkDebugLoggingEnabled, setReceiverLinkCredit, setSendTimeOut, setTenantIdPattern, setWaitForDownstreamConnectionEnabled

      • Methods inherited from class org.eclipse.hono.config.ServerConfig

        getBindAddress, getInsecurePort, getInsecurePort, getInsecurePortBindAddress, getPort, getPort, isInsecurePortEnabled, isNativeTlsRequired, isSecurePortEnabled, isSni, isSubstrateVm, setBindAddress, setInsecurePort, setInsecurePortBindAddress, setInsecurePortEnabled, setNativeTlsRequired, setPort, setSni

      • Methods inherited from class org.eclipse.hono.config.AbstractConfig

        getCertPath, getKeyCertOptions, getKeyFormat, getKeyPath, getKeyStorePassword, getKeyStorePath, getPassword, getPathSeparator, getSecureProtocols, getSupportedCipherSuites, getTrustOptions, getTrustStoreFormat, getTrustStorePassword, getTrustStorePath, isValidPort, setCertPath, setKeyFormat, setKeyPath, setKeyStorePassword, setKeyStorePath, setPathSeparator, setSecureProtocols, setSupportedCipherSuites, setTrustStoreFormat, setTrustStorePassword, setTrustStorePath

    • Field Detail

      • DEFAULT_COMMAND_ACK_TIMEOUT

        protected static final int DEFAULT_COMMAND_ACK_TIMEOUT
        The default number of milliseconds to wait for PUBACK.
        See Also:
        Constant Field Values

      • DEFAULT_SEND_MESSAGE_TO_DEVICE_TIMEOUT

        protected static final long DEFAULT_SEND_MESSAGE_TO_DEVICE_TIMEOUT
        The amount of time (in milliseconds) to wait for a device to acknowledge receiving a command message.
        See Also:
        Constant Field Values

    • Constructor Detail

      • MqttProtocolAdapterProperties

        public MqttProtocolAdapterProperties()
        Creates properties using default values.

      • MqttProtocolAdapterProperties

        public MqttProtocolAdapterProperties​(MqttProtocolAdapterOptions options)
        Creates properties using existing options.
        Parameters:
        options - The options to copy.

    • Method Detail

      • getCommandAckTimeout

        @Deprecated(forRemoval=true)
public final int getCommandAckTimeout()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use getSendMessageToDeviceTimeout() instead.
        Gets the waiting for acknowledgement timeout in milliseconds for commands published with QoS 1.

        This timeout is used by the MQTT adapter for commands published with QoS 1. If there is no acknowledgement within this time limit, then the command is settled with the released outcome.

        The default value is DEFAULT_COMMAND_ACK_TIMEOUT.

        Returns:
        The timeout in milliseconds.

      • setCommandAckTimeout

        @Deprecated(forRemoval=true)
public final void setCommandAckTimeout​(int timeout)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setSendMessageToDeviceTimeout(long) ()} instead.
        Sets the waiting for acknowledgement timeout in milliseconds for commands published with QoS 1.

        This timeout is used by the MQTT adapter for commands published with QoS 1. If there is no acknowledgement within this time limit, then the command is settled with the released outcome.

        The default value is DEFAULT_COMMAND_ACK_TIMEOUT.

        Parameters:
        timeout - The timeout in milliseconds.
        Throws:
        IllegalArgumentException - if the timeout is negative.

      • getSendMessageToDeviceTimeout

        public final long getSendMessageToDeviceTimeout()
        Gets the waiting for acknowledgement timeout in milliseconds for commands published with QoS 1.

        This timeout is used by the MQTT adapter for commands published with QoS 1. If there is no acknowledgement within this time limit, then the command is settled with the released outcome.

        The default value of this property is DEFAULT_SEND_MESSAGE_TO_DEVICE_TIMEOUT.

        Returns:
        The timeout in milliseconds.

      • setSendMessageToDeviceTimeout

        public final void setSendMessageToDeviceTimeout​(long sendMessageToDeviceTimeout)
        Sets the waiting for acknowledgement timeout in milliseconds for commands published with QoS 1.

        This timeout is used by the MQTT adapter for commands published with QoS 1. If there is no acknowledgement within this time limit, then the command is settled with the released outcome.

        The default value of this property is DEFAULT_SEND_MESSAGE_TO_DEVICE_TIMEOUT.

        Parameters:
        sendMessageToDeviceTimeout - The timeout in milliseconds.
        Throws:
        IllegalArgumentException - if the timeout is negative.