com.ibm.jbatch.container.services

Interface IPersistenceManagerService

All Superinterfaces:

IBatchServiceBase

All Known Implementing Classes:

JDBCPersistenceManagerImpl

public interface IPersistenceManagerService
extends IBatchServiceBase

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IPersistenceManagerService.TimestampType

Method Summary

Modifier and Type	Method and Description
void	createCheckpointData(CheckpointDataKey key, CheckpointData value)
RuntimeFlowInSplitExecution	createFlowInSplitExecution(JobInstance jobInstance, BatchStatus batchStatus)
RuntimeJobExecution	createJobExecution(JobInstance jobInstance, Properties jobParameters, BatchStatus batchStatus) Create a JobExecution
JobInstance	createJobInstance(String name, String apptag, String jobXml) Creates a JobIntance
JobStatus	createJobStatus(long jobInstanceId) Create a JobStatus
StepExecutionImpl	createStepExecution(long jobExecId, StepContextImpl stepContext) Create a StepExecution
StepStatus	createStepStatus(long stepExecId) Create a StepStatus
JobInstance	createSubJobInstance(String name, String apptag)
CheckpointData	getCheckpointData(CheckpointDataKey key)
String	getJobCurrentTag(long jobInstanceId)
long	getJobInstanceIdByExecutionId(long executionId)
JobStatus	getJobStatus(long instanceId) Get a JobStatus
JobStatus	getJobStatusFromExecution(long executionId)
long	getMostRecentExecutionId(long jobInstanceId)
Map<String,StepExecution>	getMostRecentStepExecutionsForJobInstance(long instanceId)
Properties	getParameters(long executionId)
StepExecution	getStepExecutionByStepExecutionId(long stepExecId)
List<StepExecution>	getStepExecutionsForJobExecution(long execid)
StepStatus	getStepStatus(long instanceId, String stepName) Get a StepStatus The parent job instance id and this step name from the job xml are used to determine if the current step execution have previously run.
String	getTagName(long jobExecutionId) Get the application name from an execution id.
Map<Long,String>	jobOperatorGetExternalJobInstanceData()
IJobExecution	jobOperatorGetJobExecution(long jobExecutionId)
List<IJobExecution>	jobOperatorGetJobExecutions(long jobInstanceId)
int	jobOperatorGetJobInstanceCount(String jobName) JOB OPERATOR ONLY METHODS
int	jobOperatorGetJobInstanceCount(String jobName, String appTag)
List<Long>	jobOperatorGetJobInstanceIds(String jobName, int start, int count)
List<Long>	jobOperatorGetJobInstanceIds(String jobName, String appTag, int start, int count)
Set<Long>	jobOperatorGetRunningExecutions(String jobName)
String	jobOperatorQueryJobExecutionBatchStatus(long key)
String	jobOperatorQueryJobExecutionExitStatus(long key)
long	jobOperatorQueryJobExecutionJobInstanceId(long executionID)
Timestamp	jobOperatorQueryJobExecutionTimestamp(long key, IPersistenceManagerService.TimestampType timetype)
void	markJobStarted(long key, Timestamp startTS)
void	purge(String apptag)
void	updateBatchStatusOnly(long executionId, BatchStatus batchStatus, Timestamp timestamp)
void	updateCheckpointData(CheckpointDataKey key, CheckpointData value)
void	updateJobStatus(long instanceId, JobStatus jobStatus) Update a JobStatus
void	updateStepExecution(StepContextImpl stepContext) Update a StepExecution
void	updateStepStatus(long stepExecutionId, StepStatus stepStatus) Update a StepStatus
void	updateWithFinalExecutionStatusesAndTimestamps(long key, BatchStatus batchStatus, String exitStatus, Timestamp updatets)
void	updateWithFinalPartitionAggregateStepExecution(long rootJobExecutionId, StepContextImpl stepContext) Update a StepExecution for the "top-level" StepExecution of a partitioned step.

Methods inherited from interface com.ibm.jbatch.spi.services.IBatchServiceBase

init, shutdown

Method Detail

jobOperatorGetJobInstanceCount

int jobOperatorGetJobInstanceCount(String jobName)

JOB OPERATOR ONLY METHODS

jobOperatorGetJobInstanceCount

int jobOperatorGetJobInstanceCount(String jobName,
                                   String appTag)

jobOperatorGetExternalJobInstanceData

Map<Long,String> jobOperatorGetExternalJobInstanceData()

jobOperatorGetJobInstanceIds

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

jobOperatorGetJobInstanceIds

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

jobOperatorQueryJobExecutionTimestamp

Timestamp jobOperatorQueryJobExecutionTimestamp(long key,
                                                IPersistenceManagerService.TimestampType timetype)

jobOperatorQueryJobExecutionBatchStatus

String jobOperatorQueryJobExecutionBatchStatus(long key)

jobOperatorQueryJobExecutionExitStatus

String jobOperatorQueryJobExecutionExitStatus(long key)

jobOperatorQueryJobExecutionJobInstanceId

long jobOperatorQueryJobExecutionJobInstanceId(long executionID)
                                        throws NoSuchJobExecutionException

Throws:

NoSuchJobExecutionException

getStepExecutionsForJobExecution

