org.springframework.geode.data.support

Class ResourceCapableCacheDataImporterExporter.AbstractCacheResourceResolver

java.lang.Object

org.springframework.geode.core.io.support.ResourceLoaderResourceResolver

org.springframework.geode.data.support.ResourceCapableCacheDataImporterExporter.AbstractCacheResourceResolver

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.EnvironmentAware, org.springframework.context.ResourceLoaderAware, ResourceResolver, ResourceCapableCacheDataImporterExporter.CacheResourceResolver

Direct Known Subclasses:

ResourceCapableCacheDataImporterExporter.AbstractExportResourceResolver, ResourceCapableCacheDataImporterExporter.AbstractImportResourceResolver

Enclosing class:

ResourceCapableCacheDataImporterExporter

protected abstract static class ResourceCapableCacheDataImporterExporter.AbstractCacheResourceResolver
extends ResourceLoaderResourceResolver
implements org.springframework.context.ApplicationContextAware, ResourceCapableCacheDataImporterExporter.CacheResourceResolver, org.springframework.context.EnvironmentAware

Abstract base class containing functionality common to all cache based ResourceResolvers, whether for import or export.

See Also:

ResourceLoaderResourceResolver, ApplicationContextAware, EnvironmentAware, ResourceCapableCacheDataImporterExporter.CacheResourceResolver

Constructor Summary

Constructors

Constructor and Description
AbstractCacheResourceResolver() Constructs a new instance of ResourceCapableCacheDataImporterExporter.AbstractCacheResourceResolver.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	evaluate(java.lang.String expressionString, org.apache.geode.cache.Region<?,?> region) Evaluates the given SpEL expression.
protected java.util.Optional<org.springframework.context.ApplicationContext>	getApplicationContext() Returns an Optional reference to a Spring ApplicationContext.
protected java.util.Optional<org.springframework.core.env.Environment>	getEnvironment() Returns an Optional reference to the Spring Environment.
protected org.springframework.expression.ExpressionParser	getExpressionParser() Gets the configured ExpressionParser used to parse SpEL expressions.
protected java.lang.String	getFullyQualifiedResourceLocation(org.apache.geode.cache.Region<?,?> region) Determines a fully-qualified resource location for the given Region.
protected org.slf4j.Logger	getLogger() Return the configured Logger to log messages.
protected org.springframework.expression.ParserContext	getParserContext() Gets the configured ParserContext used by the ExpressionParser to identify SpEL expressions.
protected java.lang.String	getResourceLocation(org.apache.geode.cache.Region<?,?> region, java.lang.String propertyName) Determines the location of a Resource for the given Region.
protected java.lang.String	getResourceName(org.apache.geode.cache.Region<?,?> region) Determines a resource name for the given Region.
protected java.lang.String	getResourceName(java.lang.String name) Determines a resource name for the given name.
protected abstract java.lang.String	getResourcePath() Get the base path for the targeted Resource.
protected boolean	isQualified(org.springframework.core.io.Resource resource) Determines whether the Resource is a qualified Resource.
protected org.springframework.expression.EvaluationContext	newEvaluationContext() Constructs a new EvaluationContext used during the evaluation of SpEL expressions.
protected org.springframework.expression.Expression	parse(java.lang.String expressionString) Parses the given expressionString.
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 Spring Environment.

Methods inherited from class org.springframework.geode.core.io.support.ResourceLoaderResourceResolver

getClassLoader, getResourceLoader, newResource, newResourceLoader, onMissingResource, postProcess, resolve, setResourceLoader

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.support.ResourceCapableCacheDataImporterExporter.CacheResourceResolver

resolve, resolve

Methods inherited from interface org.springframework.geode.core.io.ResourceResolver

getClassLoader, require

Constructor Detail

AbstractCacheResourceResolver

public AbstractCacheResourceResolver()

Constructs a new instance of ResourceCapableCacheDataImporterExporter.AbstractCacheResourceResolver. This constructor initializes the SpEL objects used to parse and evaluate SpEL expressions in order to fully qualify and resolve Resource locations defined as properties in Spring Boot application.properties for Import & Export Resources.

See Also:

newExpressionParser(), newEvaluationContextBuilder()

Method Detail

newEvaluationContext

@NonNull
protected org.springframework.expression.EvaluationContext newEvaluationContext()

Constructs a new EvaluationContext used during the evaluation of SpEL expressions.

Returns:

a new EvaluationContext; never null.

See Also:

EvaluationContext

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 - reference to the ApplicationContext.

