A B C D E G I J M N O P R S V W

A

abandon(long) - Method in interface javax.batch.operations.JobOperator

Set batch status to ABANDONED.

AbstractBatchlet - Class in javax.batch.api

The AbstractBatchlet provides default implementations of less commonly implemented methods.

AbstractBatchlet() - Constructor for class javax.batch.api.AbstractBatchlet

AbstractCheckpointAlgorithm - Class in javax.batch.api.chunk

The AbstractCheckpointAlgorithm provides default implementations of optional methods.

AbstractCheckpointAlgorithm() - Constructor for class javax.batch.api.chunk.AbstractCheckpointAlgorithm

AbstractChunkListener - Class in javax.batch.api.chunk.listener

The AbstractChunkListener provides default implementations of less commonly implemented methods.

AbstractChunkListener() - Constructor for class javax.batch.api.chunk.listener.AbstractChunkListener

AbstractItemProcessListener<T,R> - Class in javax.batch.api.chunk.listener

The AbstractItemProcessListener provides default implementations of less commonly implemented methods.

AbstractItemProcessListener() - Constructor for class javax.batch.api.chunk.listener.AbstractItemProcessListener

AbstractItemReader<T> - Class in javax.batch.api.chunk

The AbstractItemReader provides default implementations of less commonly implemented methods.

AbstractItemReader() - Constructor for class javax.batch.api.chunk.AbstractItemReader

AbstractItemReadListener<T> - Class in javax.batch.api.chunk.listener

The AbstractItemReadListener provides default implementations of less commonly implemented methods.

AbstractItemReadListener() - Constructor for class javax.batch.api.chunk.listener.AbstractItemReadListener

AbstractItemWriteListener<T> - Class in javax.batch.api.chunk.listener

The AbstractItemWriteListener provides default implementations of less commonly implemented methods.

AbstractItemWriteListener() - Constructor for class javax.batch.api.chunk.listener.AbstractItemWriteListener

AbstractItemWriter<T> - Class in javax.batch.api.chunk

The AbstractItemWriter provides default implementations of not commonly implemented methods.

AbstractItemWriter() - Constructor for class javax.batch.api.chunk.AbstractItemWriter

AbstractJobListener - Class in javax.batch.api.listener

The AbstractJobListener provides default implementations of less commonly implemented methods.

AbstractJobListener() - Constructor for class javax.batch.api.listener.AbstractJobListener

AbstractPartitionAnalyzer - Class in javax.batch.api.partition

The AbstractPartitionAnalyzer provides default implementations of less commonly implemented methods.

AbstractPartitionAnalyzer() - Constructor for class javax.batch.api.partition.AbstractPartitionAnalyzer

AbstractPartitionReducer - Class in javax.batch.api.partition

The AbstractBatchlet provides default implementations of optional methods.

AbstractPartitionReducer() - Constructor for class javax.batch.api.partition.AbstractPartitionReducer

AbstractStepListener - Class in javax.batch.api.listener

The AbstractStepListener provides default implementations of less commonly implemented methods.

AbstractStepListener() - Constructor for class javax.batch.api.listener.AbstractStepListener

afterChunk() - Method in class javax.batch.api.chunk.listener.AbstractChunkListener

Override this method if the ChunkListener will do something after the chunk ends.

afterChunk() - Method in interface javax.batch.api.chunk.listener.ChunkListener

The afterChunk method receives control after processing of the current chunk ends.

afterJob() - Method in class javax.batch.api.listener.AbstractJobListener

Override this method if the JobListener will do something after the job ends.

afterJob() - Method in interface javax.batch.api.listener.JobListener

The afterJob method receives control after the job execution ends.

afterPartitionedStepCompletion(PartitionReducer.PartitionStatus) - Method in class javax.batch.api.partition.AbstractPartitionReducer

Optional method.

afterPartitionedStepCompletion(PartitionReducer.PartitionStatus) - Method in interface javax.batch.api.partition.PartitionReducer

The afterPartitionedStepCompletion method receives control at the end of a partition processing.

afterProcess(T, R) - Method in class javax.batch.api.chunk.listener.AbstractItemProcessListener

Override this method if the ItemProcessListener will do something after the item is processed.

afterProcess(T, R) - Method in interface javax.batch.api.chunk.listener.ItemProcessListener

The afterProcess method that receives control after an item processor processes an item.

