Docs For Class SessionConnection

Description

Abstraction of communication mechanism/protocol between client and server.

Abstraction of communication mechanism/protocol between client and server. Used internally by Session object.

Located in /SessionConnection.php (line 9)

Class Constant Summary

CONNECTION_TYPE = "connection.type"

FIND_ACCOUNT_TRANSACTION = "findAccountTransaction"

FIND_CUSTOMER_ACCOUNT = "findCustomerAccount"

FIND_PAYMENT_OPTION = "findPaymentOption"

FIND_PAYMENT_PLAN = "findPaymentPlan"

KEYSTORE_PASSWORD = "keystore.pasword"

KEYSTORE_PATH = "keystore.path"

PAYMENT_OPTION_VERIFICATION_AMOUNT = "payment-option.verification-amount"

PROCESSOR_HOST = "processor.host"

Method Summary

ArrayList find (String $queryName, HashMap $parameters)

void login (int $merchantAccountCode, String $password, HashMap $config)

void logout ()

CustomerAccount save (CustomerAccount $customerAccount)

ArrayList saveList (ArrayList $customerAccounts)

Methods

find (line 85)

Communicates find message to server

return: List of objects that matched search criteria

ArrayList find (String $queryName, HashMap $parameters)

String $queryName: queryName name of the query to be executed by the server
HashMap $parameters: parameters search parameters to use within the query

login (line 54)

Communicates login message to the server

void login (int $merchantAccountCode, String $password, HashMap $config)

int $merchantAccountCode: merchantAccountCode merchant account code
String $password: password password
HashMap $config: config configuration Map usually indicating connection URL

logout (line 59)

Communicates logout message to the server

Communicates logout message to the server for a single CustomerAccount

void logout ()

save (line 67)

Communicates save message to the server

return: persisted version of the CustomerAccount from server

CustomerAccount save (CustomerAccount $customerAccount)

CustomerAccount $customerAccount: customerAccount CustomerAccount to be saved

saveList (line 76)

Communicates save message to the server

Communicates save message to the server for a list of CustomerAccounts

return: List of persisted CustomerAccounts from the server

ArrayList saveList (ArrayList $customerAccounts)

ArrayList $customerAccounts: customerAccounts List of CustomerAccounts to be saved

Class Constants

CONNECTION_TYPE = "connection.type" (line 17)

var: Type of connection: xml or rmi.

FIND_ACCOUNT_TRANSACTION = "findAccountTransaction" (line 41)

var: Name of the query to search AccountTransactions

FIND_CUSTOMER_ACCOUNT = "findCustomerAccount" (line 33)

var: Name of the query to search CustomerAccounts

FIND_PAYMENT_OPTION = "findPaymentOption" (line 37)

var: Name of the query to search PaymentOptions

FIND_PAYMENT_PLAN = "findPaymentPlan" (line 45)

var: Name of the query to search PaymentPlans

KEYSTORE_PASSWORD = "keystore.pasword" (line 29)

var: Keystore password (for SSL).

KEYSTORE_PATH = "keystore.path" (line 25)

var: Path to keystore (for SSL).

PAYMENT_OPTION_VERIFICATION_AMOUNT = "payment-option.verification-amount" (line 21)

var: Amount authorized to verify new payment options (no charge is made).

PROCESSOR_HOST = "processor.host" (line 13)

var: HTTPs URL or JNDI path to the processing server.

Interface SessionConnection