Package org.springframework.geode.cache

Class RepositoryAsyncEventListener<T,ID>

java.lang.Object

org.springframework.geode.cache.RepositoryAsyncEventListener<T,ID>

All Implemented Interfaces:

org.apache.geode.cache.asyncqueue.AsyncEventListener, org.apache.geode.cache.CacheCallback, org.apache.geode.cache.Declarable

public class RepositoryAsyncEventListener<T,ID>
extends Object
implements org.apache.geode.cache.asyncqueue.AsyncEventListener

An Apache Geode AsyncEventListener that uses a Spring Data CrudRepository to perform data access operations to a backend, external data source asynchronously, triggered by cache operations.

Since:

1.4.0

See Also:

• Function
• Operation
• AsyncEvent
• AsyncEventListener
• CrudRepository

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RepositoryAsyncEventListener.AbstractAsyncEventOperationRepositoryFunction<T,ID>	RepositoryAsyncEventListener.AbstractAsyncEventOperationRepositoryFunction is an abstract base class implementing the RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction interface to provided a default template implementation of the Function.apply(Object) method.
static class	RepositoryAsyncEventListener.AsyncEventError	RepositoryAsyncEventListener.AsyncEventError is a wrapper class encapsulating the AsyncEvent along with the error that was thrown while processing the event.
static interface	RepositoryAsyncEventListener.AsyncEventErrorHandler	The RepositoryAsyncEventListener.AsyncEventErrorHandler interface is a Function and FunctionalInterface used to handle errors while processing AsyncEvents.
static interface	RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction<T,ID>	The RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction interface is a Function and FunctionalInterface that translates the AsyncEvent Operation into a Spring Data CrudRepository method invocation.
static class	RepositoryAsyncEventListener.CreateUpdateAsyncEventRepositoryFunction<T,ID>	An RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction capable of handling Operation.CREATE and Operation.UPDATE AsyncEvents.
static class	RepositoryAsyncEventListener.RemoveAsyncEventRepositoryFunction<T,ID>	An Function implementation capable of handling Operation.REMOVE AsyncEvents.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final RepositoryAsyncEventListener.AsyncEventErrorHandler	DEFAULT_ASYNC_EVENT_ERROR_HANDLER

Constructor Summary

Constructors

Constructor	Description
RepositoryAsyncEventListener(org.springframework.data.repository.CrudRepository<T,ID> repository)	Constructs a new instance of RepositoryAsyncEventListener initialized with the given Spring Data CrudRepository.

Method Summary

Modifier and Type	Method	Description
protected boolean	doProcessEvents(List<org.apache.geode.cache.asyncqueue.AsyncEvent> events)
protected RepositoryAsyncEventListener.AsyncEventErrorHandler	getAsyncEventErrorHandler()	Gets the configured RepositoryAsyncEventListener.AsyncEventErrorHandler used to handle errors that may occur when this listener is invoked with a batch of AsyncEvents.
long	getFiredCount()	Determines how many times this listener has been fired (triggered) by the GemFire/Geode AEQ system.
protected org.springframework.data.repository.CrudRepository<T,ID>	getRepository()	Gets a reference to the configured Spring Data CrudRepository used by this AsyncEventListener to perform data access operations to a external, backend data source asynchronously when triggered by a cache operation.
protected List<RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction<T,ID>>	getRepositoryFunctions()	Gets a List of RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction objects used to process AsyncEvents passed to this listener by inspecting the Operation on the AsyncEvent and calling the appropriate CrudRepository method.
boolean	hasFired()	Determines whether this listener has (ever) been fired (triggered) by the GemFire/Geode AEQ system.
boolean	hasFiredSinceLastCheck()	Determines whether this listener has been fired (triggered) by the GemFire/Geode AEQ system since the last check.
final boolean	processEvents(List<org.apache.geode.cache.asyncqueue.AsyncEvent> events)	Processes each AsyncEvent in order by first determining whether the AsyncEvent can be processed by this listener and then invokes the appropriate Spring Data CrudRepository data access operation corresponding to the AsyncEvent Operation.
boolean	register(RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction<T,ID> repositoryFunction)	Registers a RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction capable of processing AsyncEvents by Operation and invoking the appropriate Spring Data CrudRepository data access operation.
void	setAsyncEventErrorHandler(RepositoryAsyncEventListener.AsyncEventErrorHandler asyncEventErrorHandler)	Configures an RepositoryAsyncEventListener.AsyncEventErrorHandler to handle errors that may occur when this listener is invoked with a batch of AsyncEvents.
boolean	unregister(RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction<T,ID> repositoryFunction)	Unregisters the given RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction from this listener.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.geode.cache.CacheCallback

close

Methods inherited from interface org.apache.geode.cache.Declarable

init, initialize

Field Details

DEFAULT_ASYNC_EVENT_ERROR_HANDLER

protected static final RepositoryAsyncEventListener.AsyncEventErrorHandler DEFAULT_ASYNC_EVENT_ERROR_HANDLER

Constructor Details

RepositoryAsyncEventListener

public RepositoryAsyncEventListener(@NonNull
 org.springframework.data.repository.CrudRepository<T,ID> repository)

Constructs a new instance of RepositoryAsyncEventListener initialized with the given Spring Data CrudRepository.

Parameters:

repository - Spring Data CrudRepository used to perform data access operations to a backend, external data source when triggered by a cache operation; must not be null.

