com.ibm.etill.framework.xdm
Class PSServerEventListener

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

public final class PSServerEventListener
extends PSServerAdminObject
implements PSServerEventListenerConstants

This Payment Server event listener class should be instantiated by cassette developer interested in Payment Server events.


Fields inherited from interface com.ibm.etill.framework.xdm.PSServerEventListenerConstants
APPROXIMATE_XDM_OBJECT_SIZE, COL_CASSETTENAME, COL_EVENTTYPE, COL_LISTENERURL, COL_MERCHANTNUMBER, COL_SOCKSHOST, COL_SOCKSPORT, COL_TIMEREGISTERED, EVENTLISTENERTABLE
 
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
PSServerEventListener()
          The default constructor does nothing.
 
Method Summary
 String getCassetteName()
          Gets this cassette name.
 int getEventType()
          Gets this event type.
 String getListenerURL()
          Gets this event listener URL.
 String getMerchantNumber()
          Gets this merchant number.
 String getPaymentType()
          Gets this payment type.
 String getSocksHost()
          Gets this socks host.
 int getSocksPort()
          Gets socks port on socks host obtained from getSocksHost().
 long getTimeRegistered()
          Gets registered time.
static Vector query(EventListenerQueryRequest request, ResultSet rs)
          Queries Payment System for event listeners.
static Vector retrieveAllRecords()
          Retrieves all EventListenerQueryRequest objects.
 com.ibm.etill.xml.parser.TXElement toXml()
          Converts this object to an XML element
static com.ibm.etill.xml.parser.TXElement toXMLEventListenerCollection(Enumeration listeners)
          Converts only the required fields of this PSServerBatch object to an XML element.
 
Methods inherited from class com.ibm.etill.framework.xdm.PSServerAdminObject
addCassetteConfigObject, getApproximateXDMSize, getMessages, isActive, isEnabled, isPending, isValid, setCassetteExtensionObject
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PSServerEventListener

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

getEventType

public int getEventType()
Gets this event type.
Returns:
int The payment server event type.

getMerchantNumber

public String getMerchantNumber()
Gets this merchant number.
Returns:
String The merchant number.

getCassetteName

public String getCassetteName()
Gets this cassette name.
Returns:
String The cassette name.

getSocksHost

public String getSocksHost()
Gets this socks host.
Returns:
String The socks host. This could be IP address or hostname depending on whether a DNS is used or not.

getSocksPort

public int getSocksPort()
Gets socks port on socks host obtained from getSocksHost().
Returns:
int The socks port.

getListenerURL

public String getListenerURL()
Gets this event listener URL.
Returns:
String The events listener URL.

getTimeRegistered

public long getTimeRegistered()
Gets registered time.
Returns:
long The registered time.

getPaymentType

public String getPaymentType()
Gets this payment type.
Returns:
String This method is not implemented; it returns a null.

query

public static Vector query(EventListenerQueryRequest request,
                           ResultSet rs)
                    throws ETillAbortOperation
Queries Payment System for event listeners.
Parameters:
request - A EventListenerQueryRequest object.
rs - A database query output object.
Returns:
result A vector containing query output.
Throws:
ETillAbortOperation - if a database error is enountered.

toXml

public com.ibm.etill.xml.parser.TXElement toXml()
Converts this object to an XML element
Returns:
document The XML document.

toXMLEventListenerCollection

public static com.ibm.etill.xml.parser.TXElement toXMLEventListenerCollection(Enumeration listeners)
Converts only the required fields of this PSServerBatch object to an XML element.
Parameters:
listeners - this PSServerEventListener hash table elements.
Returns:
collection this PSServerEventListener object as an XML document

retrieveAllRecords

public static Vector retrieveAllRecords()
                                 throws ETillAbortOperation
Retrieves all EventListenerQueryRequest objects.
Returns:
Vector of EventListenerQueryRequest objects.
Throws:
ETillAbortOperation - if a database error is enountered.