org.springframework.data.gemfire.snapshot

Class SnapshotServiceFactoryBean<K,V>

java.lang.Object

org.springframework.data.gemfire.snapshot.SnapshotServiceFactoryBean<K,V>

All Implemented Interfaces:

EventListener, DisposableBean, FactoryBean<SnapshotServiceFactoryBean.SnapshotServiceAdapter<K,V>>, InitializingBean, ApplicationListener<SnapshotApplicationEvent<K,V>>

public class SnapshotServiceFactoryBean<K,V>
extends Object
implements FactoryBean<SnapshotServiceFactoryBean.SnapshotServiceAdapter<K,V>>, InitializingBean, DisposableBean, ApplicationListener<SnapshotApplicationEvent<K,V>>

The SnapshotServiceFactoryBean class is a Spring FactoryBean used to configure and create an instance of an appropriate GemFire Snapshot Service to perform data import and exports. A CacheSnapshotService is created if the Region is not specified, otherwise a RegionSnapshotService is used based on the configured Region.

Since:

1.7.0

Author:

John Blum

See Also:

DisposableBean, FactoryBean, InitializingBean, ApplicationListener, SnapshotServiceFactoryBean.SnapshotServiceAdapter, CacheSnapshotService, RegionSnapshotService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SnapshotServiceFactoryBean.ArchiveFileFilter The ArchiveFileFilter class is a Java FileFilter implementation accepting any File that is either a JAR file or ZIP file.
protected static class	SnapshotServiceFactoryBean.CacheSnapshotServiceAdapter The CacheSnapshotServiceAdapter is a SnapshotServiceAdapter adapting GemFire's CacheSnapshotService.
protected static class	SnapshotServiceFactoryBean.RegionSnapshotServiceAdapter<K,V> The RegionSnapshotServiceAdapter is a SnapshotServiceAdapter adapting GemFire's RegionSnapshotService.
static class	SnapshotServiceFactoryBean.SnapshotMetadata<K,V> The SnapshotMetadata class encapsulates details of the GemFire Cache or Region data snapshot on either import or export.
static interface	SnapshotServiceFactoryBean.SnapshotServiceAdapter<K,V> The SnapshotServiceAdapter interface is an Adapter adapting both GemFire CacheSnapshotService and RegionSnapshotService to treat them uniformly.
protected static class	SnapshotServiceFactoryBean.SnapshotServiceAdapterSupport<K,V> SnapshotServiceAdapterSupport is an abstract base class for all SnapshotServiceAdapter implementations encapsulating common reusable functionality.

Field Summary

Fields