List<StepExecution> getStepExecutionsForJobExecution(long execid)

getMostRecentStepExecutionsForJobInstance

Map<String,StepExecution> getMostRecentStepExecutionsForJobInstance(long instanceId)

updateBatchStatusOnly

void updateBatchStatusOnly(long executionId,
                           BatchStatus batchStatus,
                           Timestamp timestamp)

markJobStarted

void markJobStarted(long key,
                    Timestamp startTS)

updateWithFinalExecutionStatusesAndTimestamps

void updateWithFinalExecutionStatusesAndTimestamps(long key,
                                                   BatchStatus batchStatus,
                                                   String exitStatus,
                                                   Timestamp updatets)

jobOperatorGetJobExecution

IJobExecution jobOperatorGetJobExecution(long jobExecutionId)

getParameters

Properties getParameters(long executionId)
                  throws NoSuchJobExecutionException

Throws:

NoSuchJobExecutionException

jobOperatorGetJobExecutions

List<IJobExecution> jobOperatorGetJobExecutions(long jobInstanceId)

jobOperatorGetRunningExecutions

Set<Long> jobOperatorGetRunningExecutions(String jobName)

getJobCurrentTag

String getJobCurrentTag(long jobInstanceId)

purge

void purge(String apptag)

getJobStatusFromExecution

JobStatus getJobStatusFromExecution(long executionId)

getJobInstanceIdByExecutionId

long getJobInstanceIdByExecutionId(long executionId)
                            throws NoSuchJobExecutionException

Throws:

NoSuchJobExecutionException

createJobInstance

JobInstance createJobInstance(String name,
                              String apptag,
                              String jobXml)

Creates a JobIntance

Parameters:

name - the job id from job.xml

apptag - the application tag that owns this job

jobXml - the resolved job xml

Returns:

the job instance

createJobExecution

RuntimeJobExecution createJobExecution(JobInstance jobInstance,
                                       Properties jobParameters,
                                       BatchStatus batchStatus)

Create a JobExecution

Parameters:

jobInstance - the parent job instance

jobParameters - the parent job instance parameters

batchStatus - the current BatchStatus

Returns:

the RuntimeJobExecution class for this JobExecution

createStepExecution

StepExecutionImpl createStepExecution(long jobExecId,
                                      StepContextImpl stepContext)

Create a StepExecution

Parameters:

jobExecId - the parent JobExecution id

stepContext - the step context for this step execution

Returns:

the StepExecution

updateStepExecution

void updateStepExecution(StepContextImpl stepContext)

Update a StepExecution

Parameters:

stepContext - the step context for this step execution

updateWithFinalPartitionAggregateStepExecution

void updateWithFinalPartitionAggregateStepExecution(long rootJobExecutionId,
                                                    StepContextImpl stepContext)

Update a StepExecution for the "top-level" StepExecution of a partitioned step. This will aggregate the metrics from the "partition-level" StepExecution(s), (which by the way are not spec-defined and not accessible through standard, public APIs.)

Parameters:

rootJobExecutionId - the root job execution id

stepContext - the step context for this step execution

createJobStatus

JobStatus createJobStatus(long jobInstanceId)

Create a JobStatus

Parameters:

jobInstanceId - the parent job instance id

Returns:

the JobStatus

getJobStatus

JobStatus getJobStatus(long instanceId)

Get a JobStatus

Parameters:

instanceId - the parent job instance id

Returns:

the JobStatus

updateJobStatus

void updateJobStatus(long instanceId,
                     JobStatus jobStatus)

Update a JobStatus

Parameters:

instanceId - the parent job instance id

jobStatus - the job status to be updated

createStepStatus

StepStatus createStepStatus(long stepExecId)

Create a StepStatus

Parameters:

stepExecId - the parent step execution id

Returns:

the StepStatus

getStepStatus

StepStatus getStepStatus(long instanceId,
                         String stepName)

Get a StepStatus The parent job instance id and this step name from the job xml are used to determine if the current step execution have previously run.

Parameters:

instanceId - the parent job instance id

stepName - the step name

Returns:

the StepStatus

updateStepStatus

void updateStepStatus(long stepExecutionId,
                      StepStatus stepStatus)

Update a StepStatus

Parameters:

stepExecutionId - the parent step execution id

stepStatus - the step status to be updated

getTagName

String getTagName(long jobExecutionId)

Get the application name from an execution id.

Parameters:

jobExecutionId - the job execution id

Returns:

the application name

updateCheckpointData

void updateCheckpointData(CheckpointDataKey key,
                          CheckpointData value)

getCheckpointData

CheckpointData getCheckpointData(CheckpointDataKey key)

createCheckpointData

void createCheckpointData(CheckpointDataKey key,
                          CheckpointData value)

getMostRecentExecutionId

long getMostRecentExecutionId(long jobInstanceId)

createSubJobInstance

JobInstance createSubJobInstance(String name,
                                 String apptag)

createFlowInSplitExecution

RuntimeFlowInSplitExecution createFlowInSplitExecution(JobInstance jobInstance,
                                                       BatchStatus batchStatus)

getStepExecutionByStepExecutionId

StepExecution getStepExecutionByStepExecutionId(long stepExecId)