Package org.infinispan.persistence.jpa

Class JpaStore<K,V>

java.lang.Object

org.infinispan.persistence.jpa.JpaStore<K,V>

All Implemented Interfaces:

Lifecycle, AdvancedCacheLoader<K,V>, AdvancedCacheWriter<K,V>, AdvancedLoadWriteStore<K,V>, CacheLoader<K,V>, CacheWriter<K,V>, ExternalStore<K,V>

public class JpaStore<K,V>
extends java.lang.Object
implements AdvancedLoadWriteStore<K,V>

NOTE: This store can return expired keys or entries on any given operation if JpaStoreConfiguration.storeMetadata() was set to false.

Author:

Ray Tsang

Nested Class Summary

Nested classes/interfaces inherited from interface org.infinispan.persistence.spi.AdvancedCacheLoader

AdvancedCacheLoader.CacheLoaderTask<K,V>, AdvancedCacheLoader.TaskContext

Nested classes/interfaces inherited from interface org.infinispan.persistence.spi.AdvancedCacheWriter

AdvancedCacheWriter.PurgeListener<K>

Constructor Summary

Constructors

Constructor	Description
JpaStore()

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletionStage<java.lang.Void>	bulkUpdate(org.reactivestreams.Publisher<MarshallableEntry<? extends K,? extends V>> publisher)	Persist all provided entries to the store in chunks, with the size of each chunk determined by the store implementation.
void	clear()	Removes all the data from the storage.
boolean	contains(java.lang.Object key)	Returns true if the storage contains an entry associated with the given key.
boolean	delete(java.lang.Object key)
void	deleteBatch(java.lang.Iterable<java.lang.Object> keys)	Remove all provided keys from the store in a single batch operation.
io.reactivex.Flowable<MarshallableEntry<K,V>>	entryPublisher(java.util.function.Predicate<? super K> filter, boolean fetchValue, boolean fetchMetadata)	Publishes all entries from this store.
void	init(InitializationContext ctx)	Used to initialize a cache loader.
protected boolean	isValidKeyType(java.lang.Object key)
MarshallableEntry	loadEntry(java.lang.Object key)	Fetches an entry from the storage.
io.reactivex.Flowable<K>	publishKeys(java.util.function.Predicate<? super K> filter)	Publishes all the keys from this store.
void	purge(java.util.concurrent.Executor threadPool, AdvancedCacheWriter.PurgeListener listener)	Using the thread in the pool, removed all the expired data from the persistence storage.
int	size()	Returns the number of elements in the store.
void	start()	Invoked on component start
void	stop()	Invoked on component stop
void	write(MarshallableEntry entry)	Persists the entry to the storage.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.persistence.spi.AdvancedCacheLoader

process, publishEntries

Methods inherited from interface org.infinispan.persistence.spi.CacheLoader

load

Methods inherited from interface org.infinispan.persistence.spi.CacheWriter

isAvailable, write, writeBatch

Methods inherited from interface org.infinispan.persistence.spi.ExternalStore

destroy, isAvailable

Constructor Detail

JpaStore

public JpaStore()

Method Detail

init

public void init(InitializationContext ctx)

Description copied from interface: CacheLoader

Used to initialize a cache loader. Typically invoked by the PersistenceManager when setting up cache loaders.

Specified by:

init in interface CacheLoader<K,V>

Specified by:

init in interface CacheWriter<K,V>

start

public void start()

Description copied from interface: Lifecycle

Invoked on component start

Specified by:

start in interface Lifecycle

stop

public void stop()

Description copied from interface: Lifecycle

Invoked on component stop

Specified by:

stop in interface Lifecycle

isValidKeyType

protected boolean isValidKeyType(java.lang.Object key)

clear

public void clear()

Description copied from interface: AdvancedCacheWriter

Removes all the data from the storage.

Specified by:

clear in interface AdvancedCacheWriter<K,V>

delete

public boolean delete(java.lang.Object key)

Specified by:

delete in interface CacheWriter<K,V>

Returns:

true if the entry existed in the persistent store and it was deleted.

