com.ibm.etill.framework.xdm
Class PSServerPayServer

java.lang.Object
  |
  +--com.ibm.etill.framework.xdm.PSServerObject
        |
        +--com.ibm.etill.framework.xdm.PSServerAdminObject
              |
              +--com.ibm.etill.framework.xdm.PSServerPayServer
All Implemented Interfaces:
FrameworkReturnCodes, PaymentAPIConstants, PSServerAdminConstants, PSServerPayServerConstants, com.ibm.etill.framework.clientapi.XDMConstants

public final class PSServerPayServer
extends PSServerAdminObject
implements PSServerPayServerConstants

Pay server class that a cassette registers with.

It keeps track of the cassette name and other relevant cassette properties. And provides operators for accessing these properties.


Fields inherited from interface com.ibm.etill.framework.xdm.PSServerPayServerConstants
APPROXIMATE_XDM_OBJECT_SIZE, COL_ETILLHOSTNAME, COL_GROWTH3, COL_TILLNAME, PayServerTable
 
Fields inherited from interface com.ibm.etill.framework.xdm.PSServerAdminConstants
COL_ACTIVE, COL_ENABLED, COL_MESSAGESKEY, COL_PENDING, COL_VALID
 
Fields inherited from interface com.ibm.etill.framework.clientapi.XDMConstants
batchStates, batchStatusList, creditStates, orderStates, paymentStates, PAYSERVERDTD, XDAN_ACCOUNTNAME, XDAN_ACCOUNTNUMBER, XDAN_ACTIVE, XDAN_ADMINHOSTNAME, XDAN_AMOUNT, XDAN_AMOUNTEXP10, XDAN_APAUTOAPPROVE, XDAN_APAUTODEPOSIT, XDAN_APPROVALEXPIRATION, XDAN_APPROVALEXPIRY, XDAN_APPROVEAMOUNT, XDAN_APPROVESALLOWED, XDAN_APPROVETIME, XDAN_BATCHNUMBER, XDAN_BATCHSTATUS, XDAN_BRAND, XDAN_BUYER_MESSAGE, XDAN_CASSETTEMSGS, XDAN_CASSETTENAME, XDAN_CHANGESPENDING, XDAN_COMMTYPE, XDAN_COMPANYPKGNAME, XDAN_CONFIGURATIONFLAG, XDAN_CONTENT, XDAN_CONTENTTYPE, XDAN_CREDITNUMBER, XDAN_CURRENCY, XDAN_DEPOSITAMOUNT, XDAN_DISPLAYDESCRIPTION, XDAN_DISPLAYHELP, XDAN_DISPLAYLENGTH, XDAN_DISPLAYMODE, XDAN_DISPLAYNAME, XDAN_DISPLAYTYPE, XDAN_ENABLED, XDAN_ETILLHOSTNAME, XDAN_EVENTTYPE, XDAN_FITITLE, XDAN_FORCEALLOWED, XDAN_FRAMEWORKMSGS, XDAN_ID, XDAN_KEY, XDAN_LISTENERURL, XDAN_MERCHANT_MESSAGE, XDAN_MERCHANTCONTROL, XDAN_MERCHANTNUMBER, XDAN_MERCHANTORIGINATED, XDAN_MERCHANTTITLE, XDAN_NDHOSTNAME, XDAN_NUMBEROFADMINCOMMANDS, XDAN_NUMBEROFCREDITS, XDAN_NUMBEROFORDERCOMMANDS, XDAN_NUMBEROFPAYMENTCOMMANDS, XDAN_NUMBEROFPAYMENTS, XDAN_NUMBEROFQUERYCOMMANDS, XDAN_OBJECT_COUNT, XDAN_OBJECTID, XDAN_ORDER, XDAN_ORDERDATA1, XDAN_ORDERDATA2, XDAN_ORDERDATA3, XDAN_ORDERDATA4, XDAN_ORDERDATA5, XDAN_ORDERNUMBER, XDAN_ORDERURL, XDAN_PAYMENTGROUPNAME, XDAN_PAYMENTNUMBER, XDAN_PAYMENTTYPE, XDAN_PLEXNAME, XDAN_PRIMARY_RC, XDAN_PROPERTYID, XDAN_PURGEALLOWED, XDAN_REALM, XDAN_REFERENCENUMBER, XDAN_REQUIRED, XDAN_ROLES, XDAN_RPAUTOAPPROVE, XDAN_RPAUTODEPOSIT, XDAN_SECONDARY_RC, XDAN_SIZE, XDAN_SOCKSHOST, XDAN_SOCKSPORT, XDAN_STATE, XDAN_SYSPLEXFLAG, XDAN_TIMEREGISTERED, XDAN_TIMESTAMPCLOSED, XDAN_TIMESTAMPCREATED, XDAN_TIMESTAMPMODIFIED, XDAN_TIMESTAMPOPENED, XDAN_TOTALCREDITAMOUNT, XDAN_TOTALMATCHES, XDAN_TOTALPAYMENTAMOUNT, XDAN_TRANSACTIONID, XDAN_TRANSFORM, XDAN_UNAPPROVEDAMOUNT, XDAN_USERNAME, XDAN_VALID, XDAN_VALUE, XDAN_VERSION, XDAN_WITHCREDITS, XDAN_WITHORDERS, XDAN_WITHPAYMENTS, XDAV_ADVANCED, XDAV_BASIC, XDAV_BATCH_PREFIX, XDAV_BOTH, XDAV_CASSETTE_OBJECT, XDAV_CREDIT_PREFIX, XDAV_FALSE, XDAV_HIDDEN, XDAV_ID_SEPARATOR, XDAV_ORDER_DESCRIPTION, XDAV_ORDER_PREFIX, XDAV_PAYMENT_PREFIX, XDAV_READONLY, XDAV_READWRITE, XDAV_TRANSFORM_NONE, XDAV_TRANSFORM_URL, XDAV_TRUE, XDAV_UNRECOGNIZED_STATE, XDAV_UNRECOGNIZED_STATUS, XDAV_UNSUPPORTED_ENCODING, XDCT_RESULTS_HEADER, XDDV_XML_ENCODING, XDDV_XML_VERSION, XDEN_ACCOUNTCOLLECTION, XDEN_BATCHCOLLECTION, XDEN_BATCHKEY, XDEN_BATCHLIST, XDEN_BATCHTOTALCOLLECTION, XDEN_CASSETTECOLLECTION, XDEN_CASSETTECONFIGOBJECT, XDEN_CASSETTEEXTOBJECT, XDEN_CASSETTEOBJECT, XDEN_CASSETTEPROPERTY, XDEN_CREDITCOLLECTION, XDEN_CREDITKEY, XDEN_CREDITLIST, XDEN_EVENTLISTENERCOLLECTION, XDEN_MERCHANTCOLLECTION, XDEN_MERCHCASSCOLLECTION, XDEN_ORDERCOLLECTION, XDEN_ORDERKEY, XDEN_ORDERLIST, XDEN_PACKAGEDCONTENT, XDEN_PAYMENTCOLLECTION, XDEN_PAYMENTKEY, XDEN_PAYMENTLIST, XDEN_PSABOUT, XDEN_PSACCOUNT, XDEN_PSBATCH, XDEN_PSBATCHTOTAL, XDEN_PSCASSETTE, XDEN_PSCASSETTEABOUT, XDEN_PSCREDIT, XDEN_PSEVENTLISTENER, XDEN_PSMERCHANT, XDEN_PSMERCHCASS, XDEN_PSOPERATION, XDEN_PSORDER, XDEN_PSPAYMENT, XDEN_PSPAYMENTSERVER, XDEN_PSSYSPLEX, XDEN_PSUSERINFO, XDEN_ROOT_ELEMENT, XDEN_USERINFOCOLLECTION
 
