Package com.morpheusdata.core.util

Class HttpApiClient

java.lang.Object

com.morpheusdata.core.util.HttpApiClient

public class HttpApiClient
extends 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
Long	throttleRate	Sets a throttle rate (in milliseconds) between HTTP Calls.

Constructor Summary

Constructors

Constructor	Description
HttpApiClient()

Method Summary

Modifier and Type	Method	Description
Map<CharSequence,CharSequence>	addRequiredHeader(Map<CharSequence,CharSequence> headers, String name, String value)
ServiceResponse	callApi(String url, String path, String username, String password)
ServiceResponse	callApi(String url, String path, String username, String password, HttpApiClient.RequestOptions opts)
ServiceResponse	callApi(String url, String path, String username, String password, HttpApiClient.RequestOptions opts, String method)
ServiceResponse	callJsonApi(String url, String path)
ServiceResponse	callJsonApi(String url, String path, HttpApiClient.RequestOptions opts)
ServiceResponse	callJsonApi(String url, String path, HttpApiClient.RequestOptions opts, String method)
ServiceResponse	callJsonApi(String url, String path, String username, String password, HttpApiClient.RequestOptions opts)
ServiceResponse	callJsonApi(String url, String path, String username, String password, HttpApiClient.RequestOptions opts, String method)
ServiceResponse	callXmlApi(String url, String path, HttpApiClient.RequestOptions opts)
ServiceResponse	callXmlApi(String url, String path, String username, String password, HttpApiClient.RequestOptions opts, String method)
void	shutdownClient()

Methods inherited from class java.lang.Object

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

Field Details

throttleRate

public Long throttleRate

Sets a throttle rate (in milliseconds) between HTTP Calls. This is used to slow down queries to the remote server.

networkProxy

public NetworkProxy networkProxy

Constructor Details

HttpApiClient

public HttpApiClient()

Method Details

callApi

public ServiceResponse callApi(String url,
 String path,
 String username,
 String password)
                        throws URISyntaxException,
Exception

Throws:

URISyntaxException

Exception

callApi

public ServiceResponse callApi(String url,
 String path,
 String username,
 String password,
 HttpApiClient.RequestOptions opts)
                        throws URISyntaxException,
Exception

Throws:

URISyntaxException

Exception

callApi

public ServiceResponse callApi(String url,
 String path,
 String username,
 String password,
 HttpApiClient.RequestOptions opts,
 String method)
                        throws URISyntaxException,
Exception

Throws:

URISyntaxException

Exception

callJsonApi

public ServiceResponse callJsonApi(String url,
 String path)
                            throws URISyntaxException,
Exception

Throws:

URISyntaxException

Exception

callJsonApi

public ServiceResponse callJsonApi(String url,
 String path,
 HttpApiClient.RequestOptions opts)
                            throws URISyntaxException,
Exception

Throws:

URISyntaxException

Exception

callJsonApi

public ServiceResponse callJsonApi(String url,
 String path,
 HttpApiClient.RequestOptions opts,
 String method)
                            throws URISyntaxException,
Exception

Throws:

URISyntaxException

Exception

callJsonApi

public ServiceResponse callJsonApi(String url,
 String path,
 String username,
 String password,
 HttpApiClient.RequestOptions opts)
                            throws URISyntaxException,
Exception

Throws:

URISyntaxException

Exception

callJsonApi

public ServiceResponse callJsonApi(String url,
 String path,
 String username,
 String password,
 HttpApiClient.RequestOptions opts,
 String method)
                            throws URISyntaxException,
Exception

Throws:

URISyntaxException

Exception

callXmlApi

public ServiceResponse callXmlApi(String url,
 String path,
 HttpApiClient.RequestOptions opts)
                           throws URISyntaxException,
Exception

Throws:

URISyntaxException

Exception

callXmlApi

public ServiceResponse callXmlApi(String url,
 String path,
 String username,
 String password,
 HttpApiClient.RequestOptions opts,
 String method)
                           throws URISyntaxException,
Exception

Throws:

URISyntaxException

Exception

addRequiredHeader

public Map<CharSequence,CharSequence> addRequiredHeader(Map<CharSequence,CharSequence> headers,
 String name,
 String value)

shutdownClient

public void shutdownClient()