org.infinispan.notifications.cachelistener.annotation.DataRehashed Maven / Gradle / Ivy
package org.infinispan.notifications.cachelistener.annotation;
import org.infinispan.configuration.cache.CacheMode;
import org.infinispan.notifications.IncorrectListenerException;
import org.infinispan.notifications.cachelistener.event.DataRehashedEvent;
import org.infinispan.notifications.cachelistener.event.Event;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* This annotation should be used on methods that need to be notified when a rehash starts or ends. This is only fired
* in a {@link CacheMode#DIST_SYNC} or {@link CacheMode#DIST_ASYNC} configured cache.
*
* Methods annotated with this annotation should accept a single parameter, a {@link DataRehashedEvent} otherwise a
* {@link IncorrectListenerException} will be thrown when registering your listener.
*
* Note that methods marked with this annotation will be fired before and after rehashing takes place,
* i.e., your method will be called twice, with {@link Event#isPre()} being set to true as well as false.
*
* Any exceptions thrown by the listener will abort the call. Any other listeners not yet called will not be called,
* and any transactions in progress will be rolled back.
*
* @author Manik Surtani
* @see org.infinispan.notifications.Listener
* @since 5.0
*/
// ensure this annotation is available at runtime.
@Retention(RetentionPolicy.RUNTIME)
// ensure that this annotation is applied to classes.
@Target(ElementType.METHOD)
public @interface DataRehashed {
}