public class DatabasePersistenceAPI
extends java.lang.Object
The relevant methods are all public static
so that they can be used from ALSB Java Callouts. The class is not designed to be instantiated, and cannot be as it has a private constructor.
Constructor and Description |
---|
DatabasePersistenceAPI() |
Modifier and Type | Method and Description |
---|---|
static void |
deleteFromDB(MessageWrapper message, java.lang.String dataSourceName)
Deletes the wrapped message from database.
|
static void |
persistToDB(MessageWrapper message, java.lang.String dataSourceName)
Persists the wrapped message to database.
|
static MessageWrapper |
queryDB(java.lang.String messageType, java.lang.String dataSourceName, java.lang.String queryName, java.lang.String parameters)
Executes a query defined in the cartridge for a particular message type and returns a MessageWrapper object.
|
static int |
updateDB(java.lang.String sql, java.lang.String dataSourceName)
Updates the database by executing the sql passed.
|
public static void deleteFromDB(MessageWrapper message, java.lang.String dataSourceName) throws DeleteException
message
- the message to be deleted.dataSourceName
- the logical name of the data source.DeleteException
- for any deletion related errorspublic static int updateDB(java.lang.String sql, java.lang.String dataSourceName) throws DatabaseException
dataSourceName
- the logical name of the data source.sql
- the sql to be executedDatabaseException
- for any database related errorspublic static void persistToDB(MessageWrapper message, java.lang.String dataSourceName) throws PersistenceException
message
- the message to be persisted.dataSourceName
- name of the data source as referenced in the cartridge.PersistenceException
- for any persistence related errorspublic static MessageWrapper queryDB(java.lang.String messageType, java.lang.String dataSourceName, java.lang.String queryName, java.lang.String parameters) throws QueryException
messageType
- the message to be queried.dataSourceName
- the logical data source name.queryName
- name of the query defined in Cartridgeparameters
- semi-colon separated list of name-value pairs (e.g. messageType=MT100;Reference=Ref123). This list should contain a value for all parameters in the query definition. The names in the list should match the name of the parameters used in Query definition. The value specified should be convertible to corresponding parameter type.QueryException
- for any query related errors