Package com.ibm.jbatch.container.services

Interface IPersistenceManagerService

    • 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)

      • jobOperatorQueryJobExecutionBatchStatus

        String jobOperatorQueryJobExecutionBatchStatus​(long key)

      • jobOperatorQueryJobExecutionExitStatus

        String jobOperatorQueryJobExecutionExitStatus​(long key)

      • jobOperatorQueryJobExecutionJobInstanceId

        long jobOperatorQueryJobExecutionJobInstanceId​(long executionID)
                                        throws jakarta.batch.operations.NoSuchJobExecutionException
        Throws:
        jakarta.batch.operations.NoSuchJobExecutionException

      • getStepExecutionsForJobExecution

        List<jakarta.batch.runtime.StepExecution> getStepExecutionsForJobExecution​(long execid)

      • getMostRecentStepExecutionsForJobInstance

        Map<String,​jakarta.batch.runtime.StepExecution> getMostRecentStepExecutionsForJobInstance​(long instanceId)

      • updateBatchStatusOnly

        void updateBatchStatusOnly​(long executionId,
                           jakarta.batch.runtime.BatchStatus batchStatus,
                           Timestamp timestamp)

      • markJobStarted

        void markJobStarted​(long key,
                    Timestamp startTS)

      • updateWithFinalExecutionStatusesAndTimestamps

        void updateWithFinalExecutionStatusesAndTimestamps​(long key,
                                                   jakarta.batch.runtime.BatchStatus batchStatus,
                                                   String exitStatus,
                                                   Timestamp updatets)

      • jobOperatorGetJobExecution

        IJobExecution jobOperatorGetJobExecution​(long jobExecutionId)

      • getParameters

        Properties getParameters​(long executionId)
                  throws jakarta.batch.operations.NoSuchJobExecutionException
        Throws:
        jakarta.batch.operations.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 jakarta.batch.operations.NoSuchJobExecutionException
        Throws:
        jakarta.batch.operations.NoSuchJobExecutionException

      • createJobInstance

        jakarta.batch.runtime.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​(jakarta.batch.runtime.JobInstance jobInstance,
                                       Properties jobParameters,
                                       jakarta.batch.runtime.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

      • getMostRecentExecutionId

        long getMostRecentExecutionId​(long jobInstanceId)

      • createSubJobInstance

        jakarta.batch.runtime.JobInstance createSubJobInstance​(String name,
                                                       String apptag)

      • createFlowInSplitExecution

        RuntimeFlowInSplitExecution createFlowInSplitExecution​(jakarta.batch.runtime.JobInstance jobInstance,
                                                       jakarta.batch.runtime.BatchStatus batchStatus)

      • getStepExecutionByStepExecutionId

        jakarta.batch.runtime.StepExecution getStepExecutionByStepExecutionId​(long stepExecId)