Class HttpApiClient


  • public class HttpApiClient
    extends java.lang.Object
    Utility methods for calling external APIs in a standardized way.
    Since:
    0.8.0
    • Field Detail

      • throttleRate

        public java.lang.Long throttleRate
    • Constructor Detail

      • HttpApiClient

        public HttpApiClient()
    • Method Detail

      • callApi

        public ServiceResponse callApi​(java.lang.String url,
                                       java.lang.String path,
                                       java.lang.String username,
                                       java.lang.String password)
                                throws java.net.URISyntaxException,
                                       java.lang.Exception
        Throws:
        java.net.URISyntaxException
        java.lang.Exception
      • callApi

        public ServiceResponse callApi​(java.lang.String url,
                                       java.lang.String path,
                                       java.lang.String username,
                                       java.lang.String password,
                                       HttpApiClient.RequestOptions opts)
                                throws java.net.URISyntaxException,
                                       java.lang.Exception
        Throws:
        java.net.URISyntaxException
        java.lang.Exception
      • callApi

        public ServiceResponse callApi​(java.lang.String url,
                                       java.lang.String path,
                                       java.lang.String username,
                                       java.lang.String password,
                                       HttpApiClient.RequestOptions opts,
                                       java.lang.String method)
                                throws java.net.URISyntaxException,
                                       java.lang.Exception
        Throws:
        java.net.URISyntaxException
        java.lang.Exception
      • callJsonApi

        public ServiceResponse callJsonApi​(java.lang.String url,
                                           java.lang.String path)
                                    throws java.net.URISyntaxException,
                                           java.lang.Exception
        Throws:
        java.net.URISyntaxException
        java.lang.Exception
      • callJsonApi

        public ServiceResponse callJsonApi​(java.lang.String url,
                                           java.lang.String path,
                                           HttpApiClient.RequestOptions opts)
                                    throws java.net.URISyntaxException,
                                           java.lang.Exception
        Throws:
        java.net.URISyntaxException
        java.lang.Exception
      • callJsonApi

        public ServiceResponse callJsonApi​(java.lang.String url,
                                           java.lang.String path,
                                           HttpApiClient.RequestOptions opts,
                                           java.lang.String method)
                                    throws java.net.URISyntaxException,
                                           java.lang.Exception
        Throws:
        java.net.URISyntaxException
        java.lang.Exception
      • callJsonApi

        public ServiceResponse callJsonApi​(java.lang.String url,
                                           java.lang.String path,
                                           java.lang.String username,
                                           java.lang.String password,
                                           HttpApiClient.RequestOptions opts)
                                    throws java.net.URISyntaxException,
                                           java.lang.Exception
        Throws:
        java.net.URISyntaxException
        java.lang.Exception
      • callJsonApi

        public ServiceResponse callJsonApi​(java.lang.String url,
                                           java.lang.String path,
                                           java.lang.String username,
                                           java.lang.String password,
                                           HttpApiClient.RequestOptions opts,
                                           java.lang.String method)
                                    throws java.net.URISyntaxException,
                                           java.lang.Exception
        Throws:
        java.net.URISyntaxException
        java.lang.Exception
      • callXmlApi

        public ServiceResponse callXmlApi​(java.lang.String url,
                                          java.lang.String path,
                                          HttpApiClient.RequestOptions opts)
                                   throws java.net.URISyntaxException,
                                          java.lang.Exception
        Throws:
        java.net.URISyntaxException
        java.lang.Exception
      • callXmlApi

        public ServiceResponse callXmlApi​(java.lang.String url,
                                          java.lang.String path,
                                          java.lang.String username,
                                          java.lang.String password,
                                          HttpApiClient.RequestOptions opts,
                                          java.lang.String method)
                                   throws java.net.URISyntaxException,
                                          java.lang.Exception
        Throws:
        java.net.URISyntaxException
        java.lang.Exception
      • addRequiredHeader

        public java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> addRequiredHeader​(java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> headers,
                                                                                                    java.lang.String name,
                                                                                                    java.lang.String value)
      • shutdownClient

        public void shutdownClient()