afterRead(T) - Method in class javax.batch.api.chunk.listener.AbstractItemReadListener

Override this method if the ItemReadListener will do something after the item is read.

afterRead(T) - Method in interface javax.batch.api.chunk.listener.ItemReadListener

The afterRead method that receives control after an item reader reads an item.

afterStep() - Method in class javax.batch.api.listener.AbstractStepListener

Override this method if the StepListener will do something after the step ends.

afterStep() - Method in interface javax.batch.api.listener.StepListener

The afterStep method receives control after a step execution ends.

afterWrite(List<T>) - Method in class javax.batch.api.chunk.listener.AbstractItemWriteListener

Override this method if the ItemWriteListener will do something after the items are written.

afterWrite(List<T>) - Method in interface javax.batch.api.chunk.listener.ItemWriteListener

The afterWrite method receives control after an item writer writes its items.

analyzeCollectorData(Serializable) - Method in class javax.batch.api.partition.AbstractPartitionAnalyzer

Override this method to analyze PartitionCollector payloads.

analyzeCollectorData(Serializable) - Method in interface javax.batch.api.partition.PartitionAnalyzer

The analyzeCollectorData method receives control each time a Partition collector sends its payload.

analyzeStatus(JobOperator.BatchStatus, String) - Method in class javax.batch.api.partition.AbstractPartitionAnalyzer

Override this method to analyze partition end status.

analyzeStatus(JobOperator.BatchStatus, String) - Method in interface javax.batch.api.partition.PartitionAnalyzer

The analyzeStatus method receives control each time a partition ends.

B

Batchlet - Interface in javax.batch.api

A batchlet is type of batch step that can be used for any type of background processing that does not explicitly call for a chunk oriented approach.

BatchOperationsRuntimeException - Exception in javax.batch.operations

BatchOperationsRuntimeException(Throwable, String) - Constructor for exception javax.batch.operations.BatchOperationsRuntimeException

BatchOperationsRuntimeException(Throwable) - Constructor for exception javax.batch.operations.BatchOperationsRuntimeException

BatchOperationsRuntimeException(String) - Constructor for exception javax.batch.operations.BatchOperationsRuntimeException

BatchOperationsRuntimeException() - Constructor for exception javax.batch.operations.BatchOperationsRuntimeException

BatchRuntime - Class in javax.batch.runtime

BatchRuntime() - Constructor for class javax.batch.runtime.BatchRuntime

beforeChunk() - Method in class javax.batch.api.chunk.listener.AbstractChunkListener

Override this method if the ChunkListener will do something before the chunk begins.

beforeChunk() - Method in interface javax.batch.api.chunk.listener.ChunkListener

The beforeChunk method receives control before processing of the next chunk begins.

beforeJob() - Method in class javax.batch.api.listener.AbstractJobListener

Override this method if the JobListener will do something before the job begins.

beforeJob() - Method in interface javax.batch.api.listener.JobListener

The beforeJob method receives control before the job execution begins.

beforePartitionedStepCompletion() - Method in class javax.batch.api.partition.AbstractPartitionReducer

Optional method.

beforePartitionedStepCompletion() - Method in interface javax.batch.api.partition.PartitionReducer

The beforePartitionedStepCompletion method receives control at the end of partitioned step processing.

beforeProcess(T) - Method in class javax.batch.api.chunk.listener.AbstractItemProcessListener

Override this method if the ItemProcessListener will do something before the item is processed.

beforeProcess(T) - Method in interface javax.batch.api.chunk.listener.ItemProcessListener

The beforeProcess method that receives control before an item processor is called to process the next item.

beforeRead() - Method in class javax.batch.api.chunk.listener.AbstractItemReadListener

Override this method if the ItemReadListener will do something before the item is read.

beforeRead() - Method in interface javax.batch.api.chunk.listener.ItemReadListener

The beforeRead method that receives control before an item reader is called to read the next item.

beforeStep() - Method in class javax.batch.api.listener.AbstractStepListener

Override this method if the StepListener will do something before the step begins.

beforeStep() - Method in interface javax.batch.api.listener.StepListener

The beforeStep method receives control before a step execution begins.

beforeWrite(List<T>) - Method in class javax.batch.api.chunk.listener.AbstractItemWriteListener

Override this method if the ItemWriteListener will do something before the items are written.

beforeWrite(List<T>) - Method in interface javax.batch.api.chunk.listener.ItemWriteListener

The beforeWrite method receives control before an item writer is called to write its items.

beginCheckpoint() - Method in class javax.batch.api.chunk.AbstractCheckpointAlgorithm

Optional method.

beginCheckpoint() - Method in interface javax.batch.api.chunk.CheckpointAlgorithm

The beginCheckpoint method is invoked before the next checkpoint interval begins.

beginPartitionedStep() - Method in class javax.batch.api.partition.AbstractPartitionReducer

Optional method.

beginPartitionedStep() - Method in interface javax.batch.api.partition.PartitionReducer

The beginPartitionedStep method receives control at the start of partition processing.

C

CheckpointAlgorithm - Interface in javax.batch.api.chunk

CheckpointAlgorithm provides a custom checkpoint policy for chunk steps.

checkpointInfo() - Method in class javax.batch.api.chunk.AbstractItemReader

Override this method if the ItemReader supports checkpoints.

checkpointInfo() - Method in class javax.batch.api.chunk.AbstractItemWriter

Override this method if the ItemWriter supports checkpoints.

checkpointInfo() - Method in interface javax.batch.api.chunk.ItemReader

The checkpointInfo method returns the current checkpoint position for this reader.

checkpointInfo() - Method in interface javax.batch.api.chunk.ItemWriter

The checkpointInfo method returns the current checkpoint position for this writer.

checkpointTimeout() - Method in class javax.batch.api.chunk.AbstractCheckpointAlgorithm

Optional method.

checkpointTimeout() - Method in interface javax.batch.api.chunk.CheckpointAlgorithm

The checkpointTimeout is invoked at the beginning of a new checkpoint interval for the purpose of establishing the checkpoint transaction timeout.

ChunkListener - Interface in javax.batch.api.chunk.listener

ChunkListener intercepts chunk processing.

close() - Method in class javax.batch.api.chunk.AbstractItemReader

Override this method if the ItemReader requires any close time processing.

close() - Method in class javax.batch.api.chunk.AbstractItemWriter

Override this method if the ItemWriter requires any close time processing.

close() - Method in interface javax.batch.api.chunk.ItemReader

The close method marks the end of use of the item stream.

close() - Method in interface javax.batch.api.chunk.ItemWriter

The close method marks the end of use of the item stream.

collectPartitionData() - Method in interface javax.batch.api.partition.PartitionCollector

The collectPartitionData method receives control periodically during partition processing.

D

decide(StepExecution<?>[]) - Method in interface javax.batch.api.Decider

The decide method sets a new exit status for a job.

Decider - Interface in javax.batch.api

A Decider receives control as part of a decision element in a job.

E

endCheckpoint() - Method in class javax.batch.api.chunk.AbstractCheckpointAlgorithm

Optional method.

endCheckpoint() - Method in interface javax.batch.api.chunk.CheckpointAlgorithm

The endCheckpoint method is invoked after the current checkpoint is committed.

G

getBatchStatus() - Method in interface javax.batch.runtime.context.JobContext

The getBatchStatus method simply returns the batch status value * set by the batch runtime into the job context.

getBatchStatus() - Method in interface javax.batch.runtime.context.StepContext

The getBatchStatus method returns the current batch status of the current step.

getBatchStatus() - Method in interface javax.batch.runtime.JobExecution

Get batch status of this execution.

getBatchStatus() - Method in interface javax.batch.runtime.StepExecution

Get batch status of this step execution.

getCause() - Method in exception javax.batch.operations.BatchOperationsRuntimeException

getCreateTime() - Method in interface javax.batch.runtime.JobExecution

Get time execution was created.

getEndTime() - Method in interface javax.batch.runtime.JobExecution

Get time execution entered end status: COMPLETED, STOPPED, FAILED

getEndTime() - Method in interface javax.batch.runtime.StepExecution

Get time this step ended.

getException() - Method in interface javax.batch.runtime.context.StepContext

The getException method returns the last exception thrown from a step level batch artifact to the batch runtime.

getExecutionId() - Method in interface javax.batch.runtime.context.JobContext

The getExecutionId method returns the current job's current execution id.

getExecutionId() - Method in interface javax.batch.runtime.JobExecution

Get unique id for this JobExecution.

getExecutionId() - Method in interface javax.batch.runtime.StepExecution

Get unique id for this StepExecution.

getExitStatus() - Method in interface javax.batch.runtime.context.JobContext

