com.evento.common.modeling.annotations.component.Saga Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of evento-common Show documentation

Common Library of Object and Algorithms for Evento Framework

The newest version!

package com.evento.common.modeling.annotations.component;

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

/**
 * The Saga annotation is a marker annotation used to designate a class as a Saga within a software system.
 * Sagas are long-running, distributed transactions that coordinate actions across multiple components.
 * This annotation is used in conjunction with the Component annotation to categorize and identify the class as a Saga.
 *
 * 
 * Example usage:
 * 
 *
 *  * {@code
 * @Saga(version = 1, context = {Context.DEFAULT})
 * public class OrderSaga {
 *
 *     private final OrderService orderService;
 *     private final PaymentService paymentService;
 *
 *     public OrderSaga(OrderService orderService, PaymentService paymentService) {
 *         this.orderService = orderService;
 *         this.paymentService = paymentService;
 *     }
 *
 *     @EventHandler
 *     public void on(OrderCreatedEvent event) {
 *         // Handle event logic
 *     }
 *
 *     @EventHandler
 *     public void on(PaymentCompletedEvent event) {
 *         // Handle event logic
 *     }
 * }
 * }
 * 
 *
 * @see com.evento.common.modeling.annotations.handler.EventHandler
 * @see Saga in RECQ Component Pattern
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Component
public @interface Saga {
	/**
	 * Returns the version of the method.
	 *
	 * @return the version of the method
	 */
	int version();
}