com.hivemq.spi.services.configuration.entity

Class TlsTcpListener

java.lang.Object

com.hivemq.spi.services.configuration.entity.TcpListener

com.hivemq.spi.services.configuration.entity.TlsTcpListener

All Implemented Interfaces:

Listener

@Immutable
public class TlsTcpListener
extends TcpListener

A listener which allows to listen to MQTT traffic via TLS

Since:

3.0

Author:

Dominik Obermaier, Christoph Schaebel

Constructor Summary

Constructors

Constructor and Description
TlsTcpListener(Integer port, String bindAddress, Tls tls) Creates a new TLS Listener which listens to a specific port and bind address
TlsTcpListener(int port, String bindAddress, Tls tls, boolean proxyProtocolSupported) Creates a new TLS Listener which listens to a specific port, bind address and proxy setting
TlsTcpListener(int port, String bindAddress, Tls tls, boolean proxyProtocolSupported, SocketOptionsProperties socketOptionsProperties, ConnectOverloadProtectionProperties connectOverloadProtectionProperties, ClientWriteBufferProperties clientWriteBufferProperties) Creates a new TLS Listener which listens to a specific port, bind address, proxy setting, socket options, overload protection and write buffer properties

Method Summary

Methods

Modifier and Type	Method and Description
Tls	getTls()
String	readableName()

Methods inherited from class com.hivemq.spi.services.configuration.entity.TcpListener

getBindAddress, getClientWriteBufferProperties, getConnectOverloadProtectionProperties, getPort, getSocketOptionsProperties, isProxyProtocolSupported

Methods inherited from class java.lang.Object

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

Constructor Detail

TlsTcpListener

public TlsTcpListener(Integer port,
              String bindAddress,
              Tls tls)

Creates a new TLS Listener which listens to a specific port and bind address

Parameters:

port - the port

bindAddress - the bind address

tls - the TLS configuration

TlsTcpListener

public TlsTcpListener(int port,
              String bindAddress,
              Tls tls,
              boolean proxyProtocolSupported)

Creates a new TLS Listener which listens to a specific port, bind address and proxy setting

Parameters:

port - the port

bindAddress - the bind address

tls - the TLS configuration

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

TlsTcpListener

public TlsTcpListener(int port,
              String bindAddress,
              Tls tls,
              boolean proxyProtocolSupported,
              @Nullable
              SocketOptionsProperties socketOptionsProperties,
              @Nullable
              ConnectOverloadProtectionProperties connectOverloadProtectionProperties,
              @Nullable
              ClientWriteBufferProperties clientWriteBufferProperties)

Creates a new TLS Listener which listens to a specific port, bind address, proxy setting, socket options, overload protection and write buffer properties

Parameters:

port - the port

bindAddress - the bind address

tls - the TLS configuration

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

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

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

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

Method Detail

getTls

public Tls getTls()

Returns:

the TLS configuration

readableName

public String readableName()

Specified by:

readableName in interface Listener

Overrides:

readableName in class TcpListener

Returns:

the human readable, name of the listener