Throws:

IllegalArgumentException - if CrudRepository is null.

See Also:

• CrudRepository

Method Details

hasFired

public boolean hasFired()

Determines whether this listener has (ever) been fired (triggered) by the GemFire/Geode AEQ system.

Returns:

a boolean value indicating whether this listener has been fired (triggered).

See Also:

• hasFiredSinceLastCheck()

hasFiredSinceLastCheck

public boolean hasFiredSinceLastCheck()

Determines whether this listener has been fired (triggered) by the GemFire/Geode AEQ system since the last check. A call to this method clears the flag.

Returns:

a boolean value indicating whether this listener has been fired (triggered) since the last check.

See Also:

• hasFired()

getFiredCount

public long getFiredCount()

Determines how many times this listener has been fired (triggered) by the GemFire/Geode AEQ system.

Returns:

a Long value indicating how many times this listener has been fired (triggered).

setAsyncEventErrorHandler

public void setAsyncEventErrorHandler(@Nullable
 RepositoryAsyncEventListener.AsyncEventErrorHandler asyncEventErrorHandler)

Configures an RepositoryAsyncEventListener.AsyncEventErrorHandler to handle errors that may occur when this listener is invoked with a batch of AsyncEvents. Since the processing of AsyncEvents is asynchronous, the RepositoryAsyncEventListener.AsyncEventErrorHandler gives users the opportunity to respond to errors for each AsyncEvent as it is is processed given this listener is designed to coordinate data/state changes occurring in an Apache Geode cache with an external data source.

Parameters:

asyncEventErrorHandler - RepositoryAsyncEventListener.AsyncEventErrorHandler used to handle errors while processing the batch of AsyncEvents.

See Also:

• RepositoryAsyncEventListener.AsyncEventErrorHandler

getAsyncEventErrorHandler

@NonNull
protected RepositoryAsyncEventListener.AsyncEventErrorHandler getAsyncEventErrorHandler()

Gets the configured RepositoryAsyncEventListener.AsyncEventErrorHandler used to handle errors that may occur when this listener is invoked with a batch of AsyncEvents. Defaults to an RepositoryAsyncEventListener.AsyncEventErrorHandler that always returns false on any error.

Returns:

the configured RepositoryAsyncEventListener.AsyncEventErrorHandler; never null.

See Also:

• RepositoryAsyncEventListener.AsyncEventErrorHandler

getRepository

@NonNull
protected org.springframework.data.repository.CrudRepository<T,ID> getRepository()

Gets a reference to the configured Spring Data CrudRepository used by this AsyncEventListener to perform data access operations to a external, backend data source asynchronously when triggered by a cache operation.

Returns:

a reference to the configured Spring Data CrudRepository; never null.

See Also:

• CrudRepository

getRepositoryFunctions

@NonNull
protected List<RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction<T,ID>> getRepositoryFunctions()

Gets a List of RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction objects used to process AsyncEvents passed to this listener by inspecting the Operation on the AsyncEvent and calling the appropriate CrudRepository method.

Returns:

a List of RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction objects to process the AsyncEvents; never null.

See Also:

• RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction

processEvents

public final boolean processEvents(List<org.apache.geode.cache.asyncqueue.AsyncEvent> events)

Processes each AsyncEvent in order by first determining whether the AsyncEvent can be processed by this listener and then invokes the appropriate Spring Data CrudRepository data access operation corresponding to the AsyncEvent Operation.

Specified by:

processEvents in interface org.apache.geode.cache.asyncqueue.AsyncEventListener

Parameters:

events - List of AsyncEvents to process.

Returns:

a boolean value indicating whether all AsyncEvents were processed successfully by this listener. If any AsyncEvent fails to be processed (just one), then this method will return false. If any AsyncEvent cannot be handled, then this method will return false, even if other AsyncEvents were successfully processed.

See Also:

• AsyncEvent
• RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction
• getRepositoryFunctions()
• List

doProcessEvents

protected boolean doProcessEvents(List<org.apache.geode.cache.asyncqueue.AsyncEvent> events)

See Also:

• processEvents(List)

register

public boolean register(@NonNull
 RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction<T,ID> repositoryFunction)

Registers a RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction capable of processing AsyncEvents by Operation and invoking the appropriate Spring Data CrudRepository data access operation. AsyncEventOperationRepositoryFunctions can be registered for AsyncEvent Operations not currently handled by this listener. Alternatively, users can override existing AsyncEventOperationRepositoryFunctions provided by this listener to alter the default behavior, or effectively the Spring Data CrudRepository data access operation invoked based on the AsyncEvent Operation. The repositoryFunction arguments are prepended to the List of registered Functions to implement the override, where the first Function found capable of handling the AsyncEvent Operation will be applied.

Parameters:

repositoryFunction - RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction used to process AsyncEvents by Operation invoking the appropriate Spring Data CrudRepository data access operation; must not be null.

Returns:

a boolean value indicating whether the registration was successful.

See Also:

• RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction
• getRepositoryFunctions()

unregister

public boolean unregister(@Nullable
 RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction<T,ID> repositoryFunction)

Unregisters the given RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction from this listener.

Parameters:

repositoryFunction - RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction to unregister.

Returns:

a boolean value indicating whether the un-registration was successful.

See Also:

• RepositoryAsyncEventListener.AsyncEventOperationRepositoryFunction
• getRepositoryFunctions()