org.springframework.geode.data.support

Class LifecycleAwareCacheDataImporterExporter

java.lang.Object

org.springframework.geode.data.support.LifecycleAwareCacheDataImporterExporter

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.config.BeanPostProcessor, org.springframework.beans.factory.config.DestructionAwareBeanPostProcessor, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.EnvironmentAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.ResourceLoaderAware, org.springframework.context.SmartLifecycle, org.springframework.data.gemfire.support.SmartLifecycleSupport, CacheDataExporter, CacheDataImporter, CacheDataImporterExporter

public class LifecycleAwareCacheDataImporterExporter
extends java.lang.Object
implements CacheDataImporterExporter, org.springframework.context.ApplicationContextAware, org.springframework.context.EnvironmentAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ResourceLoaderAware, org.springframework.data.gemfire.support.SmartLifecycleSupport

A CacheDataImporterExporter implementation using the Decorator Software Design Pattern to wrap an existing CacheDataImporterExporter in order to decorate the cache (i.e. Region) data import & export operations, making them Spring ApplicationContext, Environment, Lifecycle, ResourceLoader aware and capable. This wrapper decorates the Apache Geode cache Region data import operation enabling it to be configured eagerly, after the Region bean as been initialized, or lazily, once all beans have been fully initialized and the Spring ApplicationContext is refreshed.

Since:

1.3.0

See Also:

Region, ApplicationContext, ApplicationContextAware, EnvironmentAware, Lifecycle, ResourceLoaderAware, Environment, ResourceLoader, SmartLifecycleSupport, ResourceReader, ResourceResolver, ResourceWriter, CacheDataImporterExporter, ResourceCapableCacheDataImporterExporter.ExportResourceResolver, ResourceCapableCacheDataImporterExporter.ImportResourceResolver, Decorator Software Design Pattern

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LifecycleAwareCacheDataImporterExporter.ImportLifecycle An Enumeration defining the different modes for the cache data import lifecycle.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CACHE_DATA_IMPORT_LIFECYCLE_PROPERTY_NAME
protected static java.lang.String	CACHE_DATA_IMPORT_PHASE_PROPERTY_NAME
protected static int	DEFAULT_IMPORT_PHASE

Fields inherited from interface org.springframework.data.gemfire.support.SmartLifecycleSupport

DEFAULT_AUTO_STARTUP, DEFAULT_IS_RUNNING, DEFAULT_PHASE

Constructor Summary

Constructors

Constructor and Description
LifecycleAwareCacheDataImporterExporter(CacheDataImporterExporter importerExporter) Constructs a new instance of the LifecycleAwareCacheDataImporterExporter initialized with the given, target CacheDataImporterExporter that is wrapped by this implementation to decorate all cache import & export data operations in order to make them Lifecycle aware and capable.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Initializes the wrapped CacheDataImporterExporter if the importer/exporter implements InitializingBean.
org.apache.geode.cache.Region	exportFrom(org.apache.geode.cache.Region region) Exports data contained in the given Region.
protected CacheDataImporterExporter	getCacheDataImporterExporter() Returns a reference to the configured CacheDataImporterExporter wrapped by this Lifecycle aware and capable CacheDataImporterExporter.
protected java.util.Optional<org.springframework.core.env.Environment>	getEnvironment() Returns an Optional reference to the configured Environment used to access configuration for the behavior of the cache data import.
int	getPhase()
org.apache.geode.cache.Region	importInto(org.apache.geode.cache.Region region) Imports data into the given Region.
protected LifecycleAwareCacheDataImporterExporter.ImportLifecycle	resolveImportLifecycle() Resolves the configured LifecycleAwareCacheDataImporterExporter.ImportLifecycle.
protected int	resolveImportPhase() Resolves the configured SmartLifecycle Phase in which the cache data import will be performed.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext) Configures a reference to the Spring ApplicationContext.
void	setEnvironment(org.springframework.core.env.Environment environment) Configures a reference to the Environment used to access configuration for the behavior of the cache data import.
void	setExportResourceResolver(ResourceCapableCacheDataImporterExporter.ExportResourceResolver exportResourceResolver) Configures the ResourceCapableCacheDataImporterExporter.ExportResourceResolver of the wrapped CacheDataImporterExporter if the ResourceCapableCacheDataImporterExporter.ExportResourceResolver is not null and the CacheDataImporterExporter is Resource capable.
void	setImportResourceResolver(ResourceCapableCacheDataImporterExporter.ImportResourceResolver importResourceResolver) Configures the ResourceCapableCacheDataImporterExporter.ImportResourceResolver of the wrapped CacheDataImporterExporter if the ResourceCapableCacheDataImporterExporter.ImportResourceResolver is not null and the CacheDataImporterExporter is Resource capable.
void	setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)
void	setResourceReader(ResourceReader resourceReader) Configures the ResourceReader of the wrapped CacheDataImporterExporter if the ResourceReader is not null and the CacheDataImporterExporter is Resource capable.
void	setResourceWriter(ResourceWriter resourceWriter) Configures the ResourceWriter of the wrapped CacheDataImporterExporter if the ResourceWriter is not null and the CacheDataImporterExporter is Resource capable.
void	start() Performs the cache data import for each of the targeted Regions.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.geode.data.CacheDataExporter