Modifier and Type	Field and Description
protected static SnapshotServiceFactoryBean.SnapshotMetadata[]	EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
SnapshotServiceFactoryBean()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Constructs and initializes the GemFire Snapshot Service used to take a snapshot of the configured Cache or Region if initialized.
protected SnapshotServiceFactoryBean.SnapshotServiceAdapter	create() Constructs an appropriate instance of the SnapshotServiceAdapter based on the FactoryBean configuration.
void	destroy() Performs an export of the GemFire Cache or Region if configured.
protected org.apache.geode.cache.Cache	getCache() Gets a reference to the GemFire Cache for which the snapshot will be taken.
protected SnapshotServiceFactoryBean.SnapshotMetadata<K,V>[]	getExports() Sets the meta-data (location, filter and format) used to create a snapshot from the Cache or Region data.
protected SnapshotServiceFactoryBean.SnapshotMetadata<K,V>[]	getImports() Gets the meta-data (location, filter and format) used to read a data snapshot into an entire Cache or individual Region.
SnapshotServiceFactoryBean.SnapshotServiceAdapter<K,V>	getObject() Gets the reference to the GemFire Snapshot Service created by this FactoryBean.
Class<?>	getObjectType() Gets the type of Snapshot Service created by this FactoryBean.
protected org.apache.geode.cache.Region<K,V>	getRegion() Gets a reference to the GemFire Region for which the snapshot will be taken.
protected boolean	getSuppressImportOnInit() Determines whether importing on initialization should be suppressed.
protected boolean	isMatch(SnapshotApplicationEvent event) Determines whether the details of the given SnapshotApplicationEvent match the criteria of this factory to trigger a GemFire Cache or Region data export.
boolean	isSingleton() Determines this this FactoryBean creates single GemFire Snapshot Service instances.
void	onApplicationEvent(SnapshotApplicationEvent<K,V> event) Listens for SnapshotApplicationEvents triggering a GemFire Cache-wide or Region data snapshot import/export when details of the event match the criteria of this factory's constructed GemFire SnapshotService.
protected SnapshotServiceFactoryBean.SnapshotMetadata<K,V>[]	resolveSnapshotMetadata(SnapshotApplicationEvent<K,V> event) Resolves the SnapshotMetadata used to perform the GemFire Cache or Region data snapshot import/export.
void	setCache(org.apache.geode.cache.Cache cache) Sets a reference to the GemFire Cache for which the snapshot will be taken.
void	setExports(SnapshotServiceFactoryBean.SnapshotMetadata<K,V>[] exports) Sets the meta-data (location, filter and format) used to create a snapshot from the Cache or Region data.
void	setImports(SnapshotServiceFactoryBean.SnapshotMetadata<K,V>[] imports) Sets the meta-data (location, filter and format) used to read a data snapshot into an entire Cache or individual Region.
void	setRegion(org.apache.geode.cache.Region<K,V> region) Sets a reference to the GemFire Region for which the snapshot will be taken.
void	setSuppressImportOnInit(Boolean suppressImportOnInit) Sets a boolean condition to indicate whether importing on initialization should be suppressed.
protected SnapshotServiceFactoryBean.SnapshotServiceAdapter<Object,Object>	wrap(org.apache.geode.cache.snapshot.CacheSnapshotService cacheSnapshotService) Wraps the GemFire CacheSnapshotService into an appropriate Adapter to uniformly access snapshot operations on the Cache and Regions alike.
protected SnapshotServiceFactoryBean.SnapshotServiceAdapter<K,V>	wrap(org.apache.geode.cache.snapshot.RegionSnapshotService<K,V> regionSnapshotService) Wraps GemFire's RegionSnapshotService into an appropriate Adapter to uniformly access snapshot operations on the Cache and Regions alike.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY

protected static final SnapshotServiceFactoryBean.SnapshotMetadata[] EMPTY_ARRAY

Constructor Detail

SnapshotServiceFactoryBean

public SnapshotServiceFactoryBean()

Method Detail

setCache

public void setCache(org.apache.geode.cache.Cache cache)

Sets a reference to the GemFire Cache for which the snapshot will be taken.

Parameters:

cache - the GemFire Cache used to create an instance of CacheSnapshotService.

Throws:

IllegalArgumentException - if the Cache reference is null.

See Also:

Cache, getCache()

getCache

protected org.apache.geode.cache.Cache getCache()

Gets a reference to the GemFire Cache for which the snapshot will be taken.

Returns:

the GemFire Cache used to create an instance of CacheSnapshotService.

Throws:

IllegalStateException - if the Cache argument is null.

See Also:

Cache, setCache(Cache)

setExports

public void setExports(SnapshotServiceFactoryBean.SnapshotMetadata<K,V>[] exports)

Sets the meta-data (location, filter and format) used to create a snapshot from the Cache or Region data.

Parameters:

exports - an array of snapshot meta-data used for each export.

See Also:

SnapshotServiceFactoryBean.SnapshotMetadata

getExports

protected SnapshotServiceFactoryBean.SnapshotMetadata<K,V>[] getExports()

Sets the meta-data (location, filter and format) used to create a snapshot from the Cache or Region data.

Returns:

an array of snapshot meta-data used for each export.

See Also:

SnapshotServiceFactoryBean.SnapshotMetadata

setImports

