com.ibm.etill.framework.admin
Class FrameworkCassetteAdmin

java.lang.Object
  |
  +--com.ibm.etill.framework.admin.AdminObject
        |
        +--com.ibm.etill.framework.admin.CassetteAdmin
              |
              +--com.ibm.etill.framework.admin.FrameworkCassetteAdmin
All Implemented Interfaces:
Archivable, PSServerAdminConstants, PSServerCassetteConstants

public final synchronized class FrameworkCassetteAdmin
extends CassetteAdmin
implements PSServerCassetteConstants


Fields inherited from interface com.ibm.etill.framework.xdm.PSServerCassetteConstants
APPROXIMATE_XDM_OBJECT_SIZE, CassetteAdminTable, COL_CASSETTENAME, COL_COMPANYPKGNAME, COL_GROWTH3, COL_LOADABLE, MAX_CASSETTE_VERSION_LENGTH
 
Fields inherited from interface com.ibm.etill.framework.xdm.PSServerAdminConstants
COL_ACTIVE, COL_ENABLED, COL_MESSAGESKEY, COL_PENDING, COL_VALID
 
Method Summary
 void createRecord(Connection)
          Creates a new record representing this object in a Commerce Payments database table.
 void deleteRecord(Connection)
          Deletes an existing or newly-created record representing this object from a database table.
 Vector getExpiredPaymentsForCassette(String)
           
static Hashtable getInstalledCassettes()
           
 ReaderWriterMonitor getReaderWriterMonitor()
           
static Vector getUninitializedCassettes()
           
static void initializeClass()
           
static ReturnCodeStructure modifyObject(AdminRequest, Boolean)
           
static FrameworkCassetteAdmin obtainObject(String)
           
 void startObject()
          Implemented by subclasses to start this AdminObject.
 void stopObject()
          Implemented by subclasses to stop this AdminObject.
 void suppressCassette()
           
 void updateRecord(Connection)
          Updates an existing or newly-created record representing this object in a Payment Server database table.
 
Methods inherited from class com.ibm.etill.framework.admin.CassetteAdmin
getCassette, getCassetteName, getCompanyPackageName, getFullyQualifiedCassetteName, getTraceSetting, toString
 
Methods inherited from class com.ibm.etill.framework.admin.AdminObject
addCassetteMessage, addFrameworkMessage, getActive, getEnabled, getInvalidList, getPending, processConfigurationChanges, processExtension, setActive, setEnabled, setEnabled, setPending, validateExtension
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getReaderWriterMonitor

public ReaderWriterMonitor getReaderWriterMonitor()

initializeClass

public static void initializeClass()

obtainObject

public static FrameworkCassetteAdmin obtainObject(String)
                                           throws ETillRuntimeException

modifyObject

public static ReturnCodeStructure modifyObject(AdminRequest,
                                               Boolean)
                                        throws ETillAbortOperation

startObject

public void startObject()
                 throws ETillAbortOperation
Description copied from class: AdminObject
Implemented by subclasses to start this AdminObject. The Framework calls this method as required.
Overrides:
startObject in class AdminObject
Following copied from class: com.ibm.etill.framework.admin.AdminObject
Throws:
ETillAbortOperation - thrown if the object cannot be started.

stopObject

public void stopObject()
                throws ETillAbortOperation
Description copied from class: AdminObject
Implemented by subclasses to stop this AdminObject. The Framework calls this method as required.
Overrides:
stopObject in class AdminObject
Following copied from class: com.ibm.etill.framework.admin.AdminObject
Throws:
ETillAbortOperation - thrown if the object cannot be stopped.

createRecord

public void createRecord(Connection)
                  throws ETillAbortOperation
Description copied from interface: Archivable
Creates a new record representing this object in a Commerce Payments database table. The CommitPoint object calls this method during commit processing when this Archivable object is a member of the CommitPoint create list. This method should never be called directly from cassettes.

The implementation of this method determines which table is used and which data members from the object are to be stored into the table.

Following copied from interface: com.ibm.etill.framework.archive.Archivable
Parameters:
Connection - The JDBC Connection object used to access the database.
Throws:
ETillAbortOperation - Thrown if an SQLException is caught.

updateRecord

public void updateRecord(Connection)
                  throws ETillAbortOperation
Description copied from interface: Archivable
Updates an existing or newly-created record representing this object in a Payment Server database table. The CommitPoint object calls this method during commit processing when this Archivable object is a member of the CommitPoint update list. This method should never be called directly from cassettes.

If the Archivable object's record is being created within the same CommitPoint as this update, the CommitPoint object will ensure that the update is applied after the record has been created. The implementation of this method determines which fields in the record will be updated.

Following copied from interface: com.ibm.etill.framework.archive.Archivable
Parameters:
Connection - The JDBC Connection object used to access the database.
Throws:
ETillAbortOperation - Thrown if an SQLException is caught.

deleteRecord

public void deleteRecord(Connection)
                  throws ETillAbortOperation
Description copied from interface: Archivable
Deletes an existing or newly-created record representing this object from a database table. The CommitPoint object calls this method during commit processing when this Archivable object is a member of the CommitPoint delete list. This method should never be called directly from cassettes.

If the Archivable object's record is being created within the same CommitPoint as this deletion, the CommitPoint object will simply remove all operations on this record before committing the changes.

Following copied from interface: com.ibm.etill.framework.archive.Archivable
Parameters:
Connection - The JDBC Connection object used to access the database.
Throws:
ETillAbortOperation - Thrown if an SQLException is caught.

getInstalledCassettes

public static Hashtable getInstalledCassettes()

getUninitializedCassettes

public static Vector getUninitializedCassettes()

suppressCassette

public void suppressCassette()

getExpiredPaymentsForCassette

public Vector getExpiredPaymentsForCassette(String)
                                     throws ETillAbortOperation