postProcessBeforeDestruction

Methods inherited from interface org.springframework.beans.factory.config.DestructionAwareBeanPostProcessor

requiresDestruction

Methods inherited from interface org.springframework.beans.factory.config.BeanPostProcessor

postProcessAfterInitialization, postProcessBeforeInitialization

Methods inherited from interface org.springframework.geode.data.CacheDataImporter

postProcessAfterInitialization

Methods inherited from interface org.springframework.data.gemfire.support.SmartLifecycleSupport

isAutoStartup, isRunning, stop, stop

Field Detail

DEFAULT_IMPORT_PHASE

protected static final int DEFAULT_IMPORT_PHASE

See Also:

Constant Field Values

CACHE_DATA_IMPORT_LIFECYCLE_PROPERTY_NAME

protected static final java.lang.String CACHE_DATA_IMPORT_LIFECYCLE_PROPERTY_NAME

See Also:

Constant Field Values

CACHE_DATA_IMPORT_PHASE_PROPERTY_NAME

protected static final java.lang.String CACHE_DATA_IMPORT_PHASE_PROPERTY_NAME

See Also:

Constant Field Values

Constructor Detail

LifecycleAwareCacheDataImporterExporter

public LifecycleAwareCacheDataImporterExporter(@NonNull
                                               CacheDataImporterExporter importerExporter)

Constructs a new instance of the LifecycleAwareCacheDataImporterExporter initialized with the given, target CacheDataImporterExporter that is wrapped by this implementation to decorate all cache import & export data operations in order to make them Lifecycle aware and capable.

Parameters:

importerExporter - CacheDataImporterExporter wrapped by this implementation to decorate the cache data import/export operations to be Lifecycle aware and capable; must not be null.

Throws:

java.lang.IllegalArgumentException - if CacheDataImporterExporter is null.

See Also:

CacheDataImporterExporter

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Initializes the wrapped CacheDataImporterExporter if the importer/exporter implements InitializingBean.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception - if CacheDataImporterExporter initialization fails.

setApplicationContext

public void setApplicationContext(@Nullable
                                  org.springframework.context.ApplicationContext applicationContext)

Configures a reference to the Spring ApplicationContext.

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Parameters:

applicationContext - Spring ApplicationContext in which this component operates.

See Also:

ApplicationContext

getCacheDataImporterExporter

@NonNull
protected CacheDataImporterExporter getCacheDataImporterExporter()

Returns a reference to the configured CacheDataImporterExporter wrapped by this Lifecycle aware and capable CacheDataImporterExporter.

Returns:

the CacheDataImporterExporter enhanced and used as the delegate for this Lifecycle aware and capable CacheDataImporterExporter; never null.

setEnvironment

public void setEnvironment(@Nullable
                           org.springframework.core.env.Environment environment)

Configures a reference to the Environment used to access configuration for the behavior of the cache data import.

Specified by:

setEnvironment in interface org.springframework.context.EnvironmentAware

Parameters:

environment - Environment used to access context specific configuration for the cache data import.

See Also:

Environment

getEnvironment

protected java.util.Optional<org.springframework.core.env.Environment> getEnvironment()

Returns an Optional reference to the configured Environment used to access configuration for the behavior of the cache data import. If a reference to Environment was not configured, then this method will return Optional.empty().

Returns:

an Optional reference to the configured Environment, or Optional.empty() if no Environment was configured.

