Package org.openremote.agent.protocol.websocket

Class WebsocketAgent

java.lang.Object

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

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

org.openremote.agent.protocol.io.IOAgent<WebsocketAgent,WebsocketAgentProtocol,WebsocketAgentLink>

org.openremote.agent.protocol.websocket.WebsocketAgent

All Implemented Interfaces:

org.openremote.model.IdentifiableEntity<WebsocketAgent>

@Entity
public class WebsocketAgent
extends IOAgent<WebsocketAgent,WebsocketAgentProtocol,WebsocketAgentLink>

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<org.openremote.model.value.ValueType.MultivaluedStringMap>	CONNECT_HEADERS	Headers for websocket connect call
static final org.openremote.model.value.AttributeDescriptor<WebsocketSubscription[]>	CONNECT_SUBSCRIPTIONS	Array of WebsocketSubscriptions that should be executed once the websocket connection is established; the subscriptions are executed in the order specified in the array.
static final org.openremote.model.value.AttributeDescriptor<String>	CONNECT_URL	Websocket connect endpoint URI
static final org.openremote.model.asset.agent.AgentDescriptor<WebsocketAgent,WebsocketAgentProtocol,WebsocketAgentLink>	DESCRIPTOR
static final org.openremote.model.value.ValueDescriptor<WebsocketSubscription>	WEBSOCKET_SUBSCRIPTION_VALUE_DESCRIPTOR

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	WebsocketAgent()	For use by hydrators (i.e.
	WebsocketAgent(String name)

Method Summary

Modifier and Type	Method	Description
Optional<org.openremote.model.value.ValueType.MultivaluedStringMap>	getConnectHeaders()
Optional<WebsocketSubscription[]>	getConnectSubscriptions()
Optional<String>	getConnectUri()
WebsocketAgentProtocol	getProtocolInstance()	Get the protocol instance for this Agent.
WebsocketAgent	setConnectHeaders(org.openremote.model.value.ValueType.MultivaluedStringMap value)
WebsocketAgent	setConnectSubscriptions(WebsocketSubscription[] value)
WebsocketAgent	setConnectURI(String value)

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

WEBSOCKET_SUBSCRIPTION_VALUE_DESCRIPTOR

public static final org.openremote.model.value.ValueDescriptor<WebsocketSubscription> WEBSOCKET_SUBSCRIPTION_VALUE_DESCRIPTOR

CONNECT_URL

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

Websocket connect endpoint URI

CONNECT_HEADERS

public static final org.openremote.model.value.AttributeDescriptor<org.openremote.model.value.ValueType.MultivaluedStringMap> CONNECT_HEADERS

Headers for websocket connect call

CONNECT_SUBSCRIPTIONS

public static final org.openremote.model.value.AttributeDescriptor<WebsocketSubscription[]> CONNECT_SUBSCRIPTIONS

Array of WebsocketSubscriptions that should be executed once the websocket connection is established; the subscriptions are executed in the order specified in the array.

DESCRIPTOR

public static final org.openremote.model.asset.agent.AgentDescriptor<WebsocketAgent,WebsocketAgentProtocol,WebsocketAgentLink> DESCRIPTOR

Constructor Details

WebsocketAgent

protected WebsocketAgent()

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

WebsocketAgent

public WebsocketAgent(String name)

Method Details

getConnectUri

public Optional<String> getConnectUri()

setConnectURI

public WebsocketAgent setConnectURI(String value)

getConnectHeaders

public Optional<org.openremote.model.value.ValueType.MultivaluedStringMap> getConnectHeaders()

setConnectHeaders

public WebsocketAgent setConnectHeaders(org.openremote.model.value.ValueType.MultivaluedStringMap value)

getConnectSubscriptions

public Optional<WebsocketSubscription[]> getConnectSubscriptions()

setConnectSubscriptions

public WebsocketAgent setConnectSubscriptions(WebsocketSubscription[] value)

getProtocolInstance

public WebsocketAgentProtocol 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<WebsocketAgent,WebsocketAgentProtocol,WebsocketAgentLink>