org.hibernate.cache.spi

Interface TimestampsCache

All Superinterfaces:

UpdateTimestampsCache

All Known Implementing Classes:

TimestampsCacheDisabledImpl, TimestampsCacheEnabledImpl

public interface TimestampsCache
extends UpdateTimestampsCache

Wrapper for a TimestampsRegion adding handling of stale results

Author:

Steve Ebersole

Method Summary

Modifier and Type	Method and Description
default void	clear() Clear the update-timestamps data.
default void	destroy() Destroys the cache.
TimestampsRegion	getRegion() The region used to store all timestamps data
default void	invalidate(Serializable[] spaces, SharedSessionContractImplementor session) Perform invalidation.
void	invalidate(String[] spaces, SharedSessionContractImplementor session) Perform invalidation of the passed spaces (table names) against the timestamps region data
default boolean	isUpToDate(Set<Serializable> spaces, Long timestamp, SharedSessionContractImplementor session) Perform an up-to-date check for the given set of query spaces.
boolean	isUpToDate(String[] spaces, Long timestamp, SharedSessionContractImplementor session) Perform an up-to-date check for the given set of query spaces as part of verifying the validity of cached query results.
default void	preInvalidate(Serializable[] spaces, SharedSessionContractImplementor session) Perform pre-invalidation.
void	preInvalidate(String[] spaces, SharedSessionContractImplementor session) Perform pre-invalidation of the passed spaces (table names) against the timestamps region data

Method Detail

getRegion

TimestampsRegion getRegion()

The region used to store all timestamps data

Specified by:

getRegion in interface UpdateTimestampsCache

Returns:

The underlying region.

preInvalidate

void preInvalidate(String[] spaces,
                   SharedSessionContractImplementor session)

Perform pre-invalidation of the passed spaces (table names) against the timestamps region data

invalidate

void invalidate(String[] spaces,
                SharedSessionContractImplementor session)

Perform invalidation of the passed spaces (table names) against the timestamps region data

isUpToDate

boolean isUpToDate(String[] spaces,
                   Long timestamp,
                   SharedSessionContractImplementor session)

Perform an up-to-date check for the given set of query spaces as part of verifying the validity of cached query results.

Parameters:

spaces - The spaces to check

timestamp - The timestamp from the transaction when the query results were cached.

session - The session whether this check originated.

Returns:

Whether all those spaces are up-to-date

preInvalidate

default void preInvalidate(Serializable[] spaces,
                           SharedSessionContractImplementor session)

Description copied from interface: UpdateTimestampsCache

Perform pre-invalidation.

Specified by:

preInvalidate in interface UpdateTimestampsCache

Parameters:

spaces - The spaces to pre-invalidate

invalidate

default void invalidate(Serializable[] spaces,
                        SharedSessionContractImplementor session)

Description copied from interface: UpdateTimestampsCache

Perform invalidation.

Specified by:

invalidate in interface UpdateTimestampsCache

Parameters:

spaces - The spaces to invalidate.

isUpToDate

default boolean isUpToDate(Set<Serializable> spaces,
                           Long timestamp,
                           SharedSessionContractImplementor session)

Description copied from interface: UpdateTimestampsCache

Perform an up-to-date check for the given set of query spaces.

Specified by:

isUpToDate in interface UpdateTimestampsCache

Parameters:

spaces - The spaces to check

timestamp - The timestamp against which to check.

clear

default void clear()
            throws CacheException

Description copied from interface: UpdateTimestampsCache

Clear the update-timestamps data.

Specified by:

clear in interface UpdateTimestampsCache

Throws:

CacheException - Indicates problem delegating call to underlying region.

destroy

default void destroy()

Description copied from interface: UpdateTimestampsCache

Destroys the cache.

Specified by:

destroy in interface UpdateTimestampsCache