The getExitStatus method simply returns the exit status value stored into the job context through the setExitStatus method or null.

getExitStatus() - Method in interface javax.batch.runtime.context.StepContext

The getExitStatus method simply returns the exit status value stored into the step context through the setExitStatus method or null.

getExitStatus() - Method in interface javax.batch.runtime.JobExecution

Get execution exit status.

getExitStatus() - Method in interface javax.batch.runtime.StepExecution

Get exit status of step.

getInstanceId() - Method in interface javax.batch.runtime.context.JobContext

The getInstanceId method returns the current job's instance id.

getInstanceId() - Method in interface javax.batch.runtime.JobInstance

Get instance id for this job instance

getJobExecution(long) - Method in interface javax.batch.operations.JobOperator

Return job execution for specified execution id

getJobExecutions(JobInstance) - Method in interface javax.batch.operations.JobOperator

Return all job executions belonging to the specified job instance.

getJobInstance(long) - Method in interface javax.batch.operations.JobOperator

Return the job instance for the specified execution id.

getJobInstanceCount(String) - Method in interface javax.batch.operations.JobOperator

Returns number of instances of a job with a particular name.

getJobInstances(String, int, int) - Method in interface javax.batch.operations.JobOperator

Returns all JobInstances belonging to a job with a particular name.

getJobName() - Method in interface javax.batch.runtime.context.JobContext

Get job name

getJobName() - Method in interface javax.batch.runtime.JobExecution

Get job name.

getJobName() - Method in interface javax.batch.runtime.JobInstance

Get job name

getJobNames() - Method in interface javax.batch.operations.JobOperator

Returns a set of all job names known to the batch runtime.

getJobOperator() - Static method in class javax.batch.runtime.BatchRuntime

The getJobOperator factory method returns an instance of the JobOperator interface.

getJobParameters() - Method in interface javax.batch.runtime.JobExecution

Get job parameters for this execution.

getLastUpdatedTime() - Method in interface javax.batch.runtime.JobExecution

Get time execution was last updated updated.

getMessage() - Method in exception javax.batch.operations.BatchOperationsRuntimeException

getMetrics() - Method in interface javax.batch.runtime.context.StepContext

The getMetrics method returns an array of step level metrics.

getMetrics() - Method in interface javax.batch.runtime.StepExecution

Get step metrics

getParameters(long) - Method in interface javax.batch.operations.JobOperator

Returns job parameters for a specified job instance.

getPartitionProperties() - Method in interface javax.batch.api.partition.PartitionPlan

Gets array of Partition Properties objects for Partitions.

getPartitionProperties() - Method in class javax.batch.api.partition.PartitionPlanImpl

getPartitions() - Method in interface javax.batch.api.partition.PartitionPlan

Gets count of Partitions.

getPartitions() - Method in class javax.batch.api.partition.PartitionPlanImpl

getPartitionsOverride() - Method in interface javax.batch.api.partition.PartitionPlan

Return current value of partition override setting.

getPartitionsOverride() - Method in class javax.batch.api.partition.PartitionPlanImpl

getPersistentUserData() - Method in interface javax.batch.runtime.context.StepContext

The getPersistentUserData method returns a persistent data object belonging to the current step.

getProperties() - Method in interface javax.batch.runtime.context.JobContext

The getProperties method returns the job level properties specified in a job definition.

getProperties() - Method in interface javax.batch.runtime.context.StepContext

The getProperties method returns the step level properties specified in a job definition.

getRunningExecutions(String) - Method in interface javax.batch.operations.JobOperator

Returns execution ids for job instances with the specified name that have running executions.

getStartTime() - Method in interface javax.batch.runtime.JobExecution

Get time execution entered STARTED status.

getStartTime() - Method in interface javax.batch.runtime.StepExecution

Get time this step started.

getStepContainment() - Method in interface javax.batch.runtime.StepExecution

Get step containment.

getStepExecutionId() - Method in interface javax.batch.runtime.context.StepContext

The getStepExecutionId method returns the current step's execution id.

getStepExecutions(long) - Method in interface javax.batch.operations.JobOperator

Return StepExecutions for specified execution id.

getStepName() - Method in interface javax.batch.runtime.context.StepContext

Get step name

getStepName() - Method in interface javax.batch.runtime.StepExecution

Get step name.

getThreads() - Method in interface javax.batch.api.partition.PartitionPlan

Gets count of threads.