public void setImports(SnapshotServiceFactoryBean.SnapshotMetadata<K,V>[] imports)

Sets the meta-data (location, filter and format) used to read a data snapshot into an entire Cache or individual Region.

Parameters:

imports - an array of snapshot meta-data used for each import.

See Also:

SnapshotServiceFactoryBean.SnapshotMetadata

getImports

protected SnapshotServiceFactoryBean.SnapshotMetadata<K,V>[] getImports()

Gets the meta-data (location, filter and format) used to read a data snapshot into an entire Cache or individual Region.

Returns:

an array of snapshot meta-data used for each import.

See Also:

SnapshotServiceFactoryBean.SnapshotMetadata

setRegion

public void setRegion(org.apache.geode.cache.Region<K,V> region)

Sets a reference to the GemFire Region for which the snapshot will be taken.

Parameters:

region - the GemFire Region used to create an instance of the RegionSnapshotService.

See Also:

Region, getRegion()

getRegion

protected org.apache.geode.cache.Region<K,V> getRegion()

Gets a reference to the GemFire Region for which the snapshot will be taken.

Returns:

the GemFire Region used to create an instance of the RegionSnapshotService.

See Also:

Region, getRegion()

setSuppressImportOnInit

public void setSuppressImportOnInit(Boolean suppressImportOnInit)

Sets a boolean condition to indicate whether importing on initialization should be suppressed.

Parameters:

suppressImportOnInit - a Boolean value to indicate whether importing on initialization should be suppressed.

See Also:

getSuppressImportOnInit()

getSuppressImportOnInit

protected boolean getSuppressImportOnInit()

Determines whether importing on initialization should be suppressed.

Returns:

a boolean value indicating whether import on initialization should be suppressed.

See Also:

setSuppressImportOnInit(Boolean), afterPropertiesSet()

getObject

public SnapshotServiceFactoryBean.SnapshotServiceAdapter<K,V> getObject()
                                                                 throws Exception

Gets the reference to the GemFire Snapshot Service created by this FactoryBean.

Specified by:

getObject in interface FactoryBean<SnapshotServiceFactoryBean.SnapshotServiceAdapter<K,V>>

Returns:

the GemFire Snapshot Service created by this FactoryBean.

Throws:

Exception - if the GemFire Snapshot Service failed to be created.

See Also:

SnapshotServiceFactoryBean.SnapshotServiceAdapter

getObjectType

public Class<?> getObjectType()

Gets the type of Snapshot Service created by this FactoryBean.

Specified by:

getObjectType in interface FactoryBean<SnapshotServiceFactoryBean.SnapshotServiceAdapter<K,V>>

Returns:

a Class object representing the type of Snapshot Service created by this FactoryBean.

See Also:

SnapshotServiceFactoryBean.SnapshotServiceAdapter, SnapshotServiceFactoryBean.CacheSnapshotServiceAdapter, SnapshotServiceFactoryBean.RegionSnapshotServiceAdapter

isSingleton

public boolean isSingleton()

Determines this this FactoryBean creates single GemFire Snapshot Service instances.

Specified by:

isSingleton in interface FactoryBean<SnapshotServiceFactoryBean.SnapshotServiceAdapter<K,V>>

Returns:

true.

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Constructs and initializes the GemFire Snapshot Service used to take a snapshot of the configured Cache or Region if initialized. In addition, this initialization method will perform the actual import.

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception - if the construction and initialization of the GemFire Snapshot Service fails.

See Also:

SnapshotServiceFactoryBean.SnapshotServiceAdapter, getSuppressImportOnInit(), getImports(), create()

create

protected SnapshotServiceFactoryBean.SnapshotServiceAdapter create()

Constructs an appropriate instance of the SnapshotServiceAdapter based on the FactoryBean configuration. If a Region has not been specified, then a GemFire Snapshot Service for the Cache is constructed, otherwise the GemFire Snapshot Service for the configured Region is used.

Returns:

