Package com.hivemq.extension.sdk.api.auth.parameter

Interface ModifiableClientSettings

@DoNotImplement
public interface ModifiableClientSettings

An instance of this interface is provided by the SimpleAuthOutput and can be used to configure client specific parameters and restrictions.

Since:

4.2.0, CE 2020.1

Method Summary

Modifier and Type	Method	Description
int	getClientReceiveMaximum()
@NotNull OverloadProtectionThrottlingLevel	getOverloadProtectionThrottlingLevel()
void	setClientQueueSizeMaximum(long queueSizeMaximum)	Set the queue size maximum of the client to the given value.
void	setClientReceiveMaximum(int receiveMaximum)	Set the receive maximum of the client to the given value.
void	setOverloadProtectionThrottlingLevel(@NotNull OverloadProtectionThrottlingLevel level)	Configure the way the client is affected by the overload protection.

Method Details

setClientReceiveMaximum

void setClientReceiveMaximum(int receiveMaximum)

Set the receive maximum of the client to the given value. The new value overwrites the receive maximum that the client provided via the CONNECT message.

Parameters:

receiveMaximum - To be used for this client.

Throws:

IllegalArgumentException - If the value is less than 1 or more than 65535.

Since:

4.2.0, CE 2020.1

setOverloadProtectionThrottlingLevel

void setOverloadProtectionThrottlingLevel(@NotNull OverloadProtectionThrottlingLevel level)

Configure the way the client is affected by the overload protection.

Parameters:

level - used for handling the overload protection for this client.

Throws:

NullPointerException - If the level is null.

Since:

4.2.0, CE 2020.1

getClientReceiveMaximum

int getClientReceiveMaximum()

Returns:

The value that will be used as receive maximum for this client.

Since:

4.2.0, CE 2020.1

getOverloadProtectionThrottlingLevel

@NotNull @NotNull OverloadProtectionThrottlingLevel getOverloadProtectionThrottlingLevel()

Returns:

The overload protection level that will be used for this client.

Since:

4.2.0, CE 2020.1

setClientQueueSizeMaximum

void setClientQueueSizeMaximum(long queueSizeMaximum)

Set the queue size maximum of the client to the given value. The new value overwrites the default maximum.

Parameters:

queueSizeMaximum - To be used for this client.

Throws:

IllegalArgumentException - If the value is less than 1.

Since:

4.4.0