com.ibm.etill.framework.xdm
Class PSServerUserInfo

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

public final class PSServerUserInfo
extends PSServerAdminObject
implements PSServerUserInfoConstants

This class encapsulates user information administered by the payment server.


Fields inherited from interface com.ibm.etill.framework.xdm.PSServerUserInfoConstants
APPROXIMATE_XDM_OBJECT_SIZE, COL_ENABLED, COL_MERCHANTNUMBER, COL_USERNAME, COL_USERROLES, MAX_IN_STRING_SIZE, MISCONFIGURED, NOACCESSRIGHTS, PROPERLYCONFIGURED, USERMERCHANTMAPPINGS, USERPERMISSIONSTABLE, USERPERMISSIONSVIEW
 
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
PSServerUserInfo()
          This defualt constructor does nothing.
 
Method Summary
static Vector addRealmUsers(Vector databaseUsers, UserInfoQueryRequest request)
          Gets users who match query parameters.
static Vector checkUsersWithRealm(Vector databaseUsers, UserInfoQueryRequest request)
          Gets users who match query parameters.
 int getConfigurationFlag()
          Gets this configuration flag.
 Vector getMerchantNumbers()
          Gets this merchant numbers.
 String getPaymentType()
          Gets this payment type.<-- --> Currently not implamented.
 String getRoles()
          Gets this roles.
 String getUserName()
          Gets this user name.
 String getXDMRoles()
          Gets this XDM roles.
static Vector processQueryResults(UserInfoQueryRequest request, ResultSet rs)
           
static Vector query(ResultSet rs, Vector partialQueryResults)
          Queries Payment System for user information.
 String roleXMLFormat(String roles)
          Converts a roles string to an XML string.
 void setConfigurationFlag(int configFlag)
          Gets this configuration flag to configFlag.
 void setMerchantNumbers(Vector merchantNumbers)
          Sets this merchant number to merchantNumber.
 void setRoles(String rolesString)
          Sets this role to rolesString.
 void setUserName(String userName)
          Sets this user name to userName.
 com.ibm.etill.xml.parser.TXElement toXml()
          Converts this object as an XML element
static com.ibm.etill.xml.parser.TXElement toXMLUserInfoCollection(Enumeration userInfos)
          Converts this object as 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

PSServerUserInfo

public PSServerUserInfo()
This defualt constructor does nothing.
Method Detail

getUserName

public String getUserName()
Gets this user name.
Returns:
String The user name.

getMerchantNumbers

public Vector getMerchantNumbers()
Gets this merchant numbers.
Returns:
Vector The merchant numbers.

getRoles

public String getRoles()
Gets this roles.
Returns:
String The user roles.

getXDMRoles

public String getXDMRoles()
Gets this XDM roles.
Returns:
String The XDM roles.

getConfigurationFlag

public int getConfigurationFlag()
Gets this configuration flag.
Returns:
int The configuration flag.

getPaymentType

public String getPaymentType()
Gets this payment type.<-- --> Currently not implamented.
Returns:
null

setRoles

public void setRoles(String rolesString)
Sets this role to rolesString.
Parameters:
rolesString - The roles string.

setMerchantNumbers

public void setMerchantNumbers(Vector merchantNumbers)
Sets this merchant number to merchantNumber.
Parameters:
String - The input merchant number.

setUserName

public void setUserName(String userName)
Sets this user name to userName.
Parameters:
String - The input user name.

setConfigurationFlag

public void setConfigurationFlag(int configFlag)
Gets this configuration flag to configFlag.
Parameters:
int - the configuration flag

processQueryResults

public static Vector processQueryResults(UserInfoQueryRequest request,
                                         ResultSet rs)
                                  throws ETillAbortOperation

query

public static Vector query(ResultSet rs,
                           Vector partialQueryResults)
                    throws ETillAbortOperation
Queries Payment System for user information. Return "returnAtMost" number of users if "returnAtMost" is not equal to "-1". If it is equal to "-1", we will return all of them.
Parameters:
request - A UserInfoQueryRequest object.
rs - A database query output object.
Returns:
result A vector containing query output.
Throws:
ETillAbortOperation - if a database error is encountered.

toXml

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

toXMLUserInfoCollection

public static com.ibm.etill.xml.parser.TXElement toXMLUserInfoCollection(Enumeration userInfos)
Converts this object as an XML element
Parameters:
userInfos - An Enumeration object.
Returns:
collection The XML document.

roleXMLFormat

public String roleXMLFormat(String roles)
Converts a roles string to an XML string.
Parameters:
roles - A string of roles.
Returns:
String An XML string if roles is not null, else null.

addRealmUsers

public static Vector addRealmUsers(Vector databaseUsers,
                                   UserInfoQueryRequest request)
                            throws ETillAbortOperation
Gets users who match query parameters.
Parameters:
databaseUsers - A vector of database users.
realm - A PaymentServletRealm object.
userInfoRequest - A UserInfoQueryRequest object.
Throws:
ETillAbortOperation - thrown if database error is encountered.

checkUsersWithRealm

public static Vector checkUsersWithRealm(Vector databaseUsers,
                                         UserInfoQueryRequest request)
                                  throws ETillAbortOperation
Gets users who match query parameters.
Parameters:
databaseUsers - A vector of database users.
realm - A PaymentServletRealm object.
userInfoRequest - A UserInfoQueryRequest object.
Throws:
ETillAbortOperation - thrown if database error is encountered.