Package org.openremote.agent.protocol.mqtt

Class MQTTAgent

java.lang.Object

org.openremote.model.asset.Asset<T>

org.openremote.model.asset.agent.Agent<T,U,V>

org.openremote.agent.protocol.io.IOAgent<MQTTAgent,MQTTProtocol,MQTTAgentLink>

org.openremote.agent.protocol.mqtt.MQTTAgent

All Implemented Interfaces:

org.openremote.model.IdentifiableEntity<MQTTAgent>

@Entity
public class MQTTAgent
extends IOAgent<MQTTAgent,MQTTProtocol,MQTTAgentLink>

Nested Class Summary

Nested classes/interfaces inherited from class org.openremote.model.asset.Asset

org.openremote.model.asset.Asset.AssetSave

Field Summary

Fields

Modifier and Type	Field	Description
static final org.openremote.model.value.AttributeDescriptor<String>	CLIENT_ID
static final org.openremote.model.asset.agent.AgentDescriptor<MQTTAgent,MQTTProtocol,MQTTAgentLink>	DESCRIPTOR
static final org.openremote.model.value.AttributeDescriptor<String>	MQTT_HOST
static final org.openremote.model.value.AttributeDescriptor<Integer>	MQTT_PORT
static final org.openremote.model.value.AttributeDescriptor<Boolean>	RESUME_SESSION
static final org.openremote.model.value.AttributeDescriptor<Boolean>	SECURE_MODE
static final org.openremote.model.value.AttributeDescriptor<Boolean>	WEBSOCKET_MODE
static final org.openremote.model.value.AttributeDescriptor<String>	WEBSOCKET_PATH
static final org.openremote.model.value.AttributeDescriptor<String>	WEBSOCKET_QUERY

Fields inherited from class org.openremote.model.asset.agent.Agent

BIND_HOST, BIND_PORT, DISABLED, HOST, MESSAGE_CHARSET, MESSAGE_CONVERT_BINARY, MESSAGE_CONVERT_HEX, MESSAGE_DELIMITERS, MESSAGE_MAX_LENGTH, MESSAGE_STRIP_DELIMITER, OAUTH_GRANT, POLLING_MILLIS, PORT, SERIAL_BAUDRATE, SERIAL_PORT, STATUS, UPDATE_ON_WRITE, USERNAME_AND_PASSWORD

Fields inherited from class org.openremote.model.asset.Asset

accessPublicRead, attributes, createdOn, EMAIL, id, LOCATION, MANUFACTURER, MODEL, name, NOTES, parentId, path, realm, TAGS, type, version

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MQTTAgent()	For use by hydrators (i.e.
	MQTTAgent(String name)

Method Summary

Modifier and Type	Method	Description
Optional<String>	getClientId()
MQTTProtocol	getProtocolInstance()	Get the protocol instance for this Agent.
Optional<String>	getWebsocketPath()
Optional<String>	getWebsocketQuery()
Optional<Boolean>	isResumeSession()
Optional<Boolean>	isSecureMode()
Optional<Boolean>	isWebsocketMode()
MQTTAgent	setClientId(String clientId)
MQTTAgent	setResumeSession(boolean resumeSession)
MQTTAgent	setSecureMode(boolean secureMode)
MQTTAgent	setWebsocketMode(boolean websocketMode)
MQTTAgent	setWebsocketPath(String websocketPath)
MQTTAgent	setWebsocketQuery(String websocketQuery)

Methods inherited from class org.openremote.agent.protocol.io.IOAgent

getMessageCharset, getMessageConvertBinary, getMessageConvertHex, getMessageDelimiters, getMessageMaxLength, getMessageStripDelimiter, setMessageCharset, setMessageConvertBinary, setMessageConvertHex, setMessageDelimiters, setMessageMaxLength, setMessageStripDelimiter

Methods inherited from class org.openremote.model.asset.agent.Agent

getAgentLink, getAgentStatus, getBindHost, getBindPort, getHost, getOAuthGrant, getPollingMillis, getPort, getSerialBaudrate, getSerialPort, getUsernamePassword, isConfigurationAttribute, isDisabled, isUpdateOnWrite, setBindHost, setBindPort, setDisabled, setHost, setOAuthGrant, setPort, setSerialBaudrate, setSerialPort, setUpdateOnWrite, setUsernamePassword

Methods inherited from class org.openremote.model.asset.Asset

addAttributes, addOrReplaceAttributes, getAttribute, getAttribute, getAttribute, getAttributes, getAttributesString, getCreatedOn, getEmail, getId, getLocation, getManufacturer, getMetaString, getModel, getName, getNotes, getParentId, getPath, getRealm, getTags, getType, getVersion, hasAttribute, hasAttribute, isAccessPublicRead, pathContains, setAccessPublicRead, setAttributes, setAttributes, setAttributes, setCreatedOn, setEmail, setId, setLocation, setManufacturer, setModel, setName, setNotes, setParent, setParentId, setRealm, setTags, setVersion, toString, toStringAll

Methods inherited from class java.lang.Object

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

Field Details

MQTT_HOST

public static final org.openremote.model.value.AttributeDescriptor<String> MQTT_HOST

MQTT_PORT

public static final org.openremote.model.value.AttributeDescriptor<Integer> MQTT_PORT

CLIENT_ID

public static final org.openremote.model.value.AttributeDescriptor<String> CLIENT_ID

SECURE_MODE

public static final org.openremote.model.value.AttributeDescriptor<Boolean> SECURE_MODE

RESUME_SESSION

public static final org.openremote.model.value.AttributeDescriptor<Boolean> RESUME_SESSION

WEBSOCKET_MODE

public static final org.openremote.model.value.AttributeDescriptor<Boolean> WEBSOCKET_MODE

WEBSOCKET_PATH

public static final org.openremote.model.value.AttributeDescriptor<String> WEBSOCKET_PATH

WEBSOCKET_QUERY

public static final org.openremote.model.value.AttributeDescriptor<String> WEBSOCKET_QUERY

DESCRIPTOR

public static final org.openremote.model.asset.agent.AgentDescriptor<MQTTAgent,MQTTProtocol,MQTTAgentLink> DESCRIPTOR

Constructor Details

MQTTAgent

protected MQTTAgent()

For use by hydrators (i.e. JPA/Jackson)

MQTTAgent

public MQTTAgent(String name)

Method Details

getProtocolInstance

public MQTTProtocol getProtocolInstance()

Description copied from class: org.openremote.model.asset.agent.Agent

Get the protocol instance for this Agent.

Specified by:

getProtocolInstance in class org.openremote.model.asset.agent.Agent<MQTTAgent,MQTTProtocol,MQTTAgentLink>

getClientId

public Optional<String> getClientId()

setClientId

public MQTTAgent setClientId(String clientId)

isSecureMode

public Optional<Boolean> isSecureMode()

setSecureMode

public MQTTAgent setSecureMode(boolean secureMode)

isWebsocketMode

public Optional<Boolean> isWebsocketMode()

setWebsocketMode

public MQTTAgent setWebsocketMode(boolean websocketMode)

isResumeSession

public Optional<Boolean> isResumeSession()

setResumeSession

public MQTTAgent setResumeSession(boolean resumeSession)

getWebsocketPath

public Optional<String> getWebsocketPath()

setWebsocketPath

public MQTTAgent setWebsocketPath(String websocketPath)

getWebsocketQuery

public Optional<String> getWebsocketQuery()

setWebsocketQuery

public MQTTAgent setWebsocketQuery(String websocketQuery)