com.kount.ris.transport

Class HttpApiTransport

java.lang.Object

com.kount.ris.transport.Transport

com.kount.ris.transport.HttpApiTransport

public class HttpApiTransport
extends Transport

RIS http data transport class.

Works with JWT (JSON Web Token) authentication, following the RFC 7519 standard. The used key is set as connection header with name 'X-Kount-Api-Key'.

Version:

$Id$

Author:

Kount <custserv@kount.com>

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiKey Cache the api key (minimize file reads to once per instatiation).
static String	CUSTOM_HEADER_API_KEY
static String	CUSTOM_HEADER_MERCHANT_ID
static int	DEFAULT_CONNECTION_IDLE_TIMEOUT_MINUTES
static int	DEFAULT_CONNECTION_TIMEOUT_MS
static int	DEFAULT_MAX_CONNECTIONS
static int	DEFAULT_SOCKET_TIMEOUT_MS

Fields inherited from class com.kount.ris.transport.Transport

connectTimeout, readTimeout, risServerUrl

Constructor Summary

Constructors

Constructor and Description
HttpApiTransport() Default transport constructor.
HttpApiTransport(URL url, String key) Constructor that accepts a RIS url and an api key as input.
HttpApiTransport(URL url, String key, int maxConnections, int maxConnectionsPerRoute) Constructor that accepts a RIS url and an api key as input.

Method Summary

Modifier and Type	Method and Description
ByteArrayInputStream	readAllIntput(org.apache.http.HttpEntity entity)
Reader	send(Map<String,String> params) Send transaction data to RIS.
void	setApiKey(String key) Set API Key.
void	setConnectionTimeToLive(int minutes) Set Connection Time To Live.

Methods inherited from class com.kount.ris.transport.Transport

convertToNameValuePair, setConnectTimeout, setReadTimeout, setRisServerUrl, writeParametersToOutput

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_CONNECTIONS

public static final int DEFAULT_MAX_CONNECTIONS

See Also:

Constant Field Values

DEFAULT_CONNECTION_IDLE_TIMEOUT_MINUTES

public static final int DEFAULT_CONNECTION_IDLE_TIMEOUT_MINUTES

See Also:

Constant Field Values

DEFAULT_CONNECTION_TIMEOUT_MS

public static final int DEFAULT_CONNECTION_TIMEOUT_MS

See Also:

Constant Field Values

DEFAULT_SOCKET_TIMEOUT_MS

public static final int DEFAULT_SOCKET_TIMEOUT_MS

See Also:

Constant Field Values

CUSTOM_HEADER_MERCHANT_ID

public static final String CUSTOM_HEADER_MERCHANT_ID

See Also:

Constant Field Values

CUSTOM_HEADER_API_KEY

public static final String CUSTOM_HEADER_API_KEY

See Also:

Constant Field Values

apiKey

protected String apiKey

Cache the api key (minimize file reads to once per instatiation).

Constructor Detail

HttpApiTransport

public HttpApiTransport()

Default transport constructor.

HttpApiTransport

public HttpApiTransport(URL url,
                        String key)

Constructor that accepts a RIS url and an api key as input.

Parameters:

url - RIS server url.

key - API key.

HttpApiTransport

public HttpApiTransport(URL url,
                        String key,
                        int maxConnections,
                        int maxConnectionsPerRoute)

Constructor that accepts a RIS url and an api key as input.

Parameters:

url - RIS server url.

key - API key.

maxConnections - connection Pool Threads.

maxConnectionsPerRoute - connection Per Route.

Method Detail

setApiKey

public void setApiKey(String key)

Set API Key.

Parameters:

key - String Kount Api Key (public) to use for authentication with RIS server.

setConnectionTimeToLive

public void setConnectionTimeToLive(int minutes)

Set Connection Time To Live.

Parameters:

minutes - integer specifying the connection time to live in minutes.

send

public Reader send(Map<String,String> params)
            throws RisTransportException

Send transaction data to RIS.

Specified by:

send in class Transport

Parameters:

params - Map of data to send

Returns:

Reader for character stream returned by RIS

Throws:

RisTransportException - RIS transport exception

readAllIntput

public ByteArrayInputStream readAllIntput(org.apache.http.HttpEntity entity)
                                   throws IOException

Throws:

IOException