public interface IRestClient
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.
|
String delete(String endpoint, com.absio.broker.mapper.ICustomHeaderWork headers) throws IOException, BrokerException, InterruptedException
endpoint
- The URL endpointheaders
- Custom HTTP headersIOException
- Thrown if a general IO error occurs while connecting to the serverBrokerException
- Thrown if the Absio Broker™ application returns an errorInterruptedException
- thrown when there is an interruption during rate limitingString get(String endpoint, com.absio.broker.mapper.ICustomHeaderWork headers) throws IOException, BrokerException, InterruptedException
endpoint
- The URL endpointheaders
- Custom HTTP headersIOException
- Thrown if a general IO error occurs while connecting to the serverBrokerException
- Thrown if the Absio Broker™ application returns an errorInterruptedException
- thrown when there is an interruption during rate limitingbyte[] getFromUrl(String url, com.absio.broker.mapper.ICustomHeaderWork headers) throws IOException, BrokerException, InterruptedException
NOTE: This method requires a full URL and not an endpoint like the other IRestClient
methods.
url
- The URLheaders
- Custom HTTP headersIOException
- Thrown if a general IO error occurs while connecting to the serverBrokerException
- Thrown if the Absio Broker™ application returns an errorInterruptedException
- thrown when there is an interruption during rate limitingString post(String endpoint, String content, com.absio.broker.mapper.ICustomHeaderWork headers) throws IOException, BrokerException, InterruptedException
endpoint
- The URL endpointcontent
- The content payloadheaders
- Custom HTTP headersIOException
- Thrown if a general IO error occurs while connecting to the serverBrokerException
- Thrown if the Absio Broker™ application returns an errorInterruptedException
- thrown when there is an interruption during rate limitingString put(String endpoint, String content, com.absio.broker.mapper.ICustomHeaderWork headers) throws IOException, BrokerException, InterruptedException
endpoint
- The URL endpointcontent
- The content payloadheaders
- Custom HTTP headersIOException
- Thrown if a general IO error occurs while connecting to the serverBrokerException
- Thrown if the Absio Broker™ application returns an errorInterruptedException
- thrown when there is an interruption during rate limitingString putToUrl(String url, byte[] data, com.absio.broker.mapper.ICustomHeaderWork headers) throws IOException, BrokerException, InterruptedException
NOTE: This method requires a full URL and not an endpoint like the other IRestClient
methods.
url
- The fully-qualified URLdata
- The content payloadheaders
- Custom HTTP headersIOException
- Thrown if a general IO error occurs while connecting to the serverBrokerException
- Thrown if the Absio Broker™ application returns an errorInterruptedException
- thrown when there is an interruption during rate limitingCopyright © 2021. All rights reserved.