com.absio.broker.mapper

Interface IRestClient

All Known Implementing Classes:

RestClient

public interface IRestClient

Interface defining a RESTful client for interacting with the Absio Broker™ application.

Method Summary

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

Method Detail

delete

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

Executes an HTTP DELETE to the specified endpoint.

Parameters:

endpoint - The URL endpoint

headers - 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

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

Executes an HTTP GET to the specified endpoint.

Parameters:

endpoint - The URL endpoint

headers - 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

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

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.

Parameters:

url - The URL

headers - 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

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

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

Parameters:

endpoint - The URL endpoint

content - The content payload

headers - 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

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

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

Parameters:

endpoint - The URL endpoint

content - The content payload

headers - 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

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

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.

Parameters:

url - The fully-qualified URL

data - The content payload

headers - 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