com.ibm.batch.container.services
Interface IPersistenceManagerService

All Superinterfaces:

IBatchServiceBase

All Known Implementing Classes:

AbstractMapBasedPersistenceManagerImpl, AbstractPersistenceManagerImpl, FileBasedPersistenceManagerImpl, InMemoryPersistenceManagerImpl, JDBCPersistenceManagerImpl

public interface IPersistenceManagerService
extends IBatchServiceBase

Field Summary

static int	CHECKPOINT_STORE_ID
static int	JOB_STATUS_STORE_ID
static int	LOGICAL_TX_STORE_ID
static int	PJM_JOBCONTEXT_STORE_ID
static int	STEP_STATUS_STORE_ID
static int	SUBMITTEDJOBS_STORE_ID

Method Summary

void	createData(int storeDestination, IPersistenceDataKey key, Serializable value) (Required) Its purpose is to insert data into a particular store.
void	deleteData(int storeDestination, IPersistenceDataKey key) (Required) Its purpose is to delete the data items corresponding to the given key from the given store.
List	getData(int storeDestination, IPersistenceDataKey key) (Required) Its purpose is to fetch data using the given key from a particular store
void	jobExecutionStatusStringUpdate(long key, String statusToUpdate, String statusString, Timestamp updatets)
void	jobExecutionTimestampUpdate(long key, String timestampToUpdate, Timestamp ts)
void	jobOperatorCreateExecutionData(long key, Timestamp createTime, Timestamp starttime, Timestamp endtime, Timestamp updateTime, Properties parms, long instanceID, String batchstatus, String exitstatus)
void	jobOperatorCreateJobInstanceData(long key, String jobNameValue) JOB OPERATOR ONLY METHODS
int	jobOperatorGetJobInstanceCount(String jobName)
List<Long>	jobOperatorgetJobInstanceIds(String jobName, int start, int count)
Set<String>	jobOperatorgetJobNames()
long	jobOperatorQueryJobExecutionJobInstanceId(long executionID)
String	jobOperatorQueryJobExecutionStatus(long key, String requestedStatus)
Timestamp	jobOperatorQueryJobExecutionTimestamp(long key, String timetype)
void	stepExecutionCreateStepExecutionData(String stepExecutionKey, long jobExecutionID, long stepExecutionID)
long	stepExecutionQueryID(String key, String idtype)
List<StepExecution>	stepExecutionQueryIDList(long key, String idtype)
void	updateData(int storeDestination, IPersistenceDataKey key, Serializable value) (Required) Its purpose is to update one or more fields of a data item identified by the key from the given data store.

Methods inherited from interface com.ibm.batch.container.services.IBatchServiceBase

init, shutdown

Field Detail

JOB_STATUS_STORE_ID

static final int JOB_STATUS_STORE_ID

See Also:

Constant Field Values

STEP_STATUS_STORE_ID

static final int STEP_STATUS_STORE_ID

See Also:

Constant Field Values

CHECKPOINT_STORE_ID

static final int CHECKPOINT_STORE_ID

See Also:

Constant Field Values

SUBMITTEDJOBS_STORE_ID

static final int SUBMITTEDJOBS_STORE_ID

See Also:

Constant Field Values

LOGICAL_TX_STORE_ID

static final int LOGICAL_TX_STORE_ID

See Also:

Constant Field Values

PJM_JOBCONTEXT_STORE_ID

static final int PJM_JOBCONTEXT_STORE_ID

See Also:

Constant Field Values

Method Detail

createData

void createData(int storeDestination,
                IPersistenceDataKey key,
                Serializable value)
                throws PersistenceException

(Required) Its purpose is to insert data into a particular store.

Parameters:

storeDestination - The target store destination. One of IPersistenceManagerService.JOB_STATUS_STORE_ID, IPersistenceManagerService.STEP_STATUS_STORE_ID, IPersistenceManagerService.CHECKPOINT_STORE_ID

key - A unique key under which the data should be stored.

value - A serializable object that contains the actual payload. One of JobStatus, StepStatus or CheckpointData

Throws:

PersistenceException

getData

List getData(int storeDestination,
             IPersistenceDataKey key)
             throws PersistenceException

(Required) Its purpose is to fetch data using the given key from a particular store

Parameters:

storeDestination - The store from which the data should be retrieved. One of IPersistenceManagerService.JOB_STATUS_STORE_ID, IPersistenceManagerService.STEP_STATUS_STORE_ID, IPersistenceManagerService.CHECKPOINT_STORE_ID

Returns:

A list containing the data items that match the input key filter. Depending on the type of the store the List should contain either JobStatus, StepStatus or CheckpointData objects

Throws:

PersistenceException

updateData

void updateData(int storeDestination,
                IPersistenceDataKey key,
                Serializable value)
                throws PersistenceException

(Required) Its purpose is to update one or more fields of a data item identified by the key from the given data store.

Parameters:

storeDestination - The store from which the data should be updated. One of IPersistenceManagerService.JOB_STATUS_STORE_ID, IPersistenceManagerService.STEP_STATUS_STORE_ID, IPersistenceManagerService.CHECKPOINT_STORE_ID

Throws:

PersistenceException

deleteData

void deleteData(int storeDestination,
                IPersistenceDataKey key)
                throws PersistenceException

(Required) Its purpose is to delete the data items corresponding to the given key from the given store.

Parameters:

storeDestination - The store from which the data should be deleted. One of IPersistenceManagerService.JOB_STATUS_STORE_ID, IPersistenceManagerService.STEP_STATUS_STORE_ID, IPersistenceManagerService.CHECKPOINT_STORE_ID

Throws:

PersistenceException

jobOperatorCreateJobInstanceData

void jobOperatorCreateJobInstanceData(long key,
                                      String jobNameValue)

JOB OPERATOR ONLY METHODS

jobOperatorGetJobInstanceCount

int jobOperatorGetJobInstanceCount(String jobName)

jobOperatorgetJobInstanceIds

List<Long> jobOperatorgetJobInstanceIds(String jobName,
                                        int start,
                                        int count)

jobOperatorgetJobNames

Set<String> jobOperatorgetJobNames()

jobOperatorCreateExecutionData

void jobOperatorCreateExecutionData(long key,
                                    Timestamp createTime,
                                    Timestamp starttime,
                                    Timestamp endtime,
                                    Timestamp updateTime,
                                    Properties parms,
                                    long instanceID,
                                    String batchstatus,
                                    String exitstatus)

jobOperatorQueryJobExecutionTimestamp

Timestamp jobOperatorQueryJobExecutionTimestamp(long key,
                                                String timetype)

jobOperatorQueryJobExecutionStatus

String jobOperatorQueryJobExecutionStatus(long key,
                                          String requestedStatus)

jobOperatorQueryJobExecutionJobInstanceId

long jobOperatorQueryJobExecutionJobInstanceId(long executionID)

jobExecutionStatusStringUpdate

void jobExecutionStatusStringUpdate(long key,
                                    String statusToUpdate,
                                    String statusString,
                                    Timestamp updatets)

jobExecutionTimestampUpdate

void jobExecutionTimestampUpdate(long key,
                                 String timestampToUpdate,
                                 Timestamp ts)

stepExecutionCreateStepExecutionData

void stepExecutionCreateStepExecutionData(String stepExecutionKey,
                                          long jobExecutionID,
                                          long stepExecutionID)

stepExecutionQueryID

long stepExecutionQueryID(String key,
                          String idtype)

stepExecutionQueryIDList

List<StepExecution> stepExecutionQueryIDList(long key,
                                             String idtype)