com.hivemq.spi.services.configuration.entity

Class TlsWebsocketListener.Builder

java.lang.Object

com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder

com.hivemq.spi.services.configuration.entity.TlsWebsocketListener.Builder

Enclosing class:

TlsWebsocketListener

public static class TlsWebsocketListener.Builder
extends WebsocketListener.Builder

A builder which allows to conveniently build a listener object with a fluent API

Field Summary

Fields inherited from class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder

allowExtensions, bindAddress, clientWriteBufferProperties, connectOverloadProtectionProperties, path, port, proxyProtocolSupported, socketOptionsProperties, subprotocols

Constructor Summary

Constructors

Constructor and Description
TlsWebsocketListener.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
TlsWebsocketListener.Builder	allowExtensions(boolean allowExtensions) Sets if websocket extensions should be allowed or not
TlsWebsocketListener.Builder	bindAddress(String bindAddress) Sets the bind address of the TLS websocket listener
TlsWebsocketListener	build() Creates the TLS Websocket Listener
TlsWebsocketListener.Builder	path(String path) Sets the websocket path of the TLS websocket listener
TlsWebsocketListener.Builder	port(int port) Sets the port of the TLS websocket listener
TlsWebsocketListener.Builder	proxyProtocolSupported(boolean proxyProtocolSupported) Set this to true if you want this listener to support the PROXY protocol
TlsWebsocketListener.Builder	setClientWriteBufferProperties(ClientWriteBufferProperties clientWriteBufferProperties) Set the ClientWriteBufferProperties of this listener
TlsWebsocketListener.Builder	setConnectOverloadProtectionProperties(ConnectOverloadProtectionProperties connectOverloadProtectionProperties) Set the ConnectOverloadProtectionProperties of this listener
TlsWebsocketListener.Builder	setSocketOptionsProperties(SocketOptionsProperties socketOptionsProperties) Set the SocketOptionsProperties of this listener
TlsWebsocketListener.Builder	setSubprotocols(List<String> subprotocols) Sets a list of subprotocols the websocket listener should support.
TlsWebsocketListener.Builder	tls(Tls tls) Sets the TLS configuration of the TLS Websocket listener

Methods inherited from class java.lang.Object

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

Constructor Detail

TlsWebsocketListener.Builder

public TlsWebsocketListener.Builder()

Method Detail

tls

public TlsWebsocketListener.Builder tls(Tls tls)

Sets the TLS configuration of the TLS Websocket listener

Parameters:

tls - the TLS configuration

Returns:

the Builder

port

public TlsWebsocketListener.Builder port(int port)

Sets the port of the TLS websocket listener

Overrides:

port in class WebsocketListener.Builder

Parameters:

port - the port

Returns:

the Builder

bindAddress

public TlsWebsocketListener.Builder bindAddress(String bindAddress)

Sets the bind address of the TLS websocket listener

Overrides:

bindAddress in class WebsocketListener.Builder

Parameters:

bindAddress - the bind address

Returns:

the Builder

path

public TlsWebsocketListener.Builder path(String path)

Sets the websocket path of the TLS websocket listener

Overrides:

path in class WebsocketListener.Builder

Parameters:

path - the path

Returns:

the Builder

allowExtensions

public TlsWebsocketListener.Builder allowExtensions(boolean allowExtensions)

Sets if websocket extensions should be allowed or not

Overrides:

allowExtensions in class WebsocketListener.Builder

Parameters:

allowExtensions - if websocket extensions should be allowed or not

Returns:

the Builder

setSubprotocols

public TlsWebsocketListener.Builder setSubprotocols(List<String> subprotocols)

Sets a list of subprotocols the websocket listener should support.

Typically you should use 'mqtt' and/or 'mqttv3.1

Overrides:

setSubprotocols in class WebsocketListener.Builder

Parameters:

subprotocols - a list of websocket subprotocols

Returns:

the Builder

proxyProtocolSupported

public TlsWebsocketListener.Builder proxyProtocolSupported(boolean proxyProtocolSupported)

Set this to true if you want this listener to support the PROXY protocol

Overrides:

proxyProtocolSupported in class WebsocketListener.Builder

Parameters:

proxyProtocolSupported - if this listener should be able to utilize the PROXY protocol

Returns:

the Builder

Since:

3.2

setSocketOptionsProperties

public TlsWebsocketListener.Builder setSocketOptionsProperties(@Nullable
                                                      SocketOptionsProperties socketOptionsProperties)

Set the SocketOptionsProperties of this listener

Overrides:

setSocketOptionsProperties in class WebsocketListener.Builder

Parameters:

socketOptionsProperties - a configuration of SocketOptionsProperties for this listener or null to use the default

Returns:

the Builder

Since:

3.3

setConnectOverloadProtectionProperties

public TlsWebsocketListener.Builder setConnectOverloadProtectionProperties(@Nullable
                                                                  ConnectOverloadProtectionProperties connectOverloadProtectionProperties)

Set the ConnectOverloadProtectionProperties of this listener

Overrides:

setConnectOverloadProtectionProperties in class WebsocketListener.Builder

Parameters:

connectOverloadProtectionProperties - a configuration of ConnectOverloadProtectionProperties for this listener or null to deactivate connect overload protection

Returns:

the Builder

Since:

3.3

setClientWriteBufferProperties

public TlsWebsocketListener.Builder setClientWriteBufferProperties(@Nullable
                                                          ClientWriteBufferProperties clientWriteBufferProperties)

Set the ClientWriteBufferProperties of this listener

Overrides:

setClientWriteBufferProperties in class WebsocketListener.Builder

Parameters:

clientWriteBufferProperties - a configuration of ClientWriteBufferProperties for this listener or null to use the default

Returns:

the Builder

Since:

3.3

build

public TlsWebsocketListener build()

Creates the TLS Websocket Listener

Overrides:

build in class WebsocketListener.Builder

Returns:

the TLS Websocket Listener