Package org.springframework.geode.data.support

Class ResourceCapableCacheDataImporterExporter

java.lang.Object

org.springframework.geode.data.AbstractCacheDataImporterExporter

org.springframework.geode.data.support.ResourceCapableCacheDataImporterExporter

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.ResourceLoaderAware, CacheDataExporter, CacheDataImporter, CacheDataImporterExporter

Direct Known Subclasses:

JsonCacheDataImporterExporter

public abstract class ResourceCapableCacheDataImporterExporter
extends AbstractCacheDataImporterExporter
implements org.springframework.beans.factory.InitializingBean, org.springframework.context.ResourceLoaderAware

An AbstractCacheDataImporterExporter extension and implementation capable of handling and managing import and export Resources.

Since:

1.3.1

See Also:

• File
• GemFireCache
• Region
• InitializingBean
• ApplicationContext
• ConfigurableApplicationContext
• ResourceLoaderAware
• Expression
• ExpressionParser
• SpelParserConfiguration
• SpelExpressionParser
• Resource
• ResourceLoader
• ResourceReader
• ResourceResolver
• ResourceWriter
• AbstractCacheDataImporterExporter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ResourceCapableCacheDataImporterExporter.AbstractCacheResourceResolver	Abstract base class containing functionality common to all cache based ResourceResolvers, whether for import or export.
static class	ResourceCapableCacheDataImporterExporter.AbstractExportResourceResolver	Abstract base class extended by export ResourceCapableCacheDataImporterExporter.CacheResourceResolver implementations, providing a template to resolve the Resource used for export.
static class	ResourceCapableCacheDataImporterExporter.AbstractImportResourceResolver	Abstract base class extended by import ResourceResolver implementations, providing a template to resolve the Resource to import.
protected static interface	ResourceCapableCacheDataImporterExporter.CacheResourceResolver	ResourceResolver interface extension used to resolve cache Resources.
static class	ResourceCapableCacheDataImporterExporter.ClassPathImportResourceResolver	Resolves the Resource to import from the classpath.
static interface	ResourceCapableCacheDataImporterExporter.ExportResourceResolver	Marker interface extending ResourceCapableCacheDataImporterExporter.CacheResourceResolver for cache data exports.
static class	ResourceCapableCacheDataImporterExporter.FileSystemExportResourceResolver	Resolves the Resource used for export from the filesystem.
static interface	ResourceCapableCacheDataImporterExporter.ImportResourceResolver	Marker interface extending ResourceCapableCacheDataImporterExporter.CacheResourceResolver for cache data imports.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CACHE_DATA_EXPORT_RESOURCE_LOCATION_PROPERTY_NAME
protected static final String	CACHE_DATA_IMPORT_RESOURCE_LOCATION_PROPERTY_NAME
protected static final String	RESOURCE_NAME_PATTERN

Fields inherited from class org.springframework.geode.data.AbstractCacheDataImporterExporter

CACHE_DATA_EXPORT_ENABLED_PROPERTY_NAME, CACHE_DATA_IMPORT_ACTIVE_PROFILES_PROPERTY_NAME, CACHE_DATA_IMPORT_ENABLED_PROPERTY_NAME, DEFAULT_CACHE_DATA_EXPORT_ENABLED, DEFAULT_CACHE_DATA_IMPORT_ACTIVE_PROFILES, DEFAULT_CACHE_DATA_IMPORT_ENABLED

Constructor Summary

Constructors

Constructor	Description
ResourceCapableCacheDataImporterExporter()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()	Initializes the export and import ResourceResolvers as needed along with the reader and writer for the Resource used on import and export.
protected ResourceCapableCacheDataImporterExporter.ExportResourceResolver	getExportResourceResolver()	Gets the configured reference to the ResourceCapableCacheDataImporterExporter.ExportResourceResolver.
protected ResourceCapableCacheDataImporterExporter.ImportResourceResolver	getImportResourceResolver()	Gets the configured reference to the ResourceCapableCacheDataImporterExporter.ImportResourceResolver.
protected Optional<org.springframework.core.io.ResourceLoader>	getResourceLoader()	Returns an Optional reference to the configured ResourceLoader used to load Resources.
protected ResourceReader	getResourceReader()	Gets the configured ResourceReader used to read data from a Resource on import.
protected ResourceWriter	getResourceWriter()	Gets the configured ResourceWriter used to write data to the Resource on export.
void	setExportResourceResolver(ResourceCapableCacheDataImporterExporter.ExportResourceResolver exportResourceResolver)	Sets a reference to the configured ResourceCapableCacheDataImporterExporter.ExportResourceResolver.
void	setImportResourceResolver(ResourceCapableCacheDataImporterExporter.ImportResourceResolver importResourceResolver)	Sets a reference to the configured ResourceCapableCacheDataImporterExporter.ImportResourceResolver.
void	setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)	Configures the ResourceLoader used by this CacheDataImporterExporter to resolve and load Resources.
void	setResourceReader(ResourceReader resourceReader)	Sets a reference to the configured ResourceReader.
void	setResourceWriter(ResourceWriter resourceWriter)	Set a reference to the configured ResourceWriter.

Methods inherited from class org.springframework.geode.data.AbstractCacheDataImporterExporter

