Skip to content

Register a Tasks

Spring Persistent Task Interface

RunningTriggerContextHolder @since v1.6

Allows the access to the state object and gives more information about the currently executed trigger.

Simple Closure

TaskId will be the method name.

1
2
3
4
5
6
@Bean
PersistentTask<String> task1() {
    return (String state) -> {
        // DO STUFF
    };
}

Define a closure which has a transactional workload

This closure will be wrapped in the default TransactionTemplate

1
2
3
4
5
6
7
@Bean("transactionalClosure")
TransactionalTask<String> transactionalClosure(PersonRepository personRepository) {
    return name -> {
        personRepository.save(new PersonBE(name + "foo"));
        personRepository.save(new PersonBE(name + "bar"));
    };
}

Override the interface

TaskId will be the method name.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
@Bean
PersistentTask<String> task2() {
    return new PersistentTask<String>() {
        @Override
        public void accept(String state) {
            // DO STUFF
        }
        // gives you access to more customizations
        @Override
        public RetryStrategy retryStrategy() {
            return RetryStrategy.NO_RETRY;
        }
    };
}

Define a Bean class

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
@Component(BuildVehicleTask.NAME)
@RequiredArgsConstructor
@Slf4j
public class BuildVehicleTask implements PersistentTask<Vehicle> {

    private static final String NAME = "buildVehicleTask";
    public static final TaskId<Vehicle> ID = new TaskId<>(NAME);

    private final VehicleRepository vehicleRepository;

    @Override
    public void accept(Vehicle vehicle) {
        // do stuff
        // save
        vehicleRepository.save(vehicle);
    }
    // OPTIONAL
    @Override
    public RetryStrategy retryStrategy() {
        // run 5 times, multiply the execution count with 4, add the result in HOURS to now.
        return new MultiplicativeRetryStrategy(5, ChronoUnit.HOURS, 4);
    }
    // OPTIONAL
    // if the task in accept requires a DB transaction, join them together with the framework
    // if true the TransactionTemplate is used. Set here any timeouts.
    @Override
    public boolean isTransactional() {
        return true;
    }
}