com.hivemq.spi.services.configuration.entity

Class WebsocketListener.Builder

java.lang.Object

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

Direct Known Subclasses:

TlsWebsocketListener.Builder

Enclosing class:

WebsocketListener

public static class WebsocketListener.Builder
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowExtensions
protected String	bindAddress
protected ClientWriteBufferProperties	clientWriteBufferProperties
protected ConnectOverloadProtectionProperties	connectOverloadProtectionProperties
protected String	path
protected Integer	port
protected boolean	proxyProtocolSupported
protected SocketOptionsProperties	socketOptionsProperties
protected List<String>	subprotocols

Constructor Summary

Constructors

Constructor and Description
WebsocketListener.Builder()

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Field Detail

port

protected Integer port

bindAddress

protected String bindAddress

path

protected String path

allowExtensions

protected boolean allowExtensions

subprotocols

protected List<String> subprotocols

proxyProtocolSupported

protected boolean proxyProtocolSupported

socketOptionsProperties

protected SocketOptionsProperties socketOptionsProperties

connectOverloadProtectionProperties

protected ConnectOverloadProtectionProperties connectOverloadProtectionProperties

clientWriteBufferProperties

protected ClientWriteBufferProperties clientWriteBufferProperties

Constructor Detail

WebsocketListener.Builder

public WebsocketListener.Builder()

Method Detail

port

public WebsocketListener.Builder port(int port)

Sets the port of the websocket listener

Parameters:

port - the port

Returns:

the Builder

bindAddress

public WebsocketListener.Builder bindAddress(String bindAddress)

Sets the bind address of the websocket listener

Parameters:

bindAddress - the bind address

Returns:

the Builder

path

public WebsocketListener.Builder path(String path)

Sets the websocket path of the websocket listener

Parameters:

path - the path

Returns:

the Builder

allowExtensions

public WebsocketListener.Builder allowExtensions(boolean allowExtensions)

Sets if websocket extensions should be allowed or not

Parameters:

allowExtensions - if websocket extensions should be allowed or not

Returns:

the Builder

setSubprotocols

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

Sets a list of subprotocols the websocket listener should support.

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

Parameters:

subprotocols - a list of websocket subprotocols

Returns:

the Builder

proxyProtocolSupported

public WebsocketListener.Builder proxyProtocolSupported(boolean proxyProtocolSupported)

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

Parameters:

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

Returns:

the Builder

Since:

3.2

setSocketOptionsProperties

public WebsocketListener.Builder setSocketOptionsProperties(@Nullable
                                                   SocketOptionsProperties socketOptionsProperties)

Set the SocketOptionsProperties of this listener

Parameters:

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

Returns:

the Builder

Since:

3.3

setConnectOverloadProtectionProperties

public WebsocketListener.Builder setConnectOverloadProtectionProperties(@Nullable
                                                               ConnectOverloadProtectionProperties connectOverloadProtectionProperties)

Set the ConnectOverloadProtectionProperties of this listener

Parameters:

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

Returns:

the Builder

Since:

3.3

setClientWriteBufferProperties

public WebsocketListener.Builder setClientWriteBufferProperties(@Nullable
                                                       ClientWriteBufferProperties clientWriteBufferProperties)

Set the ClientWriteBufferProperties of this listener

Parameters:

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

Returns:

the Builder

Since:

3.3

build

public WebsocketListener build()
                        throws IllegalStateException

Creates the Websocket Listener

Returns:

the Websocket Listener

Throws:

IllegalStateException