getThreads() - Method in class javax.batch.api.partition.PartitionPlanImpl

getTransientUserData() - Method in interface javax.batch.runtime.context.JobContext

The getTransientUserData method returns a transient data object belonging to the current Job XML execution element.

getTransientUserData() - Method in interface javax.batch.runtime.context.StepContext

The getTransientUserData method returns a transient data object belonging to the current Job XML execution element.

getType() - Method in interface javax.batch.runtime.Metric

The getName method returns the metric name.

getUserPersistentData() - Method in interface javax.batch.runtime.StepExecution

Get user persistent data

getValue() - Method in interface javax.batch.runtime.Metric

The getValue method returns the metric value.

I

isReadyToCheckpoint() - Method in class javax.batch.api.chunk.AbstractCheckpointAlgorithm

Required method.

isReadyToCheckpoint() - Method in interface javax.batch.api.chunk.CheckpointAlgorithm

The isReadyToCheckpoint method is invoked by the batch runtime after each item read to determine if now is the time to checkpoint the current chunk.

ItemProcessListener<T,R> - Interface in javax.batch.api.chunk.listener

ItemProcessListener intercepts item processing.

ItemProcessor<T,R> - Interface in javax.batch.api.chunk

ItemProcessor is used in chunk processing to operate on an input item and produce an output item.

ItemReader<T> - Interface in javax.batch.api.chunk

ItemReader defines the batch artifact that reads from a stream of item for chunk processing.

ItemReadListener<T> - Interface in javax.batch.api.chunk.listener

ItemReadListener intercepts item reader processing.

ItemWriteListener<T> - Interface in javax.batch.api.chunk.listener

ItemWriteListener intercepts item writer processing.

ItemWriter<T> - Interface in javax.batch.api.chunk

J

javax.batch.api - package javax.batch.api

javax.batch.api.chunk - package javax.batch.api.chunk

javax.batch.api.chunk.listener - package javax.batch.api.chunk.listener

javax.batch.api.listener - package javax.batch.api.listener

javax.batch.api.partition - package javax.batch.api.partition

javax.batch.operations - package javax.batch.operations

javax.batch.runtime - package javax.batch.runtime

javax.batch.runtime.context - package javax.batch.runtime.context

JobContext<T> - Interface in javax.batch.runtime.context

JobExecution - Interface in javax.batch.runtime

JobExecutionAlreadyCompleteException - Exception in javax.batch.operations

JobExecutionAlreadyCompleteException(Throwable, String) - Constructor for exception javax.batch.operations.JobExecutionAlreadyCompleteException

JobExecutionAlreadyCompleteException(Throwable) - Constructor for exception javax.batch.operations.JobExecutionAlreadyCompleteException

JobExecutionAlreadyCompleteException(String) - Constructor for exception javax.batch.operations.JobExecutionAlreadyCompleteException

JobExecutionAlreadyCompleteException() - Constructor for exception javax.batch.operations.JobExecutionAlreadyCompleteException

JobExecutionIsRunningException - Exception in javax.batch.operations

JobExecutionIsRunningException(Throwable, String) - Constructor for exception javax.batch.operations.JobExecutionIsRunningException

JobExecutionIsRunningException(String) - Constructor for exception javax.batch.operations.JobExecutionIsRunningException

JobExecutionIsRunningException(Throwable) - Constructor for exception javax.batch.operations.JobExecutionIsRunningException

JobExecutionIsRunningException() - Constructor for exception javax.batch.operations.JobExecutionIsRunningException

JobExecutionNotMostRecentException - Exception in javax.batch.operations

JobExecutionNotMostRecentException(Throwable, String) - Constructor for exception javax.batch.operations.JobExecutionNotMostRecentException

JobExecutionNotMostRecentException(String) - Constructor for exception javax.batch.operations.JobExecutionNotMostRecentException

JobExecutionNotMostRecentException(Throwable) - Constructor for exception javax.batch.operations.JobExecutionNotMostRecentException

JobExecutionNotMostRecentException() - Constructor for exception javax.batch.operations.JobExecutionNotMostRecentException

JobExecutionNotRunningException - Exception in javax.batch.operations

JobExecutionNotRunningException(Throwable, String) - Constructor for exception javax.batch.operations.JobExecutionNotRunningException

JobExecutionNotRunningException(String) - Constructor for exception javax.batch.operations.JobExecutionNotRunningException

