com.absio.broker.mapper

Class RestClient

java.lang.Object

com.absio.broker.mapper.RestClient

All Implemented Interfaces:

IRestClient

public class RestClient
extends Object
implements IRestClient

RESTful client for interacting with the Absio Broker™ application.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestClient.TrustAllX509TrustManager

Constructor Summary

Constructors

Constructor and Description
RestClient(String url, String apiKey, String applicationName)
RestClient(String url, String apiKey, String applicationName, boolean trustAll)

Method Summary

Modifier and Type	Method and Description
String	delete(String endpoint, com.absio.broker.mapper.ICustomHeaderWork headerWork) Executes an HTTP DELETE to the specified endpoint.
String	get(String endpoint, com.absio.broker.mapper.ICustomHeaderWork headerWork) Executes an HTTP GET to the specified endpoint.
byte[]	getFromUrl(String url, com.absio.broker.mapper.ICustomHeaderWork headerWork) Executes an HTTP GET to the specified URL and returns the byte data.
String	post(String endpoint, String content, com.absio.broker.mapper.ICustomHeaderWork headerWork) Executes an HTTP POST to the specified endpoint with a content payload.
String	put(String endpoint, String content, com.absio.broker.mapper.ICustomHeaderWork headerWork) Executes an HTTP PUT to the specified endpoint with a content payload.
String	putToUrl(String url, byte[] data, com.absio.broker.mapper.ICustomHeaderWork headerWork) Executes an HTTP PUT to the specified URL with a data content payload.
static SSLContext	sslContext(KeyManager[] keyManagers, TrustManager[] trustManagers)

Methods inherited from class java.lang.Object

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

Constructor Detail

RestClient

public RestClient(String url,
                  String apiKey,
                  String applicationName)

RestClient

public RestClient(String url,
                  String apiKey,
                  String applicationName,
                  boolean trustAll)

Method Detail

sslContext

public static SSLContext sslContext(KeyManager[] keyManagers,
                                    TrustManager[] trustManagers)

delete

public String delete(String endpoint,
                     com.absio.broker.mapper.ICustomHeaderWork headerWork)
              throws IOException,
                     BrokerException,
                     InterruptedException

Description copied from interface: IRestClient

Executes an HTTP DELETE to the specified endpoint.

Specified by:

delete in interface IRestClient

Parameters:

endpoint - The URL endpoint

headerWork - Custom HTTP headers

Returns:

Content returned from the server

Throws:

IOException - Thrown if a general IO error occurs while connecting to the server

BrokerException - Thrown if the Absio Broker™ application returns an error

InterruptedException - thrown when there is an interruption during rate limiting

get

public String get(String endpoint,
                  com.absio.broker.mapper.ICustomHeaderWork headerWork)
           throws IOException,
                  BrokerException,
                  InterruptedException

Description copied from interface: IRestClient

Executes an HTTP GET to the specified endpoint.

Specified by:

get in interface IRestClient

Parameters:

endpoint - The URL endpoint

headerWork - Custom HTTP headers

Returns:

Content returned from the server

Throws:

IOException - Thrown if a general IO error occurs while connecting to the server

BrokerException - Thrown if the Absio Broker™ application returns an error

InterruptedException - thrown when there is an interruption during rate limiting

getFromUrl

public byte[] getFromUrl(String url,
                         com.absio.broker.mapper.ICustomHeaderWork headerWork)
                  throws IOException,
                         BrokerException,
                         InterruptedException

Description copied from interface: IRestClient

Executes an HTTP GET to the specified URL and returns the byte data.

NOTE: This method requires a full URL and not an endpoint like the other IRestClient methods.

Specified by:

getFromUrl in interface IRestClient

Parameters:

url - The URL

headerWork - Custom HTTP headers

Returns:

Content returned from the server

Throws:

IOException - Thrown if a general IO error occurs while connecting to the server

BrokerException - Thrown if the Absio Broker™ application returns an error

InterruptedException - thrown when there is an interruption during rate limiting

post

public String post(String endpoint,
                   String content,
                   com.absio.broker.mapper.ICustomHeaderWork headerWork)
            throws IOException,
                   BrokerException,
                   InterruptedException

Description copied from interface: IRestClient

Executes an HTTP POST to the specified endpoint with a content payload.

Specified by:

post in interface IRestClient

Parameters:

endpoint - The URL endpoint

content - The content payload

headerWork - Custom HTTP headers

Returns:

Content returned from the server

Throws:

IOException - Thrown if a general IO error occurs while connecting to the server

BrokerException - Thrown if the Absio Broker™ application returns an error

InterruptedException - thrown when there is an interruption during rate limiting

put

public String put(String endpoint,
                  String content,
                  com.absio.broker.mapper.ICustomHeaderWork headerWork)
           throws IOException,
                  BrokerException,
                  InterruptedException

Description copied from interface: IRestClient

Executes an HTTP PUT to the specified endpoint with a content payload.

Specified by:

put in interface IRestClient

Parameters:

endpoint - The URL endpoint

content - The content payload

headerWork - Custom HTTP headers

Returns:

Content returned from the server

Throws:

IOException - Thrown if a general IO error occurs while connecting to the server

BrokerException - Thrown if the Absio Broker™ application returns an error

InterruptedException - thrown when there is an interruption during rate limiting

putToUrl

public String putToUrl(String url,
                       byte[] data,
                       com.absio.broker.mapper.ICustomHeaderWork headerWork)
                throws IOException,
                       BrokerException,
                       InterruptedException

Description copied from interface: IRestClient

Executes an HTTP PUT to the specified URL with a data content payload.

NOTE: This method requires a full URL and not an endpoint like the other IRestClient methods.

Specified by:

putToUrl in interface IRestClient

Parameters:

url - The fully-qualified URL

data - The content payload

headerWork - Custom HTTP headers

Returns:

Content returned from the server

Throws:

IOException - Thrown if a general IO error occurs while connecting to the server

BrokerException - Thrown if the Absio Broker™ application returns an error

InterruptedException - thrown when there is an interruption during rate limiting