|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
It defines the cassette configuration interface. It must be implemented by cassettes so they can be configured by the Configurator.
Field Summary | |
---|---|
static java.lang.String |
CASSETTE_CLASSPATH
The property name for the classpath containing all the classes required for the configuration of the target cassette implementation and the classes required in run-time to support the cassette execution; example: 'eTillVisaNetCassetteClasses.jar' |
static java.lang.String |
CASSETTE_CONFIG_CLASS
The property name for the fully qualified class name that implements this class (ICassetteConfigurator) for the target cassette implementation; example: 'com.ibm.etill.visanetcassette.configurator.VisaNetCassetteConfigurator' |
static java.lang.String |
CASSETTE_NAME
The property name for the name of the payment system supported by the target cassette implementation; example: 'VisaNet' |
static java.lang.String |
CASSETTE_VENDOR
The vendor name for the version of the target cassette implementation; example: 'IBM' |
static java.lang.String |
CASSETTE_VERSION
The property name for the version of the target cassette implementation; example: '5.5.0.0' |
static java.lang.String |
MIN_FRAMEWORK_VERSION
the property name for the minimal framework version of the target cassette implementation; example: '3.1' |
Method Summary | |
---|---|
void |
addToInstance(IDatabase database,
java.util.Properties properties)
Adds the cassette into the target Commerce Payments instance. |
java.util.List |
getArchiveName()
Gets the name(s) of the cassette implementation. |
java.lang.String |
getConfigClass()
Gets the config class of the cassette. |
java.lang.String |
getCreateScript()
Gets the name of the create script for the cassette. |
java.util.Hashtable |
getDatabaseScripts()
Gets the hashtable of the database scripts for the cassette. |
java.lang.String |
getDatabaseType()
Gets the database type. |
java.lang.String |
getDeleteScript()
Gets the name of the delete script for the cassette. |
long |
getLastCopiedTime()
Gets the last time the cassette was added to the ear. |
java.lang.String |
getMigrateScript()
Gets the name of the migrate script for the cassette. |
java.lang.String |
getMinFrameworkVersion()
Gets the minimal framework version of the cassette. |
java.lang.String |
getName()
Gets the name of the cassette implementation. |
java.util.List |
getPspl()
Gets the pspl(s) of the cassette implementation. |
java.util.List |
getRequiredParameters()
Gets the list of required parameters. |
java.util.Map |
getSystemProperties()
Gets the system properties. |
java.lang.String |
getVendor()
Gets the vendor implementing the cassette. |
java.lang.String |
getVersion()
Gets the version of the cassette implementation. |
void |
migrate(IDatabase database,
java.lang.String currentVersion)
Upgrades the cassette to the current version in the target Commerce Payments instance. |
void |
removeFromInstance(IDatabase database)
Removes the cassette from target Commerce Payments instance. |
java.lang.String |
toString()
Generates an String dump of the properties of the cassette implementation. |
Field Detail |
public static final java.lang.String CASSETTE_NAME
public static final java.lang.String CASSETTE_CONFIG_CLASS
public static final java.lang.String CASSETTE_CLASSPATH
public static final java.lang.String CASSETTE_VERSION
public static final java.lang.String CASSETTE_VENDOR
public static final java.lang.String MIN_FRAMEWORK_VERSION
Method Detail |
public java.lang.String getName()
public java.lang.String getVendor()
public java.lang.String getVersion()
public java.lang.String getConfigClass()
public java.util.List getArchiveName()
public java.lang.String getMinFrameworkVersion()
public java.util.List getPspl()
public java.lang.String getDatabaseType()
public java.util.Hashtable getDatabaseScripts()
public java.lang.String getCreateScript()
public java.lang.String getDeleteScript()
public java.lang.String getMigrateScript()
public java.util.List getRequiredParameters()
public java.util.Map getSystemProperties()
public void addToInstance(IDatabase database, java.util.Properties properties) throws CassetteAlreadyExistsException, CassetteCannotBeAddedException, DatabaseOperationFailedException
database
- Represents the Payments instance databaseproperties
- Optional parameter with specific cassette
propertiesCassetteAlreadyExistsException
- If the cassette already exists in the
target Payments instanceCassetteCannotBeAddedException
- If the cassette does not exist in the target Payments
instance but cannot be added to that instance; this
can be used to signalize a temporary problem, e.g.,
specific cassette properties are missingDatabaseOperationFailedException
- If a database operation failed preventing the
addition of the cassette in the target
Payments instancepublic void removeFromInstance(IDatabase database) throws CassetteDoesNotExistException, CassetteCannotBeRemovedException, DatabaseOperationFailedException
database
- Represents the Payments instance databaseCassetteDoesNotExistException
- If the cassette does not exist in the
target Payments instanceCassetteCannotBeRemovedException
- If the cassette exists in the target Payments instance but
cannot be removed from the instance; this can be used
to signalize a temporary problem, e.g., pending
requests need to be processed, or the cassette must
be inactivated firstDatabaseOperationFailedException
- If a database operation failed preventing the
remotion of the cassette from the target
Payments instancepublic void migrate(IDatabase database, java.lang.String currentVersion) throws CassetteDoesNotExistException, com.ibm.commerce.payments.configurator.InvalidMigrationException, MigrationErrorException, DatabaseOperationFailedException
database
- Represents the Payments instance databasetargetVersion
- New cassette version as a String
valueCassetteDoesNotExistException
- If the cassette does not exist in the
target PM instancecom.ibm.commerce.payments.configurator.InvalidMigrationException
- If the migration is not supported for the
current and target versions of the cassetteMigrationErrorException
- If the cassette cannot be migrated to the
target version of the cassette; this can be used
to signalize a temporary problem, e.g., pending
requests need to be processed, or the cassette must
be inactivated firstDatabaseOperationFailedException
- If a database operation failed preventing the
migration of the cassette in target
PM instancepublic long getLastCopiedTime()
properties
- the new properties to be setpublic java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |