Package com.morpheusdata.core.util

Class HttpApiClient

java.lang.Object

com.morpheusdata.core.util.HttpApiClient

public class HttpApiClient
extends java.lang.Object

Utility methods for calling external APIs in a standardized way.

Since:

0.8.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpApiClient.RequestOptions
static interface	HttpApiClient.WithClientFunction

Field Summary

Fields

Modifier and Type	Field	Description
NetworkProxy	networkProxy
java.lang.Long	throttleRate

Constructor Summary

Constructors

Constructor	Description
HttpApiClient()

Method Summary

Modifier and Type	Method	Description
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)
ServiceResponse	callApi(java.lang.String url, java.lang.String path, java.lang.String username, java.lang.String password)
ServiceResponse	callApi(java.lang.String url, java.lang.String path, java.lang.String username, java.lang.String password, HttpApiClient.RequestOptions opts)
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)
ServiceResponse	callJsonApi(java.lang.String url, java.lang.String path)
ServiceResponse	callJsonApi(java.lang.String url, java.lang.String path, HttpApiClient.RequestOptions opts)
ServiceResponse	callJsonApi(java.lang.String url, java.lang.String path, HttpApiClient.RequestOptions opts, java.lang.String method)
ServiceResponse	callJsonApi(java.lang.String url, java.lang.String path, java.lang.String username, java.lang.String password, HttpApiClient.RequestOptions opts)
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)
ServiceResponse	callXmlApi(java.lang.String url, java.lang.String path, HttpApiClient.RequestOptions opts)
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)
void	shutdownClient()

Methods inherited from class java.lang.Object

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

Field Detail

throttleRate

public java.lang.Long throttleRate

networkProxy

public NetworkProxy networkProxy

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()