com.hivemq.spi.services.configuration.entity

Class WebsocketListener

java.lang.Object

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

All Implemented Interfaces:

Listener

Direct Known Subclasses:

TlsWebsocketListener

@Immutable
public class WebsocketListener
extends Object
implements Listener

A listener which allows to listen to MQTT traffic over websockets.

Use the builder if you want to create a new websocket listener.

Since:

3.0

Author:

Dominik Obermaier, Christoph Schaebel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebsocketListener.Builder A builder which allows to conveniently build a listener object with a fluent API

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebsocketListener(int port, String bindAddress, String path, boolean allowExtensions, List<String> subprotocols, boolean proxyProtocolSupported, SocketOptionsProperties socketOptionsProperties, ConnectOverloadProtectionProperties connectOverloadProtectionProperties, ClientWriteBufferProperties clientWriteBufferProperties)

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getAllowExtensions()
String	getBindAddress()
com.google.common.base.Optional<ClientWriteBufferProperties>	getClientWriteBufferProperties()
com.google.common.base.Optional<ConnectOverloadProtectionProperties>	getConnectOverloadProtectionProperties()
String	getPath()
int	getPort()
com.google.common.base.Optional<SocketOptionsProperties>	getSocketOptionsProperties()
List<String>	getSubprotocols()
boolean	isProxyProtocolSupported()
String	readableName()

Methods inherited from class java.lang.Object

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

Constructor Detail

WebsocketListener

protected WebsocketListener(int port,
                 String bindAddress,
                 String path,
                 boolean allowExtensions,
                 List<String> subprotocols,
                 boolean proxyProtocolSupported,
                 SocketOptionsProperties socketOptionsProperties,
                 ConnectOverloadProtectionProperties connectOverloadProtectionProperties,
                 ClientWriteBufferProperties clientWriteBufferProperties)

Method Detail

getPort

public int getPort()

Specified by:

getPort in interface Listener

Returns:

the port of the listener

getBindAddress

public String getBindAddress()

Specified by:

getBindAddress in interface Listener

Returns:

the bind address of a listener

readableName

public String readableName()

Specified by:

readableName in interface Listener

Returns:

the human readable, name of the listener

isProxyProtocolSupported

public boolean isProxyProtocolSupported()

Specified by:

isProxyProtocolSupported in interface Listener

Returns:

if the PROXY protocol is supported by this listener

getSocketOptionsProperties

public com.google.common.base.Optional<SocketOptionsProperties> getSocketOptionsProperties()

Specified by:

getSocketOptionsProperties in interface Listener

Returns:

an Optional of SocketOptionsProperties of this listener

getConnectOverloadProtectionProperties

public com.google.common.base.Optional<ConnectOverloadProtectionProperties> getConnectOverloadProtectionProperties()

Specified by:

getConnectOverloadProtectionProperties in interface Listener

Returns:

an Optional of ConnectOverloadProtectionProperties of this listener

getClientWriteBufferProperties

public com.google.common.base.Optional<ClientWriteBufferProperties> getClientWriteBufferProperties()

Specified by:

getClientWriteBufferProperties in interface Listener

Returns:

an Optional of ClientWriteBufferProperties of this listener

getPath

public String getPath()

Returns:

the path of the websocket

getAllowExtensions

public Boolean getAllowExtensions()

Returns:

if websocket extensions are allowed or not

getSubprotocols

public List<String> getSubprotocols()

Returns:

a list of all supported subprotocols