doExportFrom, doImportInto, exportFrom, getApplicationContext, getEnvironment, getLogger, getRegionPredicate, importInto, isExportEnabled, isImportEnabled, isImportProfilesActive, requireApplicationContext, requireEnvironment, setApplicationContext, setEnvironment

Methods inherited from class java.lang.Object

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

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

postProcessBeforeInitialization

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

postProcessBeforeDestruction

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

postProcessAfterInitialization

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

requiresDestruction

Field Details

CACHE_DATA_EXPORT_RESOURCE_LOCATION_PROPERTY_NAME

protected static final String CACHE_DATA_EXPORT_RESOURCE_LOCATION_PROPERTY_NAME

See Also:

• Constant Field Values

CACHE_DATA_IMPORT_RESOURCE_LOCATION_PROPERTY_NAME

protected static final String CACHE_DATA_IMPORT_RESOURCE_LOCATION_PROPERTY_NAME

See Also:

• Constant Field Values

RESOURCE_NAME_PATTERN

protected static final String RESOURCE_NAME_PATTERN

See Also:

• Constant Field Values

Constructor Details

ResourceCapableCacheDataImporterExporter

public ResourceCapableCacheDataImporterExporter()

Method Details

afterPropertiesSet

public void afterPropertiesSet()

Initializes the export and import ResourceResolvers as needed along with the reader and writer for the Resource used on import and export.

Specified by:

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

setExportResourceResolver

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

Sets a reference to the configured ResourceCapableCacheDataImporterExporter.ExportResourceResolver.

Parameters:

exportResourceResolver - configured ResourceCapableCacheDataImporterExporter.ExportResourceResolver used by this importer/exporter to resolve Resources on export.

See Also:

• ResourceCapableCacheDataImporterExporter.ExportResourceResolver

getExportResourceResolver

@NonNull
protected ResourceCapableCacheDataImporterExporter.ExportResourceResolver getExportResourceResolver()

Gets the configured reference to the ResourceCapableCacheDataImporterExporter.ExportResourceResolver. The configured ResourceCapableCacheDataImporterExporter.ExportResourceResolver is guaranteed to be non-null only if the afterPropertiesSet() initialization method was called after construction of this importer/exporter. This is definitely true in a Spring context.

Returns:

the configured reference to the ResourceCapableCacheDataImporterExporter.ExportResourceResolver.

See Also:

• ResourceCapableCacheDataImporterExporter.ExportResourceResolver

setImportResourceResolver

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

Sets a reference to the configured ResourceCapableCacheDataImporterExporter.ImportResourceResolver.

Parameters:

importResourceResolver - configured ResourceCapableCacheDataImporterExporter.ImportResourceResolver used by this importer/exporter to resolve Resources on import.

See Also:

• ResourceCapableCacheDataImporterExporter.ImportResourceResolver

getImportResourceResolver

@NonNull
protected ResourceCapableCacheDataImporterExporter.ImportResourceResolver getImportResourceResolver()

Gets the configured reference to the ResourceCapableCacheDataImporterExporter.ImportResourceResolver. The configured ResourceCapableCacheDataImporterExporter.ImportResourceResolver is guaranteed to be non-null only if the afterPropertiesSet() initialization method was called after construction of this importer/exporter. This is definitely true in a Spring context.

Returns:

the configured reference to the ResourceCapableCacheDataImporterExporter.ImportResourceResolver.

See Also:

• ResourceCapableCacheDataImporterExporter.ImportResourceResolver

setResourceLoader

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

Configures the ResourceLoader used by this CacheDataImporterExporter to resolve and load Resources.

Specified by:

setResourceLoader in interface org.springframework.context.ResourceLoaderAware

Parameters:

resourceLoader - ResourceLoader used to resolve and load Resources.

See Also:

• ResourceLoader

getResourceLoader

protected Optional<org.springframework.core.io.ResourceLoader> getResourceLoader()

Returns an Optional reference to the configured ResourceLoader used to load Resources.

Returns:

an Optional reference to the configured ResourceLoader.

See Also:

• ResourceLoader
• Optional

setResourceReader

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

Sets a reference to the configured ResourceReader.

Parameters:

resourceReader - configured ResourceReader used by this importer/exporter to read from a Resource on import.

See Also:

• ResourceReader

getResourceReader

@NonNull
protected ResourceReader getResourceReader()

Gets the configured ResourceReader used to read data from a Resource on import. The configured ResourceReader is guaranteed to be non-null only if the afterPropertiesSet() initialization method was called after construction of this importer/exporter. This is definitely true in a Spring context.

Returns:

the configured ResourceReader.

See Also:

• ResourceReader

setResourceWriter

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

Set a reference to the configured ResourceWriter.

Parameters:

resourceWriter - configured ResourceWriter used by this importer/exporter to write to a Resource on export.

See Also:

• ResourceWriter

getResourceWriter

@NonNull
protected ResourceWriter getResourceWriter()

Gets the configured ResourceWriter used to write data to the Resource on export. The configured ResourceWriter is guaranteed to be non-null only if the afterPropertiesSet() initialization method was called after construction of this importer/exporter. This is definitely true in a Spring context.

Returns:

the configured ResourceWriter.

See Also:

• ResourceWriter