See Also:

Environment, setEnvironment(Environment), Optional

setExportResourceResolver

@Autowired(required=false)
public void setExportResourceResolver(@Nullable
                                                                 ResourceCapableCacheDataImporterExporter.ExportResourceResolver exportResourceResolver)

Configures the ResourceCapableCacheDataImporterExporter.ExportResourceResolver of the wrapped CacheDataImporterExporter if the ResourceCapableCacheDataImporterExporter.ExportResourceResolver is not null and the CacheDataImporterExporter is Resource capable.

Parameters:

exportResourceResolver - ResourceResolver used to resolve a Resource for export.

See Also:

ResourceCapableCacheDataImporterExporter.ExportResourceResolver, getCacheDataImporterExporter()

setImportResourceResolver

@Autowired(required=false)
public void setImportResourceResolver(@Nullable
                                                                 ResourceCapableCacheDataImporterExporter.ImportResourceResolver importResourceResolver)

Configures the ResourceCapableCacheDataImporterExporter.ImportResourceResolver of the wrapped CacheDataImporterExporter if the ResourceCapableCacheDataImporterExporter.ImportResourceResolver is not null and the CacheDataImporterExporter is Resource capable.

Parameters:

importResourceResolver - ResourceResolver used to resolve a Resource for import.

See Also:

ResourceCapableCacheDataImporterExporter.ImportResourceResolver, getCacheDataImporterExporter()

getPhase

public int getPhase()

Specified by:

getPhase in interface org.springframework.context.Phased

Specified by:

getPhase in interface org.springframework.context.SmartLifecycle

Specified by:

getPhase in interface org.springframework.data.gemfire.support.SmartLifecycleSupport

setResourceLoader

public void setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)

Specified by:

setResourceLoader in interface org.springframework.context.ResourceLoaderAware

setResourceReader

@Autowired(required=false)
public void setResourceReader(@Nullable
                                                         ResourceReader resourceReader)

Configures the ResourceReader of the wrapped CacheDataImporterExporter if the ResourceReader is not null and the CacheDataImporterExporter is Resource capable.

Parameters:

resourceReader - ResourceReader used to read data from a Resource on import.

See Also:

ResourceReader, getCacheDataImporterExporter()

setResourceWriter

@Autowired(required=false)
public void setResourceWriter(@Nullable
                                                         ResourceWriter resourceWriter)

Configures the ResourceWriter of the wrapped CacheDataImporterExporter if the ResourceWriter is not null and the CacheDataImporterExporter is Resource capable.

Parameters:

resourceWriter - ResourceWriter used to write data to a Resource on export.

See Also:

ResourceWriter, getCacheDataImporterExporter()

exportFrom

@NonNull
public org.apache.geode.cache.Region exportFrom(@NonNull
                                                         org.apache.geode.cache.Region region)

Description copied from interface: CacheDataExporter

Exports data contained in the given Region.

Specified by:

exportFrom in interface CacheDataExporter

Parameters:

region - Region to export data from.

Returns:

the given Region.

See Also:

Region

importInto

@NonNull
public org.apache.geode.cache.Region importInto(@NonNull
                                                         org.apache.geode.cache.Region region)

Description copied from interface: CacheDataImporter

Imports data into the given Region.

Specified by:

importInto in interface CacheDataImporter

Parameters:

region - Region to import data into.

Returns:

the given Region.

See Also:

Region

resolveImportLifecycle

protected LifecycleAwareCacheDataImporterExporter.ImportLifecycle resolveImportLifecycle()

Resolves the configured LifecycleAwareCacheDataImporterExporter.ImportLifecycle. The cache data import lifecycle is configured with the spring.boot.data.gemfire.cache.data.import.lifecycle property in Spring Boot application.properties.

Returns:

the configured LifecycleAwareCacheDataImporterExporter.ImportLifecycle.

See Also:

LifecycleAwareCacheDataImporterExporter.ImportLifecycle

resolveImportPhase

protected int resolveImportPhase()

Resolves the configured SmartLifecycle Phase in which the cache data import will be performed.

Returns:

the configured SmartLifecycle Phase.

See Also:

getPhase()

start

public void start()

Performs the cache data import for each of the targeted Regions.

Specified by:

start in interface org.springframework.context.Lifecycle

See Also:

getCacheDataImporterExporter(), getRegionsForImport()