PurgeBatchlet (jberet-core 1.3.0.Final API)

java.lang.Object
- org.jberet.repository.PurgeBatchlet

All Implemented Interfaces:

javax.batch.api.Batchlet
```
public class PurgeBatchlet
extends Object
implements javax.batch.api.Batchlet
```
A batchlet that removes unwanted job data, such as step executions, job execution, job instances, etc, based on various criteria specified as batch properties.
Most batch properties in this class work with all types of batch job repositories. Some batch properties are specific to certain type of job repository. For instance, sql and sqlFile only work with jdbc job repository, mongoRemoveQueries only works with MongoDB job repository.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Set<String>`	`batchStatuses` Specifies one or more batch status values separated by comma (,), and job executions whose batch status matches (case sensitive) any of the specified values will be removed.
`protected Set<String>`	`exitStatuses` Specifies one or more exit status values separated by comma (,), and job executions whose exit status matches (case sensitive) any of the specified values will be removed.
`protected javax.batch.runtime.context.JobContext`	`jobContext` Injected job context of the current job execution.
`protected Date`	`jobExecutionEndTimeFrom` Specifies the starting value of the end time of a job execution, and any job executions whose end time is equal to or later than that starting value will be removed.
`protected Date`	`jobExecutionEndTimeTo` Specifies the end value of the end time of a job execution, and any job executions whose end time is equal to or earlier than that end value will be removed.
`protected Long`	`jobExecutionIdFrom` Specifies the starting value of job execution id, and all job executions whose id equals to or is greater than this starting value will be removed.
`protected Set<Long>`	`jobExecutionIds` Specifies one or more job executions ids, and job data for these job executions will be removed.
`protected Long`	`jobExecutionIdTo` Specifies the end value of job execution id, and all job executions whose id equals to or is less than this end value will be removed.
`protected Set<String>`	`jobExecutionsByJobNames` Specifies one or more job names separated by comma (,), and job executions belonging to any of the specified job names will be removed.
`protected Class`	`jobExecutionSelector` Fully-qualified name of a class implementing `org.jberet.repository.JobExecutionSelector`, which gives application flexibility in filtering job execution data.
`protected Boolean`	`keepRunningJobExecutions` Whether or not to keep job data belonging to all running job executions.
`protected String`	`mongoRemoveQueries` One or more MongoDB remove queries delimited by semi-colon (;) for removing certain job data.
`protected Integer`	`numberOfRecentJobExecutionsToKeep` Specifies the number of most recent job executions to keep, and other job executions will be removed.
`protected Set<String>`	`purgeJobsByNames` Specifies one or more job names separated by comma (,), and job information for those job names in the batch runtime will be removed.
`protected String`	`sql` One or more sql statements for removing certain job data.
`protected String`	`sqlFile` Path to the resource file that contains one or more sql statements for removing certain job data.
`protected javax.batch.runtime.context.StepContext`	`stepContext` Injected step context of the current step execution.
`protected Integer`	`withinPastMinutes` Specifies the number of minutes after the end time of a job execution, and any job executions that end within that number of minutes will be removed.

Constructor Summary

Constructors
Constructor and Description

PurgeBatchlet()

Constructors
Constructor and Description
`PurgeBatchlet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected JdbcRepository`	`getJdbcRepository(JobRepository repo)` Gets the `org.jberet.repository.JdbcRepository` from the `org.jberet.repository.JobRepository` passed in, in order to perform operations specific to `org.jberet.repository.JdbcRepository`.
`String`	`process()`
`void`	`stop()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - jobContext
```
@Inject
protected javax.batch.runtime.context.JobContext jobContext
```
    Injected job context of the current job execution.
  - stepContext
```
@Inject
protected javax.batch.runtime.context.StepContext stepContext
```
    Injected step context of the current step execution.
  - sql
```
@Inject
protected String sql
```
    One or more sql statements for removing certain job data. Multiple sql statements are separated by semi-colon (;). This property is only applicable for jdbc job repository.
    
    See Also:
    
    sqlFile
  - sqlFile
```
@Inject
protected String sqlFile
```
    Path to the resource file that contains one or more sql statements for removing certain job data. Multiple sql statements are separated by semi-colon (;). This property is only applicable for jdbc job repository.
    This property is similar to sql, except that the sql statements are in a separate resource file. Therefore, only one of them should be configured in a given step. When both are present, sql property is used and sqlFile is ignored.
    
    See Also:
    
    sql
  - mongoRemoveQueries
```
@Inject
protected String mongoRemoveQueries
```
    One or more MongoDB remove queries delimited by semi-colon (;) for removing certain job data. This property is for MongoDB job repository only. For example,
```
     db.PARTITION_EXECUTION.remove({ STEPEXECUTIONID: { $gt: 100 } });
     db.STEP_EXECUTION.remove({ STEPEXECUTIONID: { $gt: 100 } });
     db.JOB_EXECUTION.remove({ JOBEXECUTIONID: { $gt: 10 } });
     db.JOB_INSTANCE.remove({ JOBINSTANCEID: { $gt: 10 } })
 
```
  - jobExecutionSelector
```
@Inject
protected Class jobExecutionSelector
```
    Fully-qualified name of a class implementing org.jberet.repository.JobExecutionSelector, which gives application flexibility in filtering job execution data.
    If this property is present, other batch properties related to job execution in this class are ignored.
  - keepRunningJobExecutions
```
@Inject
protected Boolean keepRunningJobExecutions
```
    Whether or not to keep job data belonging to all running job executions. If set to true, job data belonging to all running job executions will not be removed (this is the default behavior). If set to false, any running job executions will be treated the same as finished job executions.
  - jobExecutionIds
```
@Inject
protected Set<Long> jobExecutionIds
```
    Specifies one or more job executions ids, and job data for these job executions will be removed. Multiple values are separate by comma (,). For example,
    - 100, 90, 200
    - 100
    - 500, 501, 502
  - numberOfRecentJobExecutionsToKeep
```
@Inject
protected Integer numberOfRecentJobExecutionsToKeep
```
    Specifies the number of most recent job executions to keep, and other job executions will be removed. The order is determined by the job execution id numeric value. For example,
    - 100
    - 10
  - jobExecutionIdFrom
```
@Inject
protected Long jobExecutionIdFrom
```
    Specifies the starting value of job execution id, and all job executions whose id equals to or is greater than this starting value will be removed. This property is typically used along with jobExecutionIdTo to form a range of job execution ids. If jobExecutionIdTo is not specified, the range is up to the maximum job execution id.
    
    See Also:
    
    jobExecutionIdTo
  - jobExecutionIdTo
```
@Inject
protected Long jobExecutionIdTo
```
    Specifies the end value of job execution id, and all job executions whose id equals to or is less than this end value will be removed. This property is typically used along with jobExecutionIdFrom to form a range of job execution ids. If jobExecutionIdFrom is not specified, the range starts from 1.
    
    See Also:
    
    jobExecutionIdFrom
  - withinPastMinutes
```
@Inject
protected Integer withinPastMinutes
```
    Specifies the number of minutes after the end time of a job execution, and any job executions that end within that number of minutes will be removed.
  - jobExecutionEndTimeFrom
```
@Inject
protected Date jobExecutionEndTimeFrom
```
    Specifies the starting value of the end time of a job execution, and any job executions whose end time is equal to or later than that starting value will be removed. This property is typically used along with jobExecutionEndTimeTo to form a range of job execution end time. For example,
    - 05/30/2013 7:03 AM
    - June 09, 2013 7:03:47 AM PDT
    See Also:
    
    jobExecutionEndTimeTo
  - jobExecutionEndTimeTo
```
@Inject
protected Date jobExecutionEndTimeTo
```
    Specifies the end value of the end time of a job execution, and any job executions whose end time is equal to or earlier than that end value will be removed. This property is typically used along with jobExecutionEndTimeFrom to form a range of job execution end time. For example,
    - 05/30/2013 7:03 AM
    - June 09, 2013 7:03:47 AM PDT
    See Also:
    
    jobExecutionEndTimeFrom
  - batchStatuses
```
@Inject
protected Set<String> batchStatuses
```
    Specifies one or more batch status values separated by comma (,), and job executions whose batch status matches (case sensitive) any of the specified values will be removed. For example,
    - FAILED, STOPPED
    - STARTED
  - exitStatuses
```
@Inject
protected Set<String> exitStatuses
```
    Specifies one or more exit status values separated by comma (,), and job executions whose exit status matches (case sensitive) any of the specified values will be removed. For example,
    - fail now, FAIL
    - stop here
  - jobExecutionsByJobNames
```
@Inject
protected Set<String> jobExecutionsByJobNames
```
    Specifies one or more job names separated by comma (,), and job executions belonging to any of the specified job names will be removed. For example,
    - accountingJob1
    - BillingJob1, BillingJob2, survey-job-3
  - purgeJobsByNames
```
@Inject
protected Set<String> purgeJobsByNames
```
    Specifies one or more job names separated by comma (,), and job information for those job names in the batch runtime will be removed. You can also use the wildcard (*) to represent all job names minus the current job (you cannot remove the job information for the current job). Wildcard can only be used as a single value, and may not be combined with other job names.
    For example,
    - *
    - accoutingJob1
    - BillingJob1, BillingJob2, survey-job-3
- Constructor Detail
  - PurgeBatchlet
```
public PurgeBatchlet()
```
- Method Detail
  - process
```
public String process()
               throws Exception
```
    Specified by:
    
    process in interface javax.batch.api.Batchlet
    
    Throws:
    
    Exception
  - stop
```
public void stop()
          throws Exception
```
    Specified by:
    
    stop in interface javax.batch.api.Batchlet
    
    Throws:
    
    Exception
  - getJdbcRepository
```
protected JdbcRepository getJdbcRepository(JobRepository repo)
```
    Gets the org.jberet.repository.JdbcRepository from the org.jberet.repository.JobRepository passed in, in order to perform operations specific to org.jberet.repository.JdbcRepository.
    
    Parameters:
    
    repo - JobRepository
    
    Returns:
    
    org.jberet.repository.JdbcRepository

Class PurgeBatchlet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

jobContext

stepContext

sql

sqlFile

mongoRemoveQueries

jobExecutionSelector

keepRunningJobExecutions

jobExecutionIds

numberOfRecentJobExecutionsToKeep

jobExecutionIdFrom

jobExecutionIdTo

withinPastMinutes

jobExecutionEndTimeFrom

jobExecutionEndTimeTo

batchStatuses

exitStatuses

jobExecutionsByJobNames

purgeJobsByNames

Constructor Detail

PurgeBatchlet

Method Detail

process

stop

getJdbcRepository