a SnapshotServiceAdapter wrapping the appropriate GemFire Snapshot Service (either Cache or Region) depending on the FactoryBean configuration.

See Also:

wrap(CacheSnapshotService), wrap(RegionSnapshotService), getRegion()

wrap

protected SnapshotServiceFactoryBean.SnapshotServiceAdapter<Object,Object> wrap(org.apache.geode.cache.snapshot.CacheSnapshotService cacheSnapshotService)

Wraps the GemFire CacheSnapshotService into an appropriate Adapter to uniformly access snapshot operations on the Cache and Regions alike.

Parameters:

cacheSnapshotService - the GemFire CacheSnapshotService to wrap.

Returns:

a SnapshotServiceAdapter wrapping the GemFire CacheSnapshotService.

See Also:

SnapshotServiceFactoryBean.SnapshotServiceAdapter, SnapshotServiceFactoryBean.CacheSnapshotServiceAdapter, CacheSnapshotService

wrap

protected SnapshotServiceFactoryBean.SnapshotServiceAdapter<K,V> wrap(org.apache.geode.cache.snapshot.RegionSnapshotService<K,V> regionSnapshotService)

Wraps GemFire's RegionSnapshotService into an appropriate Adapter to uniformly access snapshot operations on the Cache and Regions alike.

Parameters:

regionSnapshotService - the GemFire RegionSnapshotService to wrap.

Returns:

a SnapshotServiceAdapter wrapping the GemFire RegionSnapshotService.

See Also:

SnapshotServiceFactoryBean.SnapshotServiceAdapter, SnapshotServiceFactoryBean.RegionSnapshotServiceAdapter, RegionSnapshotService

destroy

public void destroy()
             throws Exception

Performs an export of the GemFire Cache or Region if configured.

Specified by:

destroy in interface DisposableBean

Throws:

Exception - if the Cache/Region data export operation fails.

See Also:

SnapshotServiceFactoryBean.SnapshotServiceAdapter, getExports(), getObject()

onApplicationEvent

public void onApplicationEvent(SnapshotApplicationEvent<K,V> event)

Listens for SnapshotApplicationEvents triggering a GemFire Cache-wide or Region data snapshot import/export when details of the event match the criteria of this factory's constructed GemFire SnapshotService.

Specified by:

onApplicationEvent in interface ApplicationListener<SnapshotApplicationEvent<K,V>>

Parameters:

event - the SnapshotApplicationEvent triggering a GemFire Cache or Region data import/export.

See Also:

SnapshotServiceFactoryBean.SnapshotServiceAdapter, ExportSnapshotApplicationEvent, ImportSnapshotApplicationEvent, SnapshotApplicationEvent, isMatch(SnapshotApplicationEvent), resolveSnapshotMetadata(SnapshotApplicationEvent), getObject()

isMatch

protected boolean isMatch(SnapshotApplicationEvent event)

Determines whether the details of the given SnapshotApplicationEvent match the criteria of this factory to trigger a GemFire Cache or Region data export.

Parameters:

event - the SnapshotApplicationEvent containing details of the application requested data export.

Returns:

a boolean value indicating whether the application requested snapshot event details match the criteria required by this factory to trigger a GemFire Cache or Region data export.

See Also:

SnapshotApplicationEvent

resolveSnapshotMetadata

protected SnapshotServiceFactoryBean.SnapshotMetadata<K,V>[] resolveSnapshotMetadata(SnapshotApplicationEvent<K,V> event)

Resolves the SnapshotMetadata used to perform the GemFire Cache or Region data snapshot import/export. If the event contains specific SnapshotMetadata, then this is preferred over the factory's own "import" or "export" SnapshotMetadata.

Parameters:

event - the SnapshotApplicationEvent from which to resolve the SnapshotMetadata.

Returns:

the resolved SnapshotMetadata, either from the event or this factory's configured imports/exports.

See Also:

SnapshotApplicationEvent.getSnapshotMetadata(), getExports(), getImports()