deleteBatch

public void deleteBatch(java.lang.Iterable<java.lang.Object> keys)

Description copied from interface: CacheWriter

Remove all provided keys from the store in a single batch operation. If this is not supported by the underlying store, then keys are removed from the store individually via CacheWriter.delete(Object).

Specified by:

deleteBatch in interface CacheWriter<K,V>

Parameters:

keys - an Iterable of entry Keys to be removed from the store.

write

public void write(MarshallableEntry entry)

Description copied from interface: CacheWriter

Persists the entry to the storage.

Specified by:

write in interface CacheWriter<K,V>

See Also:

MarshallableEntry

bulkUpdate

public java.util.concurrent.CompletionStage<java.lang.Void> bulkUpdate(org.reactivestreams.Publisher<MarshallableEntry<? extends K,? extends V>> publisher)

Description copied from interface: CacheWriter

Persist all provided entries to the store in chunks, with the size of each chunk determined by the store implementation. If chunking is not supported by the underlying store, then entries are written to the store individually via CacheWriter.write(MarshallableEntry).

Specified by:

bulkUpdate in interface CacheWriter<K,V>

Parameters:

publisher - a Publisher of MarshallableEntry instances

contains

public boolean contains(java.lang.Object key)

Description copied from interface: CacheLoader

Returns true if the storage contains an entry associated with the given key.

Specified by:

contains in interface CacheLoader<K,V>

loadEntry

public MarshallableEntry loadEntry(java.lang.Object key)

Description copied from interface: CacheLoader

Fetches an entry from the storage. If a MarshallableEntry needs to be created here, InitializationContext.getMarshallableEntryFactory() ()} and InitializationContext.getByteBufferFactory() should be used.

Specified by:

loadEntry in interface CacheLoader<K,V>

Returns:

the entry, or null if the entry does not exist

publishKeys

public io.reactivex.Flowable<K> publishKeys(java.util.function.Predicate<? super K> filter)

Description copied from interface: AdvancedCacheLoader

Publishes all the keys from this store. The given publisher can be used by as many Subscribers as desired. Keys are not retrieved until a given Subscriber requests them from the Subscription.

Stores will return only non expired keys

Specified by:

publishKeys in interface AdvancedCacheLoader<K,V>

Parameters:

filter - a filter - null is treated as allowing all entries

Returns:

a publisher that will provide the keys from the store

entryPublisher

public io.reactivex.Flowable<MarshallableEntry<K,V>> entryPublisher(java.util.function.Predicate<? super K> filter,
                                                                          boolean fetchValue,
                                                                          boolean fetchMetadata)

Description copied from interface: AdvancedCacheLoader

Publishes all entries from this store. The given publisher can be used by as many Subscribers as desired. Entries are not retrieved until a given Subscriber requests them from the Subscription.

If fetchMetadata is true this store must guarantee to not return any expired entries.

Specified by:

entryPublisher in interface AdvancedCacheLoader<K,V>

Parameters:

filter - a filter - null is treated as allowing all entries

fetchValue - whether or not to fetch the value from the persistent store. E.g. if the iteration is intended only over the key set, no point fetching the values from the persistent store as well

fetchMetadata - whether or not to fetch the metadata from the persistent store. E.g. if the iteration is intended only ove the key set, then no point fetching the metadata from the persistent store as well

Returns:

a publisher that will provide the entries from the store

size

public int size()

Description copied from interface: AdvancedCacheLoader

Returns the number of elements in the store.

Specified by:

size in interface AdvancedCacheLoader<K,V>

purge

public void purge(java.util.concurrent.Executor threadPool,
                  AdvancedCacheWriter.PurgeListener listener)

Description copied from interface: AdvancedCacheWriter

Using the thread in the pool, removed all the expired data from the persistence storage. For each removed entry, the supplied listener is invoked.

When this method returns all entries will be purged and no tasks will be running due to this loader in the provided executor. If however an exception is thrown there could be tasks still pending or running in the executor.

Specified by:

purge in interface AdvancedCacheWriter<K,V>