Constructor Summary
PSServerPayServer()
          The default constructor does nothing.
 
Method Summary
 void addCassetteConfigObject(CassetteConfigObject object)
          Adds a CassetteConfigObject.
 int getAdminAPIPort()
          Deprecated. The admin API port is no longer used in the product. This method always returns zero.
 long getAdminCmdCounter()
          Gets Admin command counter.
 int getEngineAPIPort()
          Deprecated. The engine API port is no longer used in the product. This method always returns zero.
 int getErrorLogPort()
          Deprecated. The error log API port is no longer used in the product. This method always returns zero.
 String getETillHostname()
          Gets payment server hostname
 String getFrameworkVersion()
           
 String getFrameworkVersion(String growth3)
           
 String getLogPath()
          Deprecated. The log path is no longer used in the product. This method always returns null. Instead use the WebSphere Application Server trace facility to control output of log and trace records.
 long getOrderCmdCounter()
          Gets order command counter.
 long getPaymentCmdCounter()
          Gets payment command counter.
 String getPaymentType()
          Gets this payment type.
 long getQueryCmdCounter()
          Gets query command counter.
 String getRealmName()
          Gets realm name
 String getTillName()
          Deprecated. The till name is no longer used in the product. This method always returns null.
 long getTraceFileSize()
          Deprecated. The trace file size is no longer used in the product. This method always returns zero. Instead use the WebSphere Application Server trace facility to control output of trace records.
 int getTraceSetting()
          Deprecated. The trace setting is no longer used in the product. This method always returns zero. Instead use the WebSphere Application Server trace facility to enable and disable trace in the product.
 String getUserExitPassThru()
          Deprecated. The user exit pass through is no longer used in the product. This method always returns null.
static Vector query(PayServerQueryRequest request, ResultSet rs, com.ibm.etill.framework.realm.PaymentServletRealm realm)
          Queries Payment Server for request.
static Vector retrieveAllRecords()
          Gets all payment server records.
 void setCassetteExtensionObject(CassetteExtensionObject extension)
          setCassetteExtensionObject and addCassetteConfigObject are not yet supported. For now, ETillCassetteException is thrown on method entry.
 void setPerfData(long orderCmdCounter, long paymentCmdCounter, long adminCmdCounter, long queryCmdCounter)
          Sets key counters for this payment server.
 com.ibm.etill.xml.parser.TXElement toXml()
          Converts payment server elements and attributes to an XML document.
