Package com.ebasetech.xi.api

Class RestOptions

java.lang.Object
com.ebasetech.xi.api.RestOptions
All Implemented Interfaces:
java.io.Serializable
public class RestOptions
extends java.lang.Object
implements java.io.Serializable
This class supplies options used to invoke Rest Web Services. It is used as an argument for RestServices.

Further documentation.

See Also:
Serialized Form

  • Constructor Summary

    Constructors
    Constructor Description
    RestOptions()  

  • Method Summary

    Modifier and Type Method Description
    java.lang.Integer getConnectionTimeout()  
    java.lang.String getResponseCharset()  
    java.lang.Integer getSocketTimeout()  
    void setConnectionTimeout​(java.lang.Integer connectionTimeout)
    Sets the number of seconds to wait to establish a connection with the target rest URL before timing out.
    void setResponseCharset​(java.lang.String responseCharset)
    Sets the default charset to be applied when reading the response if the charset is not found in the response header Content-Type.
    void setSocketTimeout​(java.lang.Integer socketTimeout)
    Sets the number of seconds of inactivity to wait from the target REST server before timing out.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • RestOptions

      public RestOptions()

  • Method Details

    • getSocketTimeout

      public java.lang.Integer getSocketTimeout()
      Returns:
      the number of seconds of inactivity to wait from the target REST server before timing out.
      See Also:
      setSocketTimeout(Integer)

    • setSocketTimeout

      public void setSocketTimeout​(java.lang.Integer socketTimeout)
      Sets the number of seconds of inactivity to wait from the target REST server before timing out.
      Parameters:
      socketTimeout -
      See Also:
      getSocketTimeout()

    • getConnectionTimeout

      public java.lang.Integer getConnectionTimeout()
      Returns:
      the number of seconds to wait to establish a connection with the target rest URL before timing out.
      See Also:
      setConnectionTimeout(Integer)

    • setConnectionTimeout

      public void setConnectionTimeout​(java.lang.Integer connectionTimeout)
      Sets the number of seconds to wait to establish a connection with the target rest URL before timing out.
      Parameters:
      connectionTimeout -
      See Also:
      getConnectionTimeout()

    • getResponseCharset

      public java.lang.String getResponseCharset()
      Returns:
      the default charset to be applied when reading the response if the charset is not found in the response header Content-Type.

      For example: Content-Type: text/html; charset=UTF-8.

      ISO-8859-1 is the default charset applied if no charset is supplied.

      See Also:
      setResponseCharset(String)

    • setResponseCharset

      public void setResponseCharset​(java.lang.String responseCharset)
      Sets the default charset to be applied when reading the response if the charset is not found in the response header Content-Type.

      For example: Content-Type: text/html; charset=UTF-8.

      ISO-8859-1 is the default charset applied if no charset is supplied.

      See Also:
      getResponseCharset()