Package org.openremote.agent.protocol.http

Class HTTPAgent

java.lang.Object
org.openremote.model.asset.Asset<T>
org.openremote.model.asset.agent.Agent<HTTPAgent,HTTPProtocol,HTTPAgentLink>
org.openremote.agent.protocol.http.HTTPAgent
All Implemented Interfaces:
org.openremote.model.asset.AssetInfo, org.openremote.model.IdentifiableEntity<HTTPAgent>
@Entity public class HTTPAgent extends org.openremote.model.asset.agent.Agent<HTTPAgent,HTTPProtocol,HTTPAgentLink>

  • Nested Class Summary

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

    org.openremote.model.asset.Asset.AssetDeserializer

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.openremote.model.value.AttributeDescriptor<String>
    BASE_URI
     
    static final org.openremote.model.asset.agent.AgentDescriptor<HTTPAgent,HTTPProtocol,HTTPAgentLink>
    DESCRIPTOR
     
    static final org.openremote.model.value.AttributeDescriptor<Boolean>
    FOLLOW_REDIRECTS
     
    static final org.openremote.model.value.AttributeDescriptor<org.openremote.model.value.ValueType.MultivaluedStringMap>
    REQUEST_HEADERS
     
    static final org.openremote.model.value.AttributeDescriptor<org.openremote.model.value.ValueType.MultivaluedStringMap>
    REQUEST_QUERY_PARAMETERS
     
    static final org.openremote.model.value.AttributeDescriptor<Integer>
    REQUEST_TIMEOUT_MILLIS
     
    static final org.openremote.model.value.ValueDescriptor<org.openremote.model.http.HTTPMethod>
    VALUE_HTTP_METHOD
     

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<String>
    getBaseURI()
     
    Optional<Boolean>
    getFollowRedirects()
     
    Optional<Boolean>
    getMessageConvertBinary()
     
    Optional<Boolean>
    getMessageConvertHex()
     
    HTTPProtocol
    getProtocolInstance()
    Get the protocol instance for this Agent.
    Optional<org.openremote.model.value.ValueType.MultivaluedStringMap>
    getRequestHeaders()
     
    Optional<org.openremote.model.value.ValueType.MultivaluedStringMap>
    getRequestQueryParameters()
     
    Optional<Integer>
    getRequestTimeoutMillis()
     
    HTTPAgent
    setBaseURI(String value)
     
    HTTPAgent
    setFollowRedirects(Boolean value)
     
    HTTPAgent
    setMessageConvertBinary(Boolean value)
     
    HTTPAgent
    setMessageConvertHex(Boolean value)
     
    HTTPAgent
    setRequestHeaders(org.openremote.model.value.ValueType.MultivaluedStringMap value)
     
    HTTPAgent
    setRequestQueryParameters(org.openremote.model.value.ValueType.MultivaluedStringMap value)
     
    HTTPAgent
    setRequestTimeoutMillis(Integer value)
     

    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, getAssetClass, getAssetName, getAssetType, getAttribute, getAttribute, getAttributeNames, getAttributes, getAttributesString, getCreatedOn, getEmail, getId, getLocation, getManufacturer, getMetaString, getModel, getName, getNotes, getParentId, getPath, getRealm, getTags, getType, getVersion, hasAttribute, hasAttribute, isAccessPublicRead, pathContains, postLoadCallback, 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

    • VALUE_HTTP_METHOD

      public static final org.openremote.model.value.ValueDescriptor<org.openremote.model.http.HTTPMethod> VALUE_HTTP_METHOD

    • BASE_URI

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

    • FOLLOW_REDIRECTS

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

    • REQUEST_HEADERS

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

    • REQUEST_QUERY_PARAMETERS

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

    • REQUEST_TIMEOUT_MILLIS

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

    • DESCRIPTOR

      public static final org.openremote.model.asset.agent.AgentDescriptor<HTTPAgent,HTTPProtocol,HTTPAgentLink> DESCRIPTOR

  • Constructor Details

    • HTTPAgent

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

    • HTTPAgent

      public HTTPAgent(String name)

  • Method Details

    • getBaseURI

      public Optional<String> getBaseURI()

    • setBaseURI

      public HTTPAgent setBaseURI(String value)

    • getFollowRedirects

      public Optional<Boolean> getFollowRedirects()

    • setFollowRedirects

      public HTTPAgent setFollowRedirects(Boolean value)

    • getRequestHeaders

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

    • setRequestHeaders

      public HTTPAgent setRequestHeaders(org.openremote.model.value.ValueType.MultivaluedStringMap value)

    • getRequestQueryParameters

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

    • setRequestQueryParameters

      public HTTPAgent setRequestQueryParameters(org.openremote.model.value.ValueType.MultivaluedStringMap value)

    • getRequestTimeoutMillis

      public Optional<Integer> getRequestTimeoutMillis()

    • setRequestTimeoutMillis

      public HTTPAgent setRequestTimeoutMillis(Integer value)

    • getMessageConvertHex

      public Optional<Boolean> getMessageConvertHex()

    • setMessageConvertHex

      public HTTPAgent setMessageConvertHex(Boolean value)

    • getMessageConvertBinary

      public Optional<Boolean> getMessageConvertBinary()

    • setMessageConvertBinary

      public HTTPAgent setMessageConvertBinary(Boolean value)

    • getProtocolInstance

      public HTTPProtocol 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<HTTPAgent,HTTPProtocol,HTTPAgentLink>