org.apache.geode.cache30

Class TestCacheWriter<K,V>

java.lang.Object

org.apache.geode.cache30.TestCacheCallback

org.apache.geode.cache30.TestCacheWriter<K,V>

All Implemented Interfaces:

CacheCallback, CacheWriter<K,V>, Declarable

public abstract class TestCacheWriter<K,V>
extends TestCacheCallback
implements CacheWriter<K,V>

A CacheWriter used in testing. Its callback methods are implemented to thrown UnsupportedOperationException unless the user overrides the "2" methods.

Since:

GemFire 3.0

See Also:

TestCacheCallback.wasInvoked()

Field Summary

Fields inherited from class org.apache.geode.cache30.TestCacheCallback

callbackError

Constructor Summary

Constructors

Constructor and Description
TestCacheWriter()

Method Summary

Modifier and Type	Method and Description
void	beforeCreate(EntryEvent<K,V> event) Called before an entry is created.
void	beforeCreate2(EntryEvent<K,V> event)
void	beforeCreate2(EntryEvent<K,V> event, java.lang.Object arg) Causes code that uses the old API to not compile
void	beforeDestroy(EntryEvent<K,V> event) Called before an entry is destroyed.
void	beforeDestroy2(EntryEvent<K,V> event)
void	beforeDestroy2(EntryEvent<K,V> event, java.lang.Object arg)
void	beforeRegionClear(RegionEvent<K,V> event) Called before a region is cleared.
void	beforeRegionDestroy(RegionEvent<K,V> event) Called before a region is destroyed.
void	beforeRegionDestroy2(RegionEvent<K,V> event)
void	beforeRegionDestroy2(RegionEvent<K,V> event, java.lang.Object arg)
void	beforeUpdate(EntryEvent<K,V> event) Called before an entry is updated.
void	beforeUpdate2(EntryEvent<K,V> event)
void	beforeUpdate2(EntryEvent<K,V> event, java.lang.Object arg)

Methods inherited from class org.apache.geode.cache30.TestCacheCallback

close, close2, isClosed, waitForInvocation, waitForInvocation, wasInvoked

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

Constructor Detail

TestCacheWriter

public TestCacheWriter()

Method Detail

beforeUpdate

public void beforeUpdate(EntryEvent<K,V> event)
                  throws CacheWriterException

Description copied from interface: CacheWriter

Called before an entry is updated. The entry update is initiated by a put or a get that causes the loader to update an existing entry. The entry previously existed in the cache where the operation was initiated, although the old value may have been null. The entry being updated may or may not exist in the local cache where the CacheWriter is installed.

Specified by:

beforeUpdate in interface CacheWriter<K,V>

Parameters:

event - an EntryEvent that provides information about the operation in progress

Throws:

CacheWriterException - if thrown will abort the operation in progress, and the exception will be propagated back to caller that initiated the operation

See Also:

Region.put(Object, Object), Region.get(Object)

beforeUpdate2

public void beforeUpdate2(EntryEvent<K,V> event)
                   throws CacheWriterException

Throws:

CacheWriterException

beforeUpdate2

public void beforeUpdate2(EntryEvent<K,V> event,
                          java.lang.Object arg)
                   throws CacheWriterException

Throws:

CacheWriterException

beforeCreate

public void beforeCreate(EntryEvent<K,V> event)
                  throws CacheWriterException

Description copied from interface: CacheWriter

Called before an entry is created. Entry creation is initiated by a create, a put, or a get. The CacheWriter can determine whether this value comes from a get or not by evaluating the Operation's Operation.isLoad() method. The entry being created may already exist in the local cache where this CacheWriter is installed, but it does not yet exist in the cache where the operation was initiated.

Specified by:

beforeCreate in interface CacheWriter<K,V>

Parameters:

event - an EntryEvent that provides information about the operation in progress

Throws:

CacheWriterException - if thrown will abort the operation in progress, and the exception will be propagated back to caller that initiated the operation

See Also:

Region.create(Object, Object), Region.put(Object, Object), Region.get(Object)

beforeCreate2

public void beforeCreate2(EntryEvent<K,V> event)
                   throws CacheWriterException

Throws:

CacheWriterException

beforeCreate2

public void beforeCreate2(EntryEvent<K,V> event,
                          java.lang.Object arg)
                   throws CacheWriterException

Causes code that uses the old API to not compile

Throws:

CacheWriterException

beforeDestroy

public void beforeDestroy(EntryEvent<K,V> event)
                   throws CacheWriterException

Description copied from interface: CacheWriter

Called before an entry is destroyed. The entry being destroyed may or may not exist in the local cache where the CacheWriter is installed. This method is not called as a result of expiration or Region.localDestroy(Object).

Specified by:

beforeDestroy in interface CacheWriter<K,V>

Parameters:

event - an EntryEvent that provides information about the operation in progress

Throws:

CacheWriterException - if thrown will abort the operation in progress, and the exception will be propagated back to caller that initiated the operation

See Also:

Region.destroy(Object)

beforeDestroy2

public void beforeDestroy2(EntryEvent<K,V> event)
                    throws CacheWriterException

Throws:

CacheWriterException

beforeDestroy2

public void beforeDestroy2(EntryEvent<K,V> event,
                           java.lang.Object arg)
                    throws CacheWriterException

Throws:

CacheWriterException

beforeRegionDestroy

public void beforeRegionDestroy(RegionEvent<K,V> event)
                         throws CacheWriterException

Description copied from interface: CacheWriter

Called before a region is destroyed. The CacheWriter will not additionally be called for each entry that is destroyed in the region as a result of a region destroy. If the region's subregions have CacheWriters installed, then they will be called for the cascading subregion destroys. This method is not called as a result of Region.close(), Cache.close(boolean), or Region.localDestroyRegion(). However, the Region.close() method is invoked regardless of whether a region is destroyed locally. A non-local region destroy results in an invocation of CacheWriter.beforeRegionDestroy(org.apache.geode.cache.RegionEvent<K, V>) followed by an invocation of Region.close().

WARNING: This method should not destroy or create any regions itself or a deadlock will occur.

Specified by:

beforeRegionDestroy in interface CacheWriter<K,V>

Parameters:

event - a RegionEvent that provides information about the operation

Throws:

CacheWriterException - if thrown, will abort the operation in progress, and the exception will be propagated back to the caller that initiated the operation

See Also:

Region.destroyRegion()

beforeRegionDestroy2

public void beforeRegionDestroy2(RegionEvent<K,V> event)
                          throws CacheWriterException

Throws:

CacheWriterException

beforeRegionDestroy2

public void beforeRegionDestroy2(RegionEvent<K,V> event,
                                 java.lang.Object arg)
                          throws CacheWriterException

Throws:

CacheWriterException

beforeRegionClear

public void beforeRegionClear(RegionEvent<K,V> event)
                       throws CacheWriterException

Description copied from interface: CacheWriter

Called before a region is cleared. The CacheWriter will not additionally be called for each entry that is cleared in the region as a result of a region clear.

WARNING: This method should not clear/destroy any regions

Specified by:

beforeRegionClear in interface CacheWriter<K,V>

Parameters:

event - a RegionEvent that provides information about the operation

Throws:

CacheWriterException - if thrown, will abort the operation in progress, and the exception will be propagated back to the caller that initiated the operation

See Also:

Region.clear()