Package org.killbill.billing.client

Class KillBillHttpClient

java.lang.Object

org.killbill.billing.client.KillBillHttpClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class KillBillHttpClient
extends Object
implements Closeable

Field Summary

Fields

Modifier and Type	Field	Description
static String	ACCEPT_HTML
static String	ACCEPT_JSON
static String	ACCEPT_XML
static String	AUDIT_OPTION_COMMENT
static String	AUDIT_OPTION_CREATED_BY
static String	AUDIT_OPTION_REASON
static String	CONTENT_TYPE_JSON
static String	CONTENT_TYPE_XML
static String	CONTROL_PLUGIN_NAME
static Map<String,Collection<String>>	DEFAULT_EMPTY_QUERY
static int	DEFAULT_HTTP_TIMEOUT_SEC
static String	HTTP_HEADER_ACCEPT
static String	HTTP_HEADER_CONTENT_TYPE
static String	RBAC_OPTION_PASSWORD
static String	RBAC_OPTION_USERNAME
static String	TENANT_OPTION_API_KEY
static String	TENANT_OPTION_API_SECRET

Constructor Summary

Constructors

Constructor	Description
KillBillHttpClient()
KillBillHttpClient(String kbServerUrl, String username, String password, String apiKey, String apiSecret)
KillBillHttpClient(String kbServerUrl, String username, String password, String apiKey, String apiSecret, String proxyHost, Integer proxyPort)
KillBillHttpClient(String kbServerUrl, String username, String password, String apiKey, String apiSecret, String proxyHost, Integer proxyPort, Integer connectTimeOut, Integer readTimeOut)
KillBillHttpClient(String kbServerUrl, String username, String password, String apiKey, String apiSecret, String proxyHost, Integer proxyPort, Integer connectTimeOut, Integer readTimeOut, Boolean strictSSL, String SSLProtocol)

Method Summary

Modifier and Type	Method	Description
void	close()
<T> T	doDelete(String uri, Object body, Class<T> returnClass, RequestOptions requestOptions)
<T> T	doDelete(String uri, Object body, Class<T> returnClass, RequestOptions requestOptions, int timeoutSec)
HttpResponse<InputStream>	doDelete(String uri, Object body, RequestOptions options)
HttpResponse<InputStream>	doDelete(String uri, RequestOptions requestOptions)
HttpResponse<InputStream>	doGet(String uri, OutputStream outputStream, RequestOptions requestOptions)
<T> T	doGet(String uri, Class<T> returnClass, RequestOptions requestOptions)
<T> T	doGet(String uri, Class<T> returnClass, RequestOptions requestOptions, int timeoutSec)
HttpResponse<InputStream>	doGet(String uri, RequestOptions requestOptions)
HttpResponse<InputStream>	doHead(String uri, RequestOptions requestOptions)
HttpResponse<InputStream>	doHead(String uri, RequestOptions requestOptions, int timeoutSec)
HttpResponse<InputStream>	doOptions(String uri, RequestOptions requestOptions)
HttpResponse<InputStream>	doOptions(String uri, RequestOptions requestOptions, int timeoutSec)
<T> T	doPost(String uri, Object body, Class<T> returnClass, RequestOptions requestOptions)
<T> T	doPost(String uri, Object body, Class<T> returnClass, RequestOptions requestOptions, int timeoutSec)
HttpResponse<InputStream>	doPost(String uri, Object body, RequestOptions requestOptions)
<T> T	doPut(String uri, Object body, Class<T> returnClass, RequestOptions options)
<T> T	doPut(String uri, Object body, Class<T> returnClass, RequestOptions options, int timeoutSec)
HttpResponse<InputStream>	doPut(String uri, Object body, RequestOptions options)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HTTP_TIMEOUT_SEC

public static final int DEFAULT_HTTP_TIMEOUT_SEC

See Also:

Constant Field Values

DEFAULT_EMPTY_QUERY

public static final Map<String,Collection<String>> DEFAULT_EMPTY_QUERY

AUDIT_OPTION_CREATED_BY

public static final String AUDIT_OPTION_CREATED_BY

See Also:

Constant Field Values

AUDIT_OPTION_REASON

public static final String AUDIT_OPTION_REASON

See Also:

Constant Field Values

AUDIT_OPTION_COMMENT

public static final String AUDIT_OPTION_COMMENT

See Also:

Constant Field Values

TENANT_OPTION_API_KEY

public static final String TENANT_OPTION_API_KEY

See Also:

Constant Field Values

TENANT_OPTION_API_SECRET

public static final String TENANT_OPTION_API_SECRET

See Also:

Constant Field Values

RBAC_OPTION_USERNAME

public static final String RBAC_OPTION_USERNAME

See Also:

Constant Field Values

RBAC_OPTION_PASSWORD

public static final String RBAC_OPTION_PASSWORD

See Also:

Constant Field Values

CONTROL_PLUGIN_NAME

public static final String CONTROL_PLUGIN_NAME

See Also:

Constant Field Values

HTTP_HEADER_ACCEPT

public static final String HTTP_HEADER_ACCEPT

See Also:

Constant Field Values

HTTP_HEADER_CONTENT_TYPE

public static final String HTTP_HEADER_CONTENT_TYPE

See Also:

Constant Field Values

ACCEPT_HTML

public static final String ACCEPT_HTML

See Also:

Constant Field Values

ACCEPT_JSON

public static final String ACCEPT_JSON

See Also:

Constant Field Values

ACCEPT_XML

public static final String ACCEPT_XML

See Also:

Constant Field Values

CONTENT_TYPE_JSON

