com.hivemq.spi.security

Interface ClientCredentialsData

All Superinterfaces:

ClientData

public interface ClientCredentialsData
extends ClientData

An extended version of ClientData which also contains the password the client used in the CONNECT message

Since:

1.4

Author:

Christian Goetz

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.base.Optional<String>	getPassword() Returns an Optional of the clear text password the client used encoded as UTF-8.
com.google.common.base.Optional<byte[]>	getPasswordBytes() Returns an Optional of the text password the client used

Methods inherited from interface com.hivemq.spi.security.ClientData

getCertificate, getClientId, getConnectionAttributeStore, getDisconnectTimestamp, getInetAddress, getListener, getProxyInformation, getUsername, isAnonymous, isAuthenticated, isBridge

Method Detail

getPassword

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

Returns an Optional of the clear text password the client used encoded as UTF-8.

Consider using the getPasswordBytes() method instead, since passwords are not required to be human readable and can be any arbitrary byte array

Returns:

the password, if present

getPasswordBytes

com.google.common.base.Optional<byte[]> getPasswordBytes()

Returns an Optional of the text password the client used

Returns:

the password, if present

Since:

3.0.0