static com.ibm.etill.xml.parser.TXElement toXMLPayServer(PSServerPayServer payServer)
          Uses toXml() to create an XML document.
 
Methods inherited from class com.ibm.etill.framework.xdm.PSServerAdminObject
getApproximateXDMSize, getMessages, isActive, isEnabled, isPending, isValid
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PSServerPayServer

public PSServerPayServer()
The default constructor does nothing.
Method Detail

getETillHostname

public String getETillHostname()
Gets payment server hostname
Returns:
String The payment server hostname

getEngineAPIPort

public int getEngineAPIPort()
Deprecated. The engine API port is no longer used in the product. This method always returns zero.

Gets payment engine API port
Returns:
int The engine API port

getTraceSetting

public int getTraceSetting()
Deprecated. The trace setting is no longer used in the product. This method always returns zero. Instead use the WebSphere Application Server trace facility to enable and disable trace in the product.

Gets the trace settings for this payment server instance
Returns:
int The payment server trace settings.

getTraceFileSize

public long getTraceFileSize()
Deprecated. The trace file size is no longer used in the product. This method always returns zero. Instead use the WebSphere Application Server trace facility to control output of trace records.

Gets the trace file size
Returns:
long The trace file size.

getLogPath

public String getLogPath()
Deprecated. The log path is no longer used in the product. This method always returns null. Instead use the WebSphere Application Server trace facility to control output of log and trace records.

Gets the log file path
Returns:
String The log file path.

getRealmName

public String getRealmName()
Gets realm name
Returns:
String The realm name.

getTillName

public String getTillName()
Deprecated. The till name is no longer used in the product. This method always returns null.

Gets payment server name
Returns:
String The payment server name.

getAdminAPIPort

public int getAdminAPIPort()
Deprecated. The admin API port is no longer used in the product. This method always returns zero.

Gets port for this Admin API
Returns:
int The port for the Admin API.

getErrorLogPort

public int getErrorLogPort()
Deprecated. The error log API port is no longer used in the product. This method always returns zero.

Gets port for the error log.
Returns:
int The port for the error log.

getUserExitPassThru

public String getUserExitPassThru()
Deprecated. The user exit pass through is no longer used in the product. This method always returns null.

Gets user exit passthru
Returns:
String The user exit passthru

getPaymentType

public String getPaymentType()
Gets this payment type.
Returns:
String null is the value currently returned.

getOrderCmdCounter

public long getOrderCmdCounter()
Gets order command counter.
Returns:
long The order command counter.

getPaymentCmdCounter

public long getPaymentCmdCounter()
Gets payment command counter.
Returns:
long The payment command counter.

getAdminCmdCounter

public long getAdminCmdCounter()
Gets Admin command counter.
Returns:
long The admin command counter.

getQueryCmdCounter

public long getQueryCmdCounter()
Gets query command counter.
Returns:
long The query command counter.

getFrameworkVersion

public String getFrameworkVersion(String growth3)

getFrameworkVersion

public String getFrameworkVersion()

setPerfData

public void setPerfData(long orderCmdCounter,
                        long paymentCmdCounter,
                        long adminCmdCounter,
                        long queryCmdCounter)
Sets key counters for this payment server.

query

public static Vector query(PayServerQueryRequest request,
                           ResultSet rs,
                           com.ibm.etill.framework.realm.PaymentServletRealm realm)
                    throws ETillAbortOperation
Queries Payment Server for request.
Parameters:
request - A PayServerQueryRequest object.
rs - A result set object.
Returns:
result A vector containing query output.
Throws:
ETillAbortOperation - if a database error is enountered.

setCassetteExtensionObject

public void setCassetteExtensionObject(CassetteExtensionObject extension)
setCassetteExtensionObject and addCassetteConfigObject are not yet supported. For now, ETillCassetteException is thrown on method entry.
Overrides:
setCassetteExtensionObject in class PSServerAdminObject
Following copied from class: com.ibm.etill.framework.xdm.PSServerAdminObject
Parameters:
extension - a CassetteExtensionObject

addCassetteConfigObject

public void addCassetteConfigObject(CassetteConfigObject object)
Description copied from class: PSServerAdminObject
Adds a CassetteConfigObject.
Overrides:
addCassetteConfigObject in class PSServerAdminObject
Following copied from class: com.ibm.etill.framework.xdm.PSServerAdminObject
Returns:
object a CassetteConfigObject

toXml

public com.ibm.etill.xml.parser.TXElement toXml()
Converts payment server elements and attributes to an XML document.
Returns:
xml The XML document.

toXMLPayServer

public static com.ibm.etill.xml.parser.TXElement toXMLPayServer(PSServerPayServer payServer)
Uses toXml() to create an XML document.
Parameters:
payServer - The PSServerPayServer object.
Returns:
xml The XML document.

retrieveAllRecords

public static Vector retrieveAllRecords()
                                 throws ETillAbortOperation
Gets all payment server records.
Returns:
Vector A list of all cassettes records.
Throws:
ETillAbortOperation - thrown if a catastrophic error is encountered