Package org.openremote.agent.protocol.http

Class HTTPAgentLink

java.lang.Object

org.openremote.model.asset.agent.AgentLink<HTTPAgentLink>

org.openremote.agent.protocol.http.HTTPAgentLink

All Implemented Interfaces:

Serializable

public class HTTPAgentLink
extends org.openremote.model.asset.agent.AgentLink<HTTPAgentLink>

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	contentType
protected Map<String,List<String>>	headers
protected boolean	messageConvertBinary
protected boolean	messageConvertHex
protected HTTPMethod	method
protected Boolean	pagingMode
protected String	path
protected String	pollingAttribute
protected Integer	pollingMillis
protected Map<String,List<String>>	queryParameters

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

id, messageMatchFilters, messageMatchPredicate, updateOnWrite, valueConverter, valueFilters, writeValue, writeValueConverter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HTTPAgentLink()
	HTTPAgentLink(String id)

Method Summary

Modifier and Type	Method	Description
Optional<String>	getContentType()
Optional<Map<String,List<String>>>	getHeaders()
Optional<HTTPMethod>	getMethod()
Optional<Boolean>	getPagingMode()
Optional<String>	getPath()
Optional<String>	getPollingAttribute()
Optional<Integer>	getPollingMillis()
Optional<Map<String,List<String>>>	getQueryParameters()
boolean	isMessageConvertBinary()
boolean	isMessageConvertHex()
HTTPAgentLink	setContentType(String contentType)
HTTPAgentLink	setHeaders(org.openremote.model.value.ValueType.MultivaluedStringMap headers)
HTTPAgentLink	setMessageConvertBinary(boolean messageConvertBinary)
HTTPAgentLink	setMessageConvertHex(boolean messageConvertHex)
HTTPAgentLink	setMethod(HTTPMethod method)
HTTPAgentLink	setPagingMode(Boolean pagingMode)
HTTPAgentLink	setPath(String path)
HTTPAgentLink	setPollingAttribute(String pollingAttribute)
HTTPAgentLink	setPollingMillis(Integer pollingMillis)
HTTPAgentLink	setQueryParameters(org.openremote.model.value.ValueType.MultivaluedStringMap queryParameters)

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

getId, getMessageMatchFilters, getMessageMatchPredicate, getOrThrowAgentLinkProperty, getType, getUpdateOnWrite, getValueConverter, getValueFilters, getWriteValue, getWriteValueConverter, setMessageMatchFilters, setMessageMatchPredicate, setUpdateOnWrite, setValueConverter, setValueFilters, setWriteValue, setWriteValueConverter

Methods inherited from class java.lang.Object

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

Field Details

headers

@JsonPropertyDescription("A JSON object of headers to be added to HTTP request; the key represents the name of the header and for each string value supplied a new header will be added with the key name and specified string value")
protected Map<String,List<String>> headers

queryParameters

@JsonPropertyDescription("A JSON object of query parameters to be added to HTTP request URL; the key represents the name of the query parameter and for each string value supplied a new query parameter will be added with the key name and specified string value (e.g. \'https://..../?test=1&test=2\')")
protected Map<String,List<String>> queryParameters

pollingMillis

@JsonPropertyDescription("Indicates that this HTTP request is used to update the linked attribute; this value indicates how frequently the HTTP request is made in order to update the linked attribute value")
protected Integer pollingMillis

pagingMode

@JsonPropertyDescription("Indicates that the HTTP server supports pagination using the standard Link header mechanism")
protected Boolean pagingMode

path

@JsonPropertyDescription("The URL path to append to the agents Base URL when making requests for this linked attribute")
protected String path

method

@JsonPropertyDescription("The HTTP method to use when making requests for this linked attribute")
protected HTTPMethod method

contentType

@JsonPropertyDescription("The content type header value to use when making requests for this linked attribute (shortcut alternative to using headers parameter)")
protected String contentType

pollingAttribute

@JsonPropertyDescription("Allows the polled response to be written to another attribute with the specified name on the same asset as the linked attribute")
protected String pollingAttribute

messageConvertBinary

@JsonPropertyDescription("Indicates that the HTTP response is binary and should be converted to binary string representation")
protected boolean messageConvertBinary

messageConvertHex

@JsonPropertyDescription("Indicates that the HTTP response is binary and should be converted to hexidecimal string representation")
protected boolean messageConvertHex

Constructor Details

HTTPAgentLink

protected HTTPAgentLink()

HTTPAgentLink

public HTTPAgentLink(String id)

Method Details

getHeaders

public Optional<Map<String,List<String>>> getHeaders()

setHeaders

public HTTPAgentLink setHeaders(org.openremote.model.value.ValueType.MultivaluedStringMap headers)

getQueryParameters

public Optional<Map<String,List<String>>> getQueryParameters()

setQueryParameters

public HTTPAgentLink setQueryParameters(org.openremote.model.value.ValueType.MultivaluedStringMap queryParameters)

getPollingMillis

public Optional<Integer> getPollingMillis()

setPollingMillis

public HTTPAgentLink setPollingMillis(Integer pollingMillis)

getPagingMode

public Optional<Boolean> getPagingMode()

setPagingMode

public HTTPAgentLink setPagingMode(Boolean pagingMode)

getPath

public Optional<String> getPath()

setPath

public HTTPAgentLink setPath(String path)

getMethod

public Optional<HTTPMethod> getMethod()

setMethod

public HTTPAgentLink setMethod(HTTPMethod method)

getContentType

public Optional<String> getContentType()

setContentType

public HTTPAgentLink setContentType(String contentType)

getPollingAttribute

public Optional<String> getPollingAttribute()

setPollingAttribute

public HTTPAgentLink setPollingAttribute(String pollingAttribute)

isMessageConvertBinary

public boolean isMessageConvertBinary()

setMessageConvertBinary

public HTTPAgentLink setMessageConvertBinary(boolean messageConvertBinary)

isMessageConvertHex

public boolean isMessageConvertHex()

setMessageConvertHex

public HTTPAgentLink setMessageConvertHex(boolean messageConvertHex)