cl.transbank.util

Class WebpayApiResource

java.lang.Object

cl.transbank.util.WebpayApiResource

public abstract class WebpayApiResource
extends Object

This abstract class represents a resource for the Webpay API.

Constructor Summary

Constructors

Constructor and Description
WebpayApiResource()

Method Summary

Modifier and Type	Method and Description
static Map<String,String>	buildHeaders(Options options) Builds the headers for a Webpay API request.
static <T> T	execute(String endpoint, HttpUtil.RequestMethod method, Options options, Class<T> clazz) Executes a Webpay API request.
static <T> T	execute(String endpoint, HttpUtil.RequestMethod method, WebpayApiRequest request, Options options) Executes a Webpay API request with a request body.
static <T> T	execute(String endpoint, HttpUtil.RequestMethod method, WebpayApiRequest request, Options options, Class<T> clazz) Executes a Webpay API request with a request body.
static <T> List<T>	executeToList(String endpoint, HttpUtil.RequestMethod method, Options options, Class<T[]> clazz) Executes a Webpay API request and returns a list of responses.
static <T> List<T>	executeToList(String endpoint, HttpUtil.RequestMethod method, WebpayApiRequest request, Options options, Class<T[]> clazz) Executes a Webpay API request with a request body and returns a list of responses.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebpayApiResource

public WebpayApiResource()

Method Detail

buildHeaders

public static Map<String,String> buildHeaders(Options options)

Builds the headers for a Webpay API request.

Parameters:

options - The options for the request.

Returns:

A map of headers for the request.

execute

public static <T> T execute(String endpoint,
                            HttpUtil.RequestMethod method,
                            Options options,
                            Class<T> clazz)
                     throws TransbankException,
                            IOException

Executes a Webpay API request.

Type Parameters:

T - The type of the response.

Parameters:

endpoint - The endpoint for the request.

method - The HTTP method for the request.

options - The options for the request.

clazz - The class of the response.

Returns:

The response to the request.

Throws:

TransbankException - If an error occurs during the request.

IOException - If an error occurs during the request.

execute

public static <T> T execute(String endpoint,
                            HttpUtil.RequestMethod method,
                            WebpayApiRequest request,
                            Options options)
                     throws TransbankException,
                            IOException

Executes a Webpay API request with a request body.

Type Parameters:

T - The type of the response.

Parameters:

endpoint - The endpoint for the request.

method - The HTTP method for the request.

request - The request body.

options - The options for the request.

Returns:

The response to the request.

Throws:

TransbankException - If an error occurs during the request.

IOException - If an error occurs during the request.

execute

public static <T> T execute(String endpoint,
                            HttpUtil.RequestMethod method,
                            WebpayApiRequest request,
                            Options options,
                            Class<T> clazz)
                     throws TransbankException,
                            IOException

Executes a Webpay API request with a request body.

Type Parameters:

T - The type of the response.

Parameters:

endpoint - The endpoint for the request.

method - The HTTP method for the request.

request - The request body.

options - The options for the request.

clazz - The class of the response.

Returns:

The response to the request.

Throws:

TransbankException - If an error occurs during the request.

IOException - If an error occurs during the request.

executeToList

public static <T> List<T> executeToList(String endpoint,
                                        HttpUtil.RequestMethod method,
                                        Options options,
                                        Class<T[]> clazz)
                                 throws TransbankException,
                                        IOException

Executes a Webpay API request and returns a list of responses.

Type Parameters:

T - The type of the response.

Parameters:

endpoint - The endpoint for the request.

method - The HTTP method for the request.

options - The options for the request.

clazz - The class of the response.

Returns:

A list of responses to the request.

Throws:

TransbankException - If an error occurs during the request.

IOException - If an error occurs during the request.

executeToList

public static <T> List<T> executeToList(String endpoint,
                                        HttpUtil.RequestMethod method,
                                        WebpayApiRequest request,
                                        Options options,
                                        Class<T[]> clazz)
                                 throws TransbankException,
                                        IOException

Executes a Webpay API request with a request body and returns a list of responses.

Type Parameters:

T - The type of the response.

Parameters:

endpoint - The endpoint for the request.

method - The HTTP method for the request.

request - The request body.

options - The options for the request.

clazz - The class of the response.

Returns:

A list of responses to the request.

Throws:

TransbankException - If an error occurs during the request.

IOException - If an error occurs during the request.