com.hivemq.spi.security

Interface ClientData

All Known Subinterfaces:

ClientCredentialsData

public interface ClientData

Represents information available of a connected client.

Since:

1.4

Author:

Christian Goetz, Dominik Obermaier

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.base.Optional<SslClientCertificate>	getCertificate()
String	getClientId()
ConnectionAttributeStore	getConnectionAttributeStore() Returns the ConnectionAttributeStore for the connected client.
com.google.common.base.Optional<Long>	getDisconnectTimestamp() Returns optional Long that contains the disconnect timestamp.
com.google.common.base.Optional<InetAddress>	getInetAddress()
com.google.common.base.Optional<Listener>	getListener() Returns the listener the client connected to.
com.google.common.base.Optional<ProxyInformation>	getProxyInformation() Returns optional ProxyInformation that contains information from the PROXY protocol.
com.google.common.base.Optional<String>	getUsername()
boolean	isAnonymous()
boolean	isAuthenticated()
boolean	isBridge()

Method Detail

getClientId

String getClientId()

Returns:

the client identifier which was provided in the MQTT CONNECT message

getUsername

com.google.common.base.Optional<String> getUsername()

Returns:

an Optional with the username which was provided in the MQTT CONNECT message.

isAuthenticated

boolean isAuthenticated()

Returns:

true if the client is authenticated, false otherwise

getCertificate

com.google.common.base.Optional<SslClientCertificate> getCertificate()

Returns:

an Optional of a SslClientCertificate which was provided at transport level client certificate authentication.

Since:

3.0

isAnonymous

boolean isAnonymous()

Returns:

true if the client is anonymous. That means the client is not authenticated

isBridge

boolean isBridge()

Returns:

true if this client is a bridge.

Since:

2.0

getInetAddress

com.google.common.base.Optional<InetAddress> getInetAddress()

Returns:

an Optional of the clients IP address as InetAddress

Since:

3.0

getListener

com.google.common.base.Optional<Listener> getListener()

Returns the listener the client connected to.

If the client is connected locally, the listener will always be available. If the ClientData belongs to another cluster node, the listener may be absent.

Returns:

an Optional of the Listener the client connected to.

Since:

3.2

See Also:

TcpListener, TlsTcpListener, WebsocketListener, TlsWebsocketListener, Listeners

getProxyInformation

com.google.common.base.Optional<ProxyInformation> getProxyInformation()

Returns optional ProxyInformation that contains information from the PROXY protocol.

This is only useful if a load balancer is in front of the HiveMQ instance and the Listener that is used by the load balancer has the PROXY protocol enabled. You can check this via Listener.isProxyProtocolSupported().

Besides original source information, HiveMQ supports TLVs as specified in the PROXY protocol spec.

Returns:

an Optional of the ProxyInformation.

Since:

3.2

See Also:

PROXY protocol spec

getConnectionAttributeStore

@NotNull
ConnectionAttributeStore getConnectionAttributeStore()

Returns the ConnectionAttributeStore for the connected client.

If the ClientData object was acquired through the AsyncClientService or the BlockingClientService, its required to call ConnectionAttributeStore.isAccessible() before using the ConnectionAttributeStore

Returns:

the ConnectionAttributeStore for the connected client.

getDisconnectTimestamp

com.google.common.base.Optional<Long> getDisconnectTimestamp()

Returns optional Long that contains the disconnect timestamp.

Returns:

an Optional of the Long.

Since:

3.4