com.hivemq.client.internal.mqtt

Class MqttClientConnectionConfig

java.lang.Object

com.hivemq.client.internal.mqtt.MqttClientConnectionConfig

All Implemented Interfaces:

Mqtt3ClientConnectionConfig, Mqtt3ClientConnectionConfig.RestrictionsForClient, Mqtt5ClientConnectionConfig, Mqtt5ClientConnectionConfig.RestrictionsForClient, Mqtt5ClientConnectionConfig.RestrictionsForServer, MqttClientConnectionConfig

public class MqttClientConnectionConfig
extends java.lang.Object
implements Mqtt5ClientConnectionConfig, Mqtt5ClientConnectionConfig.RestrictionsForServer, Mqtt5ClientConnectionConfig.RestrictionsForClient, Mqtt3ClientConnectionConfig, Mqtt3ClientConnectionConfig.RestrictionsForClient

Nested Class Summary

Nested classes/interfaces inherited from interface com.hivemq.client.mqtt.mqtt5.Mqtt5ClientConnectionConfig

Mqtt5ClientConnectionConfig.RestrictionsForClient, Mqtt5ClientConnectionConfig.RestrictionsForServer

Nested classes/interfaces inherited from interface com.hivemq.client.mqtt.mqtt3.Mqtt3ClientConnectionConfig

Mqtt3ClientConnectionConfig.RestrictionsForClient

Constructor Summary

Constructors

Constructor and Description

MqttClientConnectionConfig(int keepAlive, long sessionExpiryInterval, boolean hasWillPublish, @Nullable Mqtt5EnhancedAuthMechanism enhancedAuthMechanism, int receiveMaximum, int maximumPacketSize, int topicAliasMaximum, boolean problemInformationRequested, boolean responseInformationRequested, int sendMaximum, int sendMaximumPacketSize, int sendTopicAliasMaximum, @NotNull MqttQos maximumQos, boolean retainAvailable, boolean wildcardSubscriptionAvailable, boolean sharedSubscriptionAvailable, boolean subscriptionIdentifiersAvailable, @NotNull io.netty.channel.Channel channel)

Method Summary

Modifier and Type	Method and Description
boolean	areSubscriptionIdentifiersAvailable() Returns whether the server accepts subscription identifiers from the client.
@NotNull io.netty.channel.Channel	getChannel()
@NotNull java.util.Optional<Mqtt5EnhancedAuthMechanism>	getEnhancedAuthMechanism()
int	getKeepAlive()
int	getMaximumPacketSize() Returns the maximum packet size the client accepts from the server.
@NotNull MqttQos	getMaximumQos() Returns the maximum QoS the server accepts from the client.
@Nullable Mqtt5EnhancedAuthMechanism	getRawEnhancedAuthMechanism()
int	getReceiveMaximum() Returns the maximum amount of not acknowledged publishes with QoS 1 or 2 the client accepts from the server concurrently.
@NotNull MqttClientConnectionConfig	getRestrictionsForClient()
@NotNull MqttClientConnectionConfig	getRestrictionsForServer()
int	getSendMaximum() Returns the maximum amount of not acknowledged publishes with QoS 1 or 2 the client sends to the server concurrently.
int	getSendMaximumPacketSize() Returns the maximum packet size the client sends to the server.
@Nullable MqttTopicAliasMapping	getSendTopicAliasMapping()
int	getSendTopicAliasMaximum() Returns the maximum amount of topic aliases the client sends to the server.
long	getSessionExpiryInterval()
int	getTopicAliasMaximum() Returns the maximum amount of topic aliases the client accepts from the server.
boolean	hasWillPublish()
boolean	isProblemInformationRequested() Returns whether the client requested problem information from the server.
boolean	isResponseInformationRequested() Returns whether the client requested response information from the server.
boolean	isRetainAvailable() Returns whether the server accepts retained messages from the client.
boolean	isSharedSubscriptionAvailable() Returns whether the server accepts shared subscriptions from the client.
boolean	isWildcardSubscriptionAvailable() Returns whether the server accepts wildcard subscriptions from the client.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MqttClientConnectionConfig