JobExecutionNotRunningException(Throwable) - Constructor for exception javax.batch.operations.JobExecutionNotRunningException

JobExecutionNotRunningException() - Constructor for exception javax.batch.operations.JobExecutionNotRunningException

JobInstance - Interface in javax.batch.runtime

JobListener - Interface in javax.batch.api.listener

JobListener intercepts job execution.

JobOperator - Interface in javax.batch.operations

JobOperator provides the interface for operating on batch jobs.

JobOperator.BatchStatus - Enum in javax.batch.operations

BatchStatus enum defines the batch status values possible for a job.

JobRestartException - Exception in javax.batch.operations

JobRestartException() - Constructor for exception javax.batch.operations.JobRestartException

JobRestartException is thrown when an error occurs during the JobOperator restart operation.

JobRestartException(String) - Constructor for exception javax.batch.operations.JobRestartException

JobRestartException(Throwable) - Constructor for exception javax.batch.operations.JobRestartException

JobRestartException(String, Throwable) - Constructor for exception javax.batch.operations.JobRestartException

JobSecurityException - Exception in javax.batch.operations

JobSecurityException() - Constructor for exception javax.batch.operations.JobSecurityException

SecurityException is thrown when an user is not authorized to run a JobOperator method, such as restart, stop, abandon, any getters, etc

JobSecurityException(String) - Constructor for exception javax.batch.operations.JobSecurityException

JobSecurityException(Throwable) - Constructor for exception javax.batch.operations.JobSecurityException

JobSecurityException(String, Throwable) - Constructor for exception javax.batch.operations.JobSecurityException

JobStartException - Exception in javax.batch.operations

JobStartException() - Constructor for exception javax.batch.operations.JobStartException

JobStartException is thrown when an error occurs during the JobOperator start operation.

JobStartException(String) - Constructor for exception javax.batch.operations.JobStartException

JobStartException(Throwable) - Constructor for exception javax.batch.operations.JobStartException

JobStartException(String, Throwable) - Constructor for exception javax.batch.operations.JobStartException

M

mapPartitions() - Method in interface javax.batch.api.partition.PartitionMapper

The mapPartitions method that receives control at the start of partitioned step processing.

Metric - Interface in javax.batch.runtime

The Metric interface defines job metrics recorded by the batch runtime.

Metric.MetricType - Enum in javax.batch.runtime

N

NoSuchJobException - Exception in javax.batch.operations

NoSuchJobException(Throwable, String) - Constructor for exception javax.batch.operations.NoSuchJobException

NoSuchJobException(String) - Constructor for exception javax.batch.operations.NoSuchJobException

NoSuchJobException(Throwable) - Constructor for exception javax.batch.operations.NoSuchJobException

NoSuchJobException() - Constructor for exception javax.batch.operations.NoSuchJobException

NoSuchJobExecutionException - Exception in javax.batch.operations

NoSuchJobExecutionException(Throwable, String) - Constructor for exception javax.batch.operations.NoSuchJobExecutionException

NoSuchJobExecutionException(String) - Constructor for exception javax.batch.operations.NoSuchJobExecutionException

NoSuchJobExecutionException(Throwable) - Constructor for exception javax.batch.operations.NoSuchJobExecutionException

NoSuchJobExecutionException() - Constructor for exception javax.batch.operations.NoSuchJobExecutionException

NoSuchJobInstanceException - Exception in javax.batch.operations

NoSuchJobInstanceException(Throwable, String) - Constructor for exception javax.batch.operations.NoSuchJobInstanceException

NoSuchJobInstanceException(String) - Constructor for exception javax.batch.operations.NoSuchJobInstanceException

NoSuchJobInstanceException(Throwable) - Constructor for exception javax.batch.operations.NoSuchJobInstanceException

NoSuchJobInstanceException() - Constructor for exception javax.batch.operations.NoSuchJobInstanceException

O

onError() - Method in class javax.batch.api.chunk.listener.AbstractChunkListener

Override this method if the ChunkListener will do something before the chunk transaction is rolled back.

onError() - Method in interface javax.batch.api.chunk.listener.ChunkListener

The onError method receives control before the chunk transaction is rolled back.

onProcessError(T, Exception) - Method in class javax.batch.api.chunk.listener.AbstractItemProcessListener

Override this method if the ItemProcessListener will do something when the ItemProcessor processItem method throws an exception.

