com.hivemq.spi.message

Class CONNECT

java.lang.Object

com.hivemq.spi.message.CONNECT

All Implemented Interfaces:

Message, Serializable

public class CONNECT
extends Object
implements Message

The MQTT CONNECT message

Since:

1.4

Author:

Dominik Obermaier

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CONNECT()

Method Summary

Methods

Modifier and Type	Method and Description
String	getClientIdentifier()
int	getKeepAliveTimer()
byte[]	getPassword()
String	getPasswordAsUTF8String()
ProtocolVersion	getProtocolVersion()
String	getUsername()
byte[]	getWillMessage()
QoS	getWillQos()
String	getWillTopic()
boolean	isBridge()
boolean	isCleanSession()
boolean	isPasswordRequired()
boolean	isUsernameRequired()
boolean	isWill()
boolean	isWillRetain()
void	setBridge(boolean bridge)
void	setCleanSession(boolean cleanSession)
void	setClientIdentifier(String clientIdentifier)
void	setKeepAliveTimer(int keepAliveTimer)
void	setPassword(byte[] password)
void	setPassword(String password)
void	setPasswordRequired(boolean passwordRequired)
void	setProtocolVersion(ProtocolVersion protocolVersion)
void	setUsername(String username)
void	setUsernameRequired(boolean usernameRequired)
void	setWill(boolean will)
void	setWillMessage(byte[] willMessage)
void	setWillQos(QoS willQos)
void	setWillRetain(boolean willRetain)
void	setWillTopic(String willTopic)

Methods inherited from class java.lang.Object

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

Constructor Detail

CONNECT

public CONNECT()

Method Detail

isCleanSession

public boolean isCleanSession()

Returns:

if the message uses a clean (= non persistent) session

setCleanSession

public void setCleanSession(boolean cleanSession)

isWill

public boolean isWill()

Returns:

if the CONNECT message contains a LWT message

setWill

public void setWill(boolean will)

getWillQos

public QoS getWillQos()

Returns:

the QoS level of the LWT message

setWillQos

public void setWillQos(QoS willQos)

isWillRetain

public boolean isWillRetain()

Returns:

if the LWT message should be retained

setWillRetain

public void setWillRetain(boolean willRetain)

isPasswordRequired

public boolean isPasswordRequired()

Returns:

true if the message contains a password

setPasswordRequired

public void setPasswordRequired(boolean passwordRequired)

isUsernameRequired

public boolean isUsernameRequired()

Returns:

true if the message contains a username

setUsernameRequired

public void setUsernameRequired(boolean usernameRequired)

getKeepAliveTimer

public int getKeepAliveTimer()

Returns:

the the keep alive value of the CONNECT message

setKeepAliveTimer

public void setKeepAliveTimer(int keepAliveTimer)

getClientIdentifier

public String getClientIdentifier()

Returns:

the client identifier of the client which issued the CONNECT message

setClientIdentifier

public void setClientIdentifier(String clientIdentifier)

getWillTopic

public String getWillTopic()

Returns:

the topic of the LWT message

setWillTopic

public void setWillTopic(String willTopic)

getWillMessage

public byte[] getWillMessage()

Returns:

the payload of the LWT message

setWillMessage

public void setWillMessage(byte[] willMessage)

getUsername

public String getUsername()

Returns:

the username or null

setUsername

public void setUsername(String username)

getPassword

public byte[] getPassword()

Returns:

The password as byte array or null

getPasswordAsUTF8String

public String getPasswordAsUTF8String()

Returns:

the password as UTF8 encoded String. This method is a convenient method but you should consider using getPassword() instead since MQTT passwords can contain raw bytes

setPassword

public void setPassword(byte[] password)

setPassword

public void setPassword(String password)

isBridge

public boolean isBridge()

setBridge

public void setBridge(boolean bridge)

getProtocolVersion

public ProtocolVersion getProtocolVersion()

Returns:

the protocol version used in the CONNECT message

setProtocolVersion

public void setProtocolVersion(ProtocolVersion protocolVersion)