com.kount.ris

Class KountRisClient

java.lang.Object

com.kount.ris.KountRisClient

public class KountRisClient
extends Object

Controller class for the Kount RIS SDK.

This class is responsible for the correct communication between the RIS client and the RIS server. It performs parameter validation, request transport, and response parsing.

Version:

$Id$

Author:

Kount <custserv@kount.com>

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiKey API key for merchant-server authentication.
protected StringBuilder	errorMessage StringBuilder to accumulate any error message found in the response being processed.
protected Transport	transport Transport to use for sending RIS request.

Constructor Summary

Constructors

Constructor and Description
KountRisClient() Explicit default constructor.
KountRisClient(String phrase, String url, InputStream p12in) Constructor that accepts a pass phrase.
KountRisClient(String phrase, String url, String p12file) Constructor that accepts a pass phrase.
KountRisClient(URL url, File apiKeyFile) Constructor for using API Keys instead of Certificates.
KountRisClient(URL url, File apiKeyFile, int connectionPoolThreads, int connectionPerRoute) Constructor for using API Key instead of Cert.
KountRisClient(URL url, String key) Constructor for using API Key instead of Cert.
KountRisClient(URL url, String key, int connectionPoolThreads, int connectionPerRoute) Constructor for using API Key instead of Cert.

Method Summary

Modifier and Type	Method and Description
protected String	getApiKey(File apiKeyFile) Fetch data contained in api key file.
protected Response	parse(Reader r) Parse a collection of key-value strings into a Response object.
Response	process(Request r) Performs the actions of sending, and parsing a RIS request.
protected Reader	send(Request r) Send a RIS request.
void	setApiKey(String key) Set api key to use.
void	setTransport(Transport t) Set the transport object to use.

Methods inherited from class java.lang.Object

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

Field Detail

transport

protected Transport transport

Transport to use for sending RIS request.

errorMessage

protected StringBuilder errorMessage

StringBuilder to accumulate any error message found in the response being processed.

apiKey

protected String apiKey

API key for merchant-server authentication.

Constructor Detail

KountRisClient

public KountRisClient()

Explicit default constructor.

KountRisClient

public KountRisClient(String phrase,
                      String url,
                      String p12file)

Constructor that accepts a pass phrase.

Parameters:

phrase - Private key pass phrase

url - RIS server url

p12file - Path to PKCS12 private key file

KountRisClient

public KountRisClient(String phrase,
                      String url,
                      InputStream p12in)

Constructor that accepts a pass phrase.

Parameters:

phrase - Private key pass phrase

url - RIS server url

p12in - PKCS12 private key file input stream

KountRisClient

public KountRisClient(URL url,
                      File apiKeyFile)
               throws RisTransportException

Constructor for using API Keys instead of Certificates.

Parameters:

url - Ris server URL

apiKeyFile - API key file (absolute path)

Throws:

RisTransportException - Exception if opening the api key file has a problem.

KountRisClient

public KountRisClient(URL url,
                      File apiKeyFile,
                      int connectionPoolThreads,
                      int connectionPerRoute)
               throws RisTransportException

Constructor for using API Key instead of Cert.

Parameters:

url - Ris server URL.

apiKeyFile - API key (key data as a string).

connectionPoolThreads - API key (key data as a int).

connectionPerRoute - API key (key data as a int).

Throws:

RisTransportException

KountRisClient

public KountRisClient(URL url,
                      String key)

Constructor for using API Key instead of Cert.

Parameters:

url - Ris server URL.

key - API key (key data as a string).

KountRisClient

public KountRisClient(URL url,
                      String key,
                      int connectionPoolThreads,
                      int connectionPerRoute)

Constructor for using API Key instead of Cert.

Parameters:

url - Ris server URL.

key - API key (key data as a string).

connectionPoolThreads - API key (key data as a int).

connectionPerRoute - API key (key data as a int).

Method Detail

setTransport

public void setTransport(Transport t)

Set the transport object to use. If not specified the default transport object used is KountHttpTransport.

Parameters:

t - Transport

setApiKey

public void setApiKey(String key)

Set api key to use.

Parameters:

key - Api key (value).

process

public Response process(Request r)
                 throws RisException

Performs the actions of sending, and parsing a RIS request.

Parameters:

r - Request

Returns:

Response

Throws:

RisException - A subclass of RisException will be thrown which will be of the type RisResponseException, RisTransportException.

send

protected Reader send(Request r)
               throws RisTransportException

Send a RIS request.

Parameters:

r - Request object to send.

Returns:

Reader for character streams returned by RIS

Throws:

RisTransportException - RIS transport exception

parse

protected Response parse(Reader r)
                  throws RisResponseException

Parse a collection of key-value strings into a Response object.

Parameters:

r - Reader for character stream returned by RIS

Returns:

Response object

Throws:

RisResponseException - RIS response exception

getApiKey

protected final String getApiKey(File apiKeyFile)
                          throws RisTransportException

Fetch data contained in api key file.

Parameters:

apiKeyFile - API key file.

Returns:

String API Key.

Throws:

RisTransportException - RIS transport exception