com.ibm.etill.framework.xdm
Class QueryResponse

java.lang.Object
  |
  +--com.ibm.etill.framework.payserverapi.PSAPIResponse
        |
        +--com.ibm.etill.framework.xdm.QueryResponse
All Implemented Interfaces:
FrameworkReturnCodes, PaymentAPIConstants, com.ibm.etill.framework.payserverapi.PaymentServletConstants, com.ibm.etill.framework.clientapi.XDMConstants

public class QueryResponse
extends com.ibm.etill.framework.payserverapi.PSAPIResponse

This class encapsulates the standard parameters that are required for all queries on Payment Server objects.


 
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
 
Fields inherited from interface com.ibm.etill.framework.payserverapi.PaymentServletConstants
CMDKEY_ENABLED, CMDKEY_FILTER, CMDKEY_MERCHANTNUMBER, CMDKEY_PASSWORD, CMDKEY_ROLE, CMDKEY_SHOWSENSITIVEDATA, CMDKEY_USER, COMMAND_PAYMENT_ENGINE_ADMIN, COMMAND_PAYMENT_ENGINE_ORDER, COMMAND_PAYMENT_ENGINE_PAYMENT, COMMAND_SERVLET, COMMAND_XDM, DELETEUSER, EOL, etApiVersion, INCLUDE_DIR, MAXIMUM_XDM_DOCUMENT_SIZE, MODIFYSYSPLEX, MODIFYUSERSTATUS, OPERATION, PAYMENTTYPE, QUERYACCOUNTS, QUERYBATCHES, QUERYCASSETTES, QUERYCREDITS, QUERYEVENTLISTENERS, QUERYMERCHANTS, QUERYORDERS, QUERYPAYMENTS, QUERYPAYMENTSERVER, QUERYPAYSYSTEMS, QUERYSYSPLEX, QUERYUSERS, SENSITIVEACCESSVALUE_CLERK, SENSITIVEACCESSVALUE_MERCHANTADMIN, SENSITIVEACCESSVALUE_NONE, SENSITIVEACCESSVALUE_PMADMIN, SENSITIVEACCESSVALUE_SUPERVISOR, SERVLET_PROPERTIES_FILE, SERVLETSETTING_APPEXPDELAY, SERVLETSETTING_ASYNCHAPPDELAY, SERVLETSETTING_DATASOURCE, SERVLETSETTING_DBOWNER, SERVLETSETTING_DBPASSWORD, SERVLETSETTING_DBUSERID, SERVLETSETTING_DEBUGONLY, SERVLETSETTING_DISABLEDUPORDERCHECK, SERVLETSETTING_HOSTNAME, SERVLETSETTING_INCLUDE_DIR, SERVLETSETTING_JDBCDRIVER, SERVLETSETTING_JDBCURL, SERVLETSETTING_PIP, SERVLETSETTING_PPOOLSIZE, SERVLETSETTING_REALM_PROPERTIES_PREFIX, SERVLETSETTING_REALMCLASS, SERVLETSETTING_SENSITIVEACCESSLEVEL, SERVLETSETTING_SPOOLSIZE, SERVLETSETTING_WSADPIP, SETUSERACCESSRIGHTS, TRACE_STRING, xorBaseInteger
 
Constructor Summary
QueryResponse(QueryRequest request)
          A constructor with QueryRequest as input parameter.
QueryResponse(QueryRequest request, ETillAbortOperation e)
          A constructor with QueryRequest as input parameter.
QueryResponse(QueryRequest request, int objectCount)
          A constructor with QueryRequest as input parameter.
 
Method Summary
 com.ibm.etill.xml.parser.TXDocument getQueryXMLDocument()
          Gets this query as an XML document.
static String maskSensitiveData(String sensitiveData)
          Masks a string of sensitive data up to 80 characters long with asterisks so it can be safely returned in a query command response.
static String maskSensitiveData(String sensitiveData, int charsToShow)
          Mask all or part of a string of sensitive data up to 80 characters long with asterisks so it can be safely returned in a query command response.
 
Methods inherited from class com.ibm.etill.framework.payserverapi.PSAPIResponse
getAdminCmdCounter, getHeaderDocument, getOrderCmdCounter, getPaymentCmdCounter, getQueryCmdCounter, getRootElement, getXMLDocument, setPerfData
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

QueryResponse

public QueryResponse(QueryRequest request)
              throws ETillAbortOperation
A constructor with QueryRequest as input parameter.
Parameters:
request - a QueryRequest object.
Throws:
ETillAbortOperation - if a fatal error is encountered.

QueryResponse

public QueryResponse(QueryRequest request,
                     ETillAbortOperation e)
A constructor with QueryRequest as input parameter.
Parameters:
request - a QueryRequest object.
e - a ETillAbortOperation object.

QueryResponse

public QueryResponse(QueryRequest request,
                     int objectCount)
              throws ETillAbortOperation
A constructor with QueryRequest as input parameter.
Parameters:
request - a QueryRequest object.
objectCount - the numbers of objects in the query response.
Throws:
ETillAbortOperation - if a fatal error is encountered.
Method Detail

getQueryXMLDocument

public com.ibm.etill.xml.parser.TXDocument getQueryXMLDocument()
Gets this query as an XML document.
Returns:
doc An XML document.

maskSensitiveData

public static String maskSensitiveData(String sensitiveData,
                                       int charsToShow)
Mask all or part of a string of sensitive data up to 80 characters long with asterisks so it can be safely returned in a query command response. To mask strings longer than 80 characters, use repeated calls to this method on 80 character substrings of the sensitive data.
Parameters:
sensitiveData - String containing the sensitive data to mask
charsToShow - integer indicating how many characters to show and whether they should be leading or trailing characters.
  • Negative values cause the first n characters of the actual value to be included in the resulting string. For example, assuming the string "1111222233334444" is the sensitive data, -3 says to include the first 3 characters and mask all remaining characters with asterisks. The resulting string would be "111*************".
  • Positive values cause the last n characters of the actual value to be included in the resulting string. For example, 3 says to include the last 3 characters and mask all preceding characters with asterisks. Using the input string from above, the resulting string would be "*************444".
  • 0 indicates that the entire value should be replaced with asterisks. Using the input string from above, the resulting string would be "****************"
If this value is greater than the length of the input string, then the entire string will be returned unmasked.
Returns:
String The masked string.

maskSensitiveData

public static String maskSensitiveData(String sensitiveData)
Masks a string of sensitive data up to 80 characters long with asterisks so it can be safely returned in a query command response. To mask strings longer than 80 characters, use repeated calls to this method on 80 character substrings of the sensitive data.
Parameters:
sensitiveData - String containing the sensitive data to mask
Returns:
String A string of asterisks whose length matches that of the the input string.