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:

  • 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 org.openremote.model.http.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 hexadecimal 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<org.openremote.model.http.HTTPMethod> getMethod()

    • setMethod

      public HTTPAgentLink setMethod(org.openremote.model.http.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)