onProcessError(T, Exception) - Method in interface javax.batch.api.chunk.listener.ItemProcessListener

The onProcessError a method that receives control after an item processor throws an exception.

onReadError(Exception) - Method in class javax.batch.api.chunk.listener.AbstractItemReadListener

Override this method if the ItemReadListener will do something when the ItemReader readItem method throws an exception.

onReadError(Exception) - Method in interface javax.batch.api.chunk.listener.ItemReadListener

The onReadError method that receives control after an item reader throws an exception.

onRetryProcessException(T, Exception) - Method in interface javax.batch.api.chunk.listener.RetryProcessListener

The onRetryProcessException method receives control when a retryable exception is thrown from an ItemProcessor processItem method.

onRetryReadException(Exception) - Method in interface javax.batch.api.chunk.listener.RetryReadListener

The onRetryReadException method receives control when a retryable exception is thrown from an ItemReader readItem method.

onRetryWriteException(List<T>, Exception) - Method in interface javax.batch.api.chunk.listener.RetryWriteListener

The onRetryWriteException method receives control when a retryable exception is thrown from an ItemWriter writeItems method.

onSkipProcessItem(T, Exception) - Method in interface javax.batch.api.chunk.listener.SkipProcessListener

The onSkipProcessItem method receives control when a skippable exception is thrown from an ItemProcess processItem method.

onSkipReadItem(Exception) - Method in interface javax.batch.api.chunk.listener.SkipReadListener

The onSkipReadItem method receives control when a skippable exception is thrown from an ItemReader readItem method.

onSkipWriteItem(List<T>, Exception) - Method in interface javax.batch.api.chunk.listener.SkipWriteListener

The onSkipWriteItems method receives control when a skippable exception is thrown from an ItemWriter writeItems method.

onWriteError(List<T>, Exception) - Method in class javax.batch.api.chunk.listener.AbstractItemWriteListener

Override this method if the ItemWriteListener will do something when the ItemWriter writeItems method throws an exception.

onWriteError(List<T>, Exception) - Method in interface javax.batch.api.chunk.listener.ItemWriteListener

The onWriteError method receives control after an item writer writeItems throws an exception.

open(Serializable) - Method in class javax.batch.api.chunk.AbstractItemReader

* Override this method if the ItemReader requires any open time processing.

open(Serializable) - Method in class javax.batch.api.chunk.AbstractItemWriter

Override this method if the ItemWriter requires any open time processing.

open(Serializable) - Method in interface javax.batch.api.chunk.ItemReader

The open method prepare the reader to read items.

open(Serializable) - Method in interface javax.batch.api.chunk.ItemWriter

The open method prepare the writer to write items.

P

PartitionAnalyzer - Interface in javax.batch.api.partition

PartitionAnalyzer receives control to process data and final results from each partitions.

PartitionCollector - Interface in javax.batch.api.partition

PartitionCollector provides a way to pass data from individual partitions to a single point of control running on the parent thread.

PartitionMapper - Interface in javax.batch.api.partition

PartitionMapper receives control at the start of a partitioned execution.

PartitionPlan - Interface in javax.batch.api.partition

PartitionPlanImpl - Class in javax.batch.api.partition

The PartitionPlanImpl class provides a basic implementation of the PartitionPlan interface.

PartitionPlanImpl() - Constructor for class javax.batch.api.partition.PartitionPlanImpl

PartitionReducer - Interface in javax.batch.api.partition

PartitionReducer provides unit of work demarcation across partitions.

PartitionReducer.PartitionStatus - Enum in javax.batch.api.partition

process() - Method in class javax.batch.api.AbstractBatchlet

Implement process logic for the Batchlet in this method.

process() - Method in interface javax.batch.api.Batchlet

The process method does the work of the batchlet.

processItem(T) - Method in interface javax.batch.api.chunk.ItemProcessor

The processItem method is part of a chunk step.

R

readItem() - Method in class javax.batch.api.chunk.AbstractItemReader

Implement read logic for the ItemReader in this method.

readItem() - Method in interface javax.batch.api.chunk.ItemReader

The readitem method returns the next item from the stream.

restart(long, Properties) - Method in interface javax.batch.operations.JobOperator

Restarts a failed or stopped job instance.

RetryProcessListener<T> - Interface in javax.batch.api.chunk.listener

RetryProcessListener intercepts retry processing for an ItemProcessor.

RetryReadListener<T> - Interface in javax.batch.api.chunk.listener

RetryReadListener intercepts retry processing for an ItemReader.

RetryWriteListener<T> - Interface in javax.batch.api.chunk.listener

RetryWriteListener intercepts retry processing for an ItemWriter.

rollbackPartitionedStep() - Method in class javax.batch.api.partition.AbstractPartitionReducer

Optional method.

rollbackPartitionedStep() - Method in interface javax.batch.api.partition.PartitionReducer

The rollbackPartitionedStep method receives control if the runtime is rolling back a partitioned step.

S

setCause(Throwable) - Method in exception javax.batch.operations.BatchOperationsRuntimeException

setExitStatus(String) - Method in interface javax.batch.runtime.context.JobContext

The setExitStatus method assigns the user-specified exit status for the current job.

setExitStatus(String) - Method in interface javax.batch.runtime.context.StepContext

The setExitStatus method assigns the user-specified exit status for the current step.

setMessage(String) - Method in exception javax.batch.operations.BatchOperationsRuntimeException

setPartitionProperties(Properties[]) - Method in interface javax.batch.api.partition.PartitionPlan

Sets array of substitution Properties objects for the set of Partitions.

setPartitionProperties(Properties[]) - Method in class javax.batch.api.partition.PartitionPlanImpl

setPartitions(int) - Method in interface javax.batch.api.partition.PartitionPlan

Set number of partitions.

setPartitions(int) - Method in class javax.batch.api.partition.PartitionPlanImpl

setPartitionsOverride(boolean) - Method in interface javax.batch.api.partition.PartitionPlan

Specify whether or not to override the partition count from the previous job execution.

setPartitionsOverride(boolean) - Method in class javax.batch.api.partition.PartitionPlanImpl

setPersistentUserData(P) - Method in interface javax.batch.runtime.context.StepContext

The setPersistentUserData method stores a persistent data object into the current step.

setThreads(int) - Method in interface javax.batch.api.partition.PartitionPlan

Set number of threads.

setThreads(int) - Method in class javax.batch.api.partition.PartitionPlanImpl

setTransientUserData(T) - Method in interface javax.batch.runtime.context.JobContext

The setTransientUserData method stores a transient data object into the current batch context.

setTransientUserData(T) - Method in interface javax.batch.runtime.context.StepContext

The setTransientUserData method stores a transient data object into the current batch context.

SkipProcessListener<T> - Interface in javax.batch.api.chunk.listener

SkipProcessListener intercepts skippable itemProcess exception handling.

SkipReadListener - Interface in javax.batch.api.chunk.listener

SkipReadListener intercepts skippable itemReader exception handling.

SkipWriteListener<T> - Interface in javax.batch.api.chunk.listener

SkipWriteListener intercepts skippable itemWriter exception handling.

start(String, Properties) - Method in interface javax.batch.operations.JobOperator

Creates a new job instance and starts the first execution of that instance.

StepContext<T,P extends Serializable> - Interface in javax.batch.runtime.context

StepExecution<P extends Serializable> - Interface in javax.batch.runtime

StepListener - Interface in javax.batch.api.listener

StepListener intercepts step execution.

stop() - Method in class javax.batch.api.AbstractBatchlet

Override this method if the Batchlet will end in response to the JobOperator.stop() operation.

stop() - Method in interface javax.batch.api.Batchlet

The stop method is invoked by the batch runtime as part of JobOperator.stop() method processing.

stop(long) - Method in interface javax.batch.operations.JobOperator

Request a running job execution stops.

V

valueOf(String) - Static method in enum javax.batch.api.partition.PartitionReducer.PartitionStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum javax.batch.operations.JobOperator.BatchStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum javax.batch.runtime.Metric.MetricType

Returns the enum constant of this type with the specified name.

values() - Static method in enum javax.batch.api.partition.PartitionReducer.PartitionStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum javax.batch.operations.JobOperator.BatchStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum javax.batch.runtime.Metric.MetricType

Returns an array containing the constants of this enum type, in the order they are declared.

W

writeItems(List<T>) - Method in class javax.batch.api.chunk.AbstractItemWriter

Implement write logic for the ItemWriter in this method.

writeItems(List<T>) - Method in interface javax.batch.api.chunk.ItemWriter

The writeItems method writes a list of item for the current chunk to the item writer stream.

A B C D E G I J M N O P R S V W