public MqttClientConnectionConfig(int keepAlive,
                                  long sessionExpiryInterval,
                                  boolean hasWillPublish,
                                  @Nullable
                                  @Nullable Mqtt5EnhancedAuthMechanism enhancedAuthMechanism,
                                  int receiveMaximum,
                                  int maximumPacketSize,
                                  int topicAliasMaximum,
                                  boolean problemInformationRequested,
                                  boolean responseInformationRequested,
                                  int sendMaximum,
                                  int sendMaximumPacketSize,
                                  int sendTopicAliasMaximum,
                                  @NotNull
                                  @NotNull MqttQos maximumQos,
                                  boolean retainAvailable,
                                  boolean wildcardSubscriptionAvailable,
                                  boolean sharedSubscriptionAvailable,
                                  boolean subscriptionIdentifiersAvailable,
                                  @NotNull
                                  @NotNull io.netty.channel.Channel channel)

Method Detail

getKeepAlive

public int getKeepAlive()

Specified by:

getKeepAlive in interface MqttClientConnectionConfig

Returns:

the keep alive in seconds that is used while the client is connected.

getSessionExpiryInterval

public long getSessionExpiryInterval()

Specified by:

getSessionExpiryInterval in interface Mqtt5ClientConnectionConfig

Returns:

the session expiry interval in seconds.

hasWillPublish

public boolean hasWillPublish()

Specified by:

hasWillPublish in interface MqttClientConnectionConfig

Returns:

whether the client connected with a Will Publish message.

getEnhancedAuthMechanism

@NotNull
public @NotNull java.util.Optional<Mqtt5EnhancedAuthMechanism> getEnhancedAuthMechanism()

Specified by:

getEnhancedAuthMechanism in interface Mqtt5ClientConnectionConfig

Returns:

the optional enhanced auth mechanism that is used for enhanced authentication and/or authorization.

getRawEnhancedAuthMechanism

@Nullable
public @Nullable Mqtt5EnhancedAuthMechanism getRawEnhancedAuthMechanism()

getRestrictionsForServer

@NotNull
public @NotNull MqttClientConnectionConfig getRestrictionsForServer()

Specified by:

getRestrictionsForServer in interface Mqtt5ClientConnectionConfig

Returns:

the restrictions for messages the client receives.

getRestrictionsForClient

@NotNull
public @NotNull MqttClientConnectionConfig getRestrictionsForClient()

Specified by:

getRestrictionsForClient in interface Mqtt3ClientConnectionConfig

Specified by:

getRestrictionsForClient in interface Mqtt5ClientConnectionConfig

Returns:

the restrictions for messages the client sends.

getReceiveMaximum

public int getReceiveMaximum()

Description copied from interface: Mqtt5ClientConnectionConfig.RestrictionsForServer

Returns the maximum amount of not acknowledged publishes with QoS 1 or 2 the client accepts from the server concurrently.

The value is determined by Mqtt5ConnectRestrictions#getReceiveMaximum().

Specified by:

getReceiveMaximum in interface Mqtt5ClientConnectionConfig.RestrictionsForServer

Returns:

the maximum amount of not acknowledged publishes with QoS 1 or 2 the client accepts from the server concurrently.

getMaximumPacketSize

public int getMaximumPacketSize()

Description copied from interface: Mqtt5ClientConnectionConfig.RestrictionsForServer

Returns the maximum packet size the client accepts from the server.

The value is determined by Mqtt5ConnectRestrictions#getMaximumPacketSize().

Specified by:

getMaximumPacketSize in interface Mqtt5ClientConnectionConfig.RestrictionsForServer

Returns:

the maximum packet size the client accepts from the server.

getTopicAliasMaximum

public int getTopicAliasMaximum()

Description copied from interface: Mqtt5ClientConnectionConfig.RestrictionsForServer

Returns the maximum amount of topic aliases the client accepts from the server.

The value is determined by Mqtt5ConnectRestrictions#getTopicAliasMaximum().

Specified by:

getTopicAliasMaximum in interface Mqtt5ClientConnectionConfig.RestrictionsForServer

Returns:

the maximum amount of topic aliases the client accepts from the server.

isProblemInformationRequested

public boolean isProblemInformationRequested()

Description copied from interface: Mqtt5ClientConnectionConfig.RestrictionsForServer

Returns whether the client requested problem information from the server.

The value is determined by Mqtt5ConnectRestrictions#isRequestProblemInformation().

Specified by:

isProblemInformationRequested in interface Mqtt5ClientConnectionConfig.RestrictionsForServer

Returns:

whether the client requested problem information from the server.

isResponseInformationRequested

public boolean isResponseInformationRequested()

Description copied from interface: Mqtt5ClientConnectionConfig.RestrictionsForServer

Returns whether the client requested response information from the server.

The value is determined by Mqtt5ConnectRestrictions#isRequestResponseInformation().

Specified by:

isResponseInformationRequested in interface Mqtt5ClientConnectionConfig.RestrictionsForServer

Returns:

whether the client requested response information from the server.

getSendMaximum

public int getSendMaximum()

Description copied from interface: Mqtt5ClientConnectionConfig.RestrictionsForClient

Returns the maximum amount of not acknowledged publishes with QoS 1 or 2 the client sends to the server concurrently.

The value is determined by the minimum of Mqtt5ConnectRestrictions#getSendMaximum() and MqttConnAckRestrictions#getReceiveMaximum().

Specified by:

getSendMaximum in interface Mqtt3ClientConnectionConfig.RestrictionsForClient

Specified by:

getSendMaximum in interface Mqtt5ClientConnectionConfig.RestrictionsForClient

Returns:

the maximum amount of not acknowledged publishes with QoS 1 or 2 the client sends to the server concurrently.

getSendMaximumPacketSize

public int getSendMaximumPacketSize()

Description copied from interface: Mqtt5ClientConnectionConfig.RestrictionsForClient

Returns the maximum packet size the client sends to the server.

The value is determined by the minimum of Mqtt5ConnectRestrictions#getSendMaximumPacketSize() and MqttConnAckRestrictions#getMaximumPacketSize().

Specified by:

getSendMaximumPacketSize in interface Mqtt5ClientConnectionConfig.RestrictionsForClient

Returns:

the maximum packet size the client sends to the server.

getSendTopicAliasMaximum

public int getSendTopicAliasMaximum()

Description copied from interface: Mqtt5ClientConnectionConfig.RestrictionsForClient

Returns the maximum amount of topic aliases the client sends to the server.

The value is determined by the minimum of Mqtt5ConnectRestrictions#getSendTopicAliasMaximum() and MqttConnAckRestrictions#getTopicAliasMaximum().

Specified by:

getSendTopicAliasMaximum in interface Mqtt5ClientConnectionConfig.RestrictionsForClient

Returns:

the maximum amount of topic aliases the client sends to the server.

getSendTopicAliasMapping

@Nullable
public @Nullable MqttTopicAliasMapping getSendTopicAliasMapping()

getMaximumQos

@NotNull
public @NotNull MqttQos getMaximumQos()

Description copied from interface: Mqtt5ClientConnectionConfig.RestrictionsForClient

Returns the maximum QoS the server accepts from the client.

The value is determined by MqttConnAckRestrictions#getMaximumQos().

Specified by:

getMaximumQos in interface Mqtt5ClientConnectionConfig.RestrictionsForClient

Returns:

the maximum QoS the server accepts from the client.

isRetainAvailable

public boolean isRetainAvailable()

Description copied from interface: Mqtt5ClientConnectionConfig.RestrictionsForClient

Returns whether the server accepts retained messages from the client.

The value is determined by MqttConnAckRestrictions#isRetainAvailable().

Specified by:

isRetainAvailable in interface Mqtt5ClientConnectionConfig.RestrictionsForClient

Returns:

whether the server accepts retained messages from the client.

isWildcardSubscriptionAvailable

public boolean isWildcardSubscriptionAvailable()

Description copied from interface: Mqtt5ClientConnectionConfig.RestrictionsForClient

Returns whether the server accepts wildcard subscriptions from the client.

The value is determined by MqttConnAckRestrictions#isWildcardSubscriptionAvailable().

Specified by:

isWildcardSubscriptionAvailable in interface Mqtt5ClientConnectionConfig.RestrictionsForClient

Returns:

whether the server accepts wildcard subscriptions.

isSharedSubscriptionAvailable

public boolean isSharedSubscriptionAvailable()

Description copied from interface: Mqtt5ClientConnectionConfig.RestrictionsForClient

Returns whether the server accepts shared subscriptions from the client.

The value is determined by MqttConnAckRestrictions#isSharedSubscriptionAvailable().

Specified by:

isSharedSubscriptionAvailable in interface Mqtt5ClientConnectionConfig.RestrictionsForClient

Returns:

whether the server accepts shared subscriptions from the client.

areSubscriptionIdentifiersAvailable

public boolean areSubscriptionIdentifiersAvailable()

Description copied from interface: Mqtt5ClientConnectionConfig.RestrictionsForClient

Returns whether the server accepts subscription identifiers from the client.

The value is determined by MqttConnAckRestrictions#areSubscriptionIdentifiersAvailable().

Specified by:

areSubscriptionIdentifiersAvailable in interface Mqtt5ClientConnectionConfig.RestrictionsForClient

Returns:

whether the server accepts subscription identifiers from the client.

getChannel

@NotNull
public @NotNull io.netty.channel.Channel getChannel()