public static final String CONTENT_TYPE_JSON

See Also:

Constant Field Values

CONTENT_TYPE_XML

public static final String CONTENT_TYPE_XML

See Also:

Constant Field Values

Constructor Detail

KillBillHttpClient

public KillBillHttpClient(String kbServerUrl,
                          String username,
                          String password,
                          String apiKey,
                          String apiSecret,
                          String proxyHost,
                          Integer proxyPort,
                          Integer connectTimeOut,
                          Integer readTimeOut)

Parameters:

kbServerUrl - Kill Bill url

username - Kill Bill username

password - Kill Bill password

apiKey - Kill Bill api key

apiSecret - Kill Bill api secret

proxyHost - hostname of a proxy server that the client should use

proxyPort - port number of a proxy server that the client should use

connectTimeOut - connect timeout in milliseconds

readTimeOut - read timeout in milliseconds

KillBillHttpClient

public KillBillHttpClient(String kbServerUrl,
                          String username,
                          String password,
                          String apiKey,
                          String apiSecret,
                          String proxyHost,
                          Integer proxyPort,
                          Integer connectTimeOut,
                          Integer readTimeOut,
                          Boolean strictSSL,
                          String SSLProtocol)

Parameters:

kbServerUrl - Kill Bill url

username - Kill Bill username

password - Kill Bill password

apiKey - Kill Bill api key

apiSecret - Kill Bill api secret

proxyHost - hostname of a proxy server that the client should use

proxyPort - port number of a proxy server that the client should use

connectTimeOut - connect timeout in milliseconds

readTimeOut - read timeout in milliseconds

strictSSL - whether to bypass SSL certificates validation

SSLProtocol - SSL protocol to use

KillBillHttpClient

public KillBillHttpClient(String kbServerUrl,
                          String username,
                          String password,
                          String apiKey,
                          String apiSecret)

KillBillHttpClient

public KillBillHttpClient(String kbServerUrl,
                          String username,
                          String password,
                          String apiKey,
                          String apiSecret,
                          String proxyHost,
                          Integer proxyPort)

KillBillHttpClient

public KillBillHttpClient()

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

doPost

public HttpResponse<InputStream> doPost(String uri,
                                        Object body,
                                        RequestOptions requestOptions)
                                 throws KillBillClientException

Throws:

KillBillClientException

doPost

public <T> T doPost(String uri,
                    Object body,
                    Class<T> returnClass,
                    RequestOptions requestOptions)
             throws KillBillClientException

Throws:

KillBillClientException

doPost

public <T> T doPost(String uri,
                    Object body,
                    Class<T> returnClass,
                    RequestOptions requestOptions,
                    int timeoutSec)
             throws KillBillClientException

Throws:

KillBillClientException

doPut

public HttpResponse<InputStream> doPut(String uri,
                                       Object body,
                                       RequestOptions options)
                                throws KillBillClientException

Throws:

KillBillClientException

doPut

public <T> T doPut(String uri,
                   Object body,
                   Class<T> returnClass,
                   RequestOptions options)
            throws KillBillClientException

Throws:

KillBillClientException

doPut

public <T> T doPut(String uri,
                   Object body,
                   Class<T> returnClass,
                   RequestOptions options,
                   int timeoutSec)
            throws KillBillClientException

Throws:

KillBillClientException

doDelete

public HttpResponse<InputStream> doDelete(String uri,
                                          RequestOptions requestOptions)
                                   throws KillBillClientException

Throws:

KillBillClientException

doDelete

public HttpResponse<InputStream> doDelete(String uri,
                                          Object body,
                                          RequestOptions options)
                                   throws KillBillClientException

Throws:

KillBillClientException

doDelete

public <T> T doDelete(String uri,
                      Object body,
                      Class<T> returnClass,
                      RequestOptions requestOptions)
               throws KillBillClientException

Throws:

KillBillClientException

doDelete

public <T> T doDelete(String uri,
                      Object body,
                      Class<T> returnClass,
                      RequestOptions requestOptions,
                      int timeoutSec)
               throws KillBillClientException

Throws:

KillBillClientException

doGet

public HttpResponse<InputStream> doGet(String uri,
                                       OutputStream outputStream,
                                       RequestOptions requestOptions)
                                throws KillBillClientException

Throws:

KillBillClientException

doGet

public HttpResponse<InputStream> doGet(String uri,
                                       RequestOptions requestOptions)
                                throws KillBillClientException

Throws:

KillBillClientException

doGet

public <T> T doGet(String uri,
                   Class<T> returnClass,
                   RequestOptions requestOptions)
            throws KillBillClientException

Throws:

KillBillClientException

doGet

public <T> T doGet(String uri,
                   Class<T> returnClass,
                   RequestOptions requestOptions,
                   int timeoutSec)
            throws KillBillClientException

Throws:

KillBillClientException

doHead

public HttpResponse<InputStream> doHead(String uri,
                                        RequestOptions requestOptions)
                                 throws KillBillClientException

Throws:

KillBillClientException

doHead

public HttpResponse<InputStream> doHead(String uri,
                                        RequestOptions requestOptions,
                                        int timeoutSec)
                                 throws KillBillClientException

Throws:

KillBillClientException

doOptions

public HttpResponse<InputStream> doOptions(String uri,
                                           RequestOptions requestOptions)
                                    throws KillBillClientException

Throws:

KillBillClientException

doOptions

public HttpResponse<InputStream> doOptions(String uri,
                                           RequestOptions requestOptions,
                                           int timeoutSec)
                                    throws KillBillClientException

Throws:

KillBillClientException