See Also:

ApplicationContext

getApplicationContext

protected java.util.Optional<org.springframework.context.ApplicationContext> getApplicationContext()

Returns an Optional reference to a Spring ApplicationContext.

Returns:

an Optional reference to a Spring ApplicationContext.

See Also:

ApplicationContext, Optional

setEnvironment

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

Configures a reference to the Spring Environment.

Specified by:

setEnvironment in interface org.springframework.context.EnvironmentAware

Parameters:

environment - reference to the Environment.

See Also:

Environment

getEnvironment

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

Returns an Optional reference to the Spring Environment.

Returns:

an Optional reference to the Spring Environment.

See Also:

Environment, Optional

getExpressionParser

@NonNull
protected org.springframework.expression.ExpressionParser getExpressionParser()

Gets the configured ExpressionParser used to parse SpEL expressions.

Returns:

the configured ExpressionParser; never null.

See Also:

ExpressionParser

getLogger

protected org.slf4j.Logger getLogger()

Return the configured Logger to log messages.

Returns:

the configured Logger.

See Also:

Logger

getParserContext

@NonNull
protected org.springframework.expression.ParserContext getParserContext()

Gets the configured ParserContext used by the ExpressionParser to identify SpEL expressions.

Returns:

the configured ParserContext.

See Also:

ParserContext

isQualified

protected boolean isQualified(@Nullable
                              org.springframework.core.io.Resource resource)

Description copied from class: ResourceLoaderResourceResolver

Determines whether the Resource is a qualified Resource. Qualifications are determined by the application Requirements and Use Case (UC) at time of resolution. For example, it maybe that the Resource must exist to qualify, or that the Resource must have a valid protocol, path and name. This default implementation requires the target Resource to not be null.

Overrides:

isQualified in class ResourceLoaderResourceResolver

Parameters:

resource - Resource to qualify.

Returns:

a boolean value indicating whether the Resource is qualified.

See Also:

Resource

getFullyQualifiedResourceLocation

@NonNull
protected java.lang.String getFullyQualifiedResourceLocation(@NonNull
                                                                      org.apache.geode.cache.Region<?,?> region)

Determines a fully-qualified resource location for the given Region.

Parameters:

region - Region to evaluate; must not be null.

Returns:

a fully-qualified resource location for the given Region.

See Also:

Region, getResourceName(Region), getResourcePath()

getResourceLocation

@NonNull
protected java.lang.String getResourceLocation(@NonNull
                                                        org.apache.geode.cache.Region<?,?> region,
                                                        @NonNull
                                                        java.lang.String propertyName)

Determines the location of a Resource for the given Region.

Parameters:

region - Region used to locate the desired Resource; must not be null.

Returns:

a Resource location for the given Region.

Throws:

java.lang.IllegalArgumentException - if Region is null.

See Also:

Region

evaluate

@Nullable
protected java.lang.String evaluate(@NonNull
                                              java.lang.String expressionString,
                                              @NonNull
                                              org.apache.geode.cache.Region<?,?> region)

Evaluates the given SpEL expression.

Parameters:

expressionString - String containing the SpEL expression to evaluate; must not be null.

region - Region used to resolve regionName variable references in the expression; must not be null.

Returns:

the value of the evaluated expression.

See Also:

Expression.getValue(EvaluationContext, Object), Region, parse(String)

parse

protected org.springframework.expression.Expression parse(java.lang.String expressionString)

Parses the given expressionString. This method will cache parsed Expressions to speed up the evaluation process.

Parameters:

expressionString - String containing the SpEL expression to parse.

Returns:

an Expression object parsed from the given expression.

See Also:

ExpressionParser.parseExpression(String, ParserContext), Expression, getExpressionParser(), getParserContext()

getResourceName

@NonNull
protected java.lang.String getResourceName(@NonNull
                                                    org.apache.geode.cache.Region<?,?> region)

Determines a resource name for the given Region. The default implementation bases the resource name on the Region's lowercase name.

Parameters:

region - Region to evaluate; must not be null.

Returns:

a resource name for the given Region.

See Also:

Region, getResourceName(String)

getResourceName

@NonNull
protected java.lang.String getResourceName(@NonNull
                                                    java.lang.String name)

Determines a resource name for the given name.

Parameters:

name - String containing the name to evaluate; must not be null.

Returns:

a resource name from the given name.

getResourcePath

@NonNull
protected abstract java.lang.String getResourcePath()

Get the base path for the targeted Resource.

Returns:

the base path for the targeted Resource.