SetExternalTaskRetries.java

package org.camunda.bpm.camel.component.externaltasks;

import java.lang.annotation.Target;
import java.lang.annotation.Retention;
import java.lang.annotation.ElementType;
import java.lang.annotation.RetentionPolicy;

/**
 * Annotate an exception by "SetExternalTaskRetries" to force setting
 * Camunda's external task's retry counter to a value given by the annotation.
 * <p>
 * Example:
 * <ul>
 * <li>{@link SetExternalTaskRetries}(retries = -1, relative = true) // the
 * default behavior if no annotation is given
 * <li>{@link SetExternalTaskRetries}(retries = 0) // the force a Camunda
 * incident since the retry counter is 0
 * <li>{@link SetExternalTaskRetries}(retries = 0, relative = true) // don't
 * change the retry counter although an exception is thrown
 * </ul>
 */
@Target(value = { ElementType.TYPE })
@Retention(value = RetentionPolicy.RUNTIME)
public @interface SetExternalTaskRetries {

    public int retries();

    public boolean relative() default false;

}