Package org.springframework.data.repository.core.support

Class RepositoryFactorySupport

java.lang.Object

org.springframework.data.repository.core.support.RepositoryFactorySupport

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, EnvironmentAware, EnvironmentCapable

Direct Known Subclasses:

ReactiveRepositoryFactorySupport

public abstract class RepositoryFactorySupport
extends Object
implements BeanClassLoaderAware, BeanFactoryAware, EnvironmentAware, EnvironmentCapable

Factory bean to create instances of a given repository interface. Creates a proxy implementing the configured repository interface and apply an advice handing the control to the QueryExecutorMethodInterceptor. Query detection strategy can be configured by setting QueryLookupStrategy.Key.

Author:

Oliver Gierke, Mark Paluch, Christoph Strobl, Jens Schauder, John Blum, Johannes Englmeier

Constructor Summary

Constructors

Constructor	Description
RepositoryFactorySupport()

Method Summary

Modifier and Type	Method	Description
void	addInvocationListener(RepositoryMethodInvocationListener listener)	Adds a RepositoryMethodInvocationListener to the factory to plug in functionality triggered right after running query methods and fragment methods.
void	addQueryCreationListener(QueryCreationListener<?> listener)	Adds a QueryCreationListener to the factory to plug in functionality triggered right after creation of RepositoryQuery instances.
void	addRepositoryProxyPostProcessor(RepositoryProxyPostProcessor processor)	Adds RepositoryProxyPostProcessors to the factory to allow manipulation of the ProxyFactory before the proxy gets created.
abstract <T, ID> EntityInformation<T,ID>	getEntityInformation(Class<T> domainClass)	Returns the EntityInformation for the given domain class.
Environment	getEnvironment()
protected ProjectionFactory	getProjectionFactory()	Returns a ProjectionFactory instance.
protected ProjectionFactory	getProjectionFactory(ClassLoader classLoader, BeanFactory beanFactory)	Returns the ProjectionFactory to be used with the repository instances created.
protected Optional<QueryLookupStrategy>	getQueryLookupStrategy(QueryLookupStrategy.Key key, QueryMethodEvaluationContextProvider evaluationContextProvider)	Deprecated. since 3.4, use getQueryLookupStrategy(Key, ValueExpressionDelegate) instead to support ValueExpression in query methods.
protected Optional<QueryLookupStrategy>	getQueryLookupStrategy(QueryLookupStrategy.Key key, ValueExpressionDelegate valueExpressionDelegate)	Returns the QueryLookupStrategy for the given QueryLookupStrategy.Key and ValueExpressionDelegate.
protected List<QueryMethod>	getQueryMethods()
<T> T	getRepository(Class<T> repositoryInterface)	Returns a repository instance for the given interface.
<T> T	getRepository(Class<T> repositoryInterface, Object customImplementation)	Returns a repository instance for the given interface backed by a single instance providing implementation logic for custom logic.
<T> T	getRepository(Class<T> repositoryInterface, RepositoryComposition.RepositoryFragments fragments)	Returns a repository instance for the given interface backed by an instance providing implementation logic for custom logic.
protected abstract Class<?>	getRepositoryBaseClass(RepositoryMetadata metadata)	Returns the base class backing the actual repository instance.
protected RepositoryComposition.RepositoryFragments	getRepositoryFragments(RepositoryMetadata metadata)	Creates RepositoryComposition.RepositoryFragments based on RepositoryMetadata to add repository-specific extensions.
protected RepositoryInformation	getRepositoryInformation(RepositoryMetadata metadata, RepositoryComposition.RepositoryFragments fragments)	Returns the RepositoryInformation for the given RepositoryMetadata and custom RepositoryComposition.RepositoryFragments.
protected RepositoryMetadata	getRepositoryMetadata(Class<?> repositoryInterface)	Returns the RepositoryMetadata for the given repository interface.
protected abstract Object	getTargetRepository(RepositoryInformation metadata)	Create a repository instance as backing for the query proxy.
protected final <R> R	getTargetRepositoryViaReflection(Class<?> baseClass, Object... constructorArguments)	Deprecated. since 2.6 because it has a misleading name.
protected final <R> R	getTargetRepositoryViaReflection(RepositoryInformation information, Object... constructorArguments)	Creates a repository of the repository base class defined in the given RepositoryInformation using reflection.
protected final <R> R	instantiateClass(Class<?> baseClass, Object... constructorArguments)	Convenience method to instantiate a class using the given constructorArguments by looking up a matching constructor.
void	setBeanClassLoader(ClassLoader classLoader)
void	setBeanFactory(BeanFactory beanFactory)
void	setEnvironment(Environment environment)
void	setEvaluationContextProvider(QueryMethodEvaluationContextProvider evaluationContextProvider)	Deprecated. since 3.4, use setEvaluationContextProvider(EvaluationContextProvider) instead.
void	setEvaluationContextProvider(EvaluationContextProvider evaluationContextProvider)	Sets the EvaluationContextProvider to be used to evaluate SpEL expressions in manually defined queries.
void	setExposeMetadata(boolean exposeMetadata)	Set whether the repository method metadata should be exposed by the repository factory as a ThreadLocal for retrieval via the RepositoryMethodContext class.
void	setNamedQueries(NamedQueries namedQueries)	Configures a NamedQueries instance to be handed to the QueryLookupStrategy for query creation.
void	setQueryLookupStrategyKey(QueryLookupStrategy.Key key)	Sets the strategy of how to look up a query to execute finders.
void	setRepositoryBaseClass(Class<?> repositoryBaseClass)	Configures the repository base class to use when creating the repository proxy.
protected void	validate(RepositoryMetadata repositoryMetadata)

Methods inherited from class java.lang.Object

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

Constructor Details

RepositoryFactorySupport

public RepositoryFactorySupport()

Method Details

setExposeMetadata

public void setExposeMetadata(boolean exposeMetadata)

Set whether the repository method metadata should be exposed by the repository factory as a ThreadLocal for retrieval via the RepositoryMethodContext class. This is useful if an advised object needs to obtain repository information.

Default is "false", in order to avoid unnecessary extra interception. This means that no guarantees are provided that RepositoryMethodContext access will work consistently within any method of the advised object.

Repository method metadata is also exposed if implementations within the repository composition implement RepositoryMetadataAccess.

Since:

3.4

See Also:

• RepositoryMethodContext
• RepositoryMetadataAccess

setQueryLookupStrategyKey

public void setQueryLookupStrategyKey(QueryLookupStrategy.Key key)

Sets the strategy of how to look up a query to execute finders.

Parameters:

key -

setNamedQueries

public void setNamedQueries(@Nullable
 NamedQueries namedQueries)

Configures a NamedQueries instance to be handed to the QueryLookupStrategy for query creation.

Parameters:

namedQueries - the namedQueries to set

setBeanClassLoader

public void setBeanClassLoader(@Nullable
 ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Specified by:

setBeanFactory in interface BeanFactoryAware

Throws:

BeansException

setEnvironment

public void setEnvironment(Environment environment)

Specified by:

setEnvironment in interface EnvironmentAware

getEnvironment

public Environment getEnvironment()

Specified by:

getEnvironment in interface EnvironmentCapable

setEvaluationContextProvider

@Deprecated(since="3.4")
public void setEvaluationContextProvider(@Nullable
 QueryMethodEvaluationContextProvider evaluationContextProvider)

Deprecated.

since 3.4, use setEvaluationContextProvider(EvaluationContextProvider) instead.

Sets the QueryMethodEvaluationContextProvider to be used to evaluate SpEL expressions in manually defined queries.

Parameters:

evaluationContextProvider - can be null, defaults to QueryMethodEvaluationContextProvider.DEFAULT.

setEvaluationContextProvider

public void setEvaluationContextProvider(@Nullable
 EvaluationContextProvider evaluationContextProvider)

Sets the EvaluationContextProvider to be used to evaluate SpEL expressions in manually defined queries.

Parameters:

evaluationContextProvider - can be null, defaults to EvaluationContextProvider.DEFAULT.

setRepositoryBaseClass

public void setRepositoryBaseClass(@Nullable
 Class<?> repositoryBaseClass)

Configures the repository base class to use when creating the repository proxy. If not set, the factory will use the type returned by getRepositoryBaseClass(RepositoryMetadata) by default.

Parameters:

repositoryBaseClass - the repository base class to back the repository proxy, can be null.

Since:

1.11

addQueryCreationListener

public void addQueryCreationListener(QueryCreationListener<?> listener)

Adds a QueryCreationListener to the factory to plug in functionality triggered right after creation of RepositoryQuery instances.

Parameters:

listener - the listener to add.

addInvocationListener

public void addInvocationListener(RepositoryMethodInvocationListener listener)

Adds a RepositoryMethodInvocationListener to the factory to plug in functionality triggered right after running query methods and fragment methods.

Parameters:

listener - the listener to add.

Since:

2.4

addRepositoryProxyPostProcessor

public void addRepositoryProxyPostProcessor(RepositoryProxyPostProcessor processor)

Adds RepositoryProxyPostProcessors to the factory to allow manipulation of the ProxyFactory before the proxy gets created. Note that the QueryExecutorMethodInterceptor will be added to the proxy after the RepositoryProxyPostProcessors are considered.

Parameters:

processor - the post-processor to add.

getRepositoryFragments

protected RepositoryComposition.RepositoryFragments getRepositoryFragments(RepositoryMetadata metadata)

Creates RepositoryComposition.RepositoryFragments based on RepositoryMetadata to add repository-specific extensions.

Parameters:

metadata - the repository metadata to use.

Returns:

fragment composition.

getRepository

public <T> T getRepository(Class<T> repositoryInterface)

Returns a repository instance for the given interface.

Parameters:

repositoryInterface - must not be null.

Returns:

the implemented repository interface.

getRepository

public <T> T getRepository(Class<T> repositoryInterface,
 Object customImplementation)

Returns a repository instance for the given interface backed by a single instance providing implementation logic for custom logic. For more advanced composition needs use getRepository(Class, RepositoryFragments).

Parameters:

repositoryInterface - must not be null.

customImplementation - must not be null.

Returns:

the implemented repository interface.

getRepository

public <T> T getRepository(Class<T> repositoryInterface,
 RepositoryComposition.RepositoryFragments fragments)

Returns a repository instance for the given interface backed by an instance providing implementation logic for custom logic.

Parameters:

repositoryInterface - must not be null.

fragments - must not be null.

Returns:

the implemented repository interface.

Since:

2.0

getProjectionFactory

protected ProjectionFactory getProjectionFactory(ClassLoader classLoader,
 BeanFactory beanFactory)

Returns the ProjectionFactory to be used with the repository instances created.

Parameters:

classLoader - will never be null.

beanFactory - will never be null.

Returns:

will never be null.

getRepositoryMetadata

protected RepositoryMetadata getRepositoryMetadata(Class<?> repositoryInterface)

Returns the RepositoryMetadata for the given repository interface.

Parameters:

repositoryInterface - will never be null.

Returns:

getRepositoryInformation

protected RepositoryInformation getRepositoryInformation(RepositoryMetadata metadata,
 RepositoryComposition.RepositoryFragments fragments)

Returns the RepositoryInformation for the given RepositoryMetadata and custom RepositoryComposition.RepositoryFragments.

Parameters:

metadata - must not be null.

fragments - must not be null.

Returns:

will never be null.

getQueryMethods

protected List<QueryMethod> getQueryMethods()

getProjectionFactory

protected ProjectionFactory getProjectionFactory()

Returns a ProjectionFactory instance.

Returns:

Since:

2.6

getEntityInformation

public abstract <T,
ID> EntityInformation<T,ID> getEntityInformation(Class<T> domainClass)

Returns the EntityInformation for the given domain class.

Type Parameters:

T - the entity type

ID - the id type

Parameters:

domainClass -

Returns:

getTargetRepository

protected abstract Object getTargetRepository(RepositoryInformation metadata)

Create a repository instance as backing for the query proxy.

Parameters:

metadata -

Returns:

getRepositoryBaseClass

protected abstract Class<?> getRepositoryBaseClass(RepositoryMetadata metadata)

Returns the base class backing the actual repository instance. Make sure getTargetRepository(RepositoryInformation) returns an instance of this class.

Parameters:

metadata -

Returns:

getQueryLookupStrategy

@Deprecated(since="3.4")
protected Optional<QueryLookupStrategy> getQueryLookupStrategy(@Nullable
 QueryLookupStrategy.Key key,
 QueryMethodEvaluationContextProvider evaluationContextProvider)

Deprecated.

since 3.4, use getQueryLookupStrategy(Key, ValueExpressionDelegate) instead to support ValueExpression in query methods.

Returns the QueryLookupStrategy for the given QueryLookupStrategy.Key and QueryMethodEvaluationContextProvider.

Parameters:

key - can be null.

evaluationContextProvider - will never be null.

Returns:

the QueryLookupStrategy to use or null if no queries should be looked up.

Since:

1.9

getQueryLookupStrategy

protected Optional<QueryLookupStrategy> getQueryLookupStrategy(@Nullable
 QueryLookupStrategy.Key key,
 ValueExpressionDelegate valueExpressionDelegate)

Returns the QueryLookupStrategy for the given QueryLookupStrategy.Key and ValueExpressionDelegate. Favor implementing this method over getQueryLookupStrategy(Key, QueryMethodEvaluationContextProvider) for extended ValueExpression support.

This method delegates to getQueryLookupStrategy(Key, QueryMethodEvaluationContextProvider) unless overridden.

Parameters:

key - can be null.

valueExpressionDelegate - will never be null.

Returns:

the QueryLookupStrategy to use or null if no queries should be looked up.

Since:

3.4

validate

protected void validate(RepositoryMetadata repositoryMetadata)

getTargetRepositoryViaReflection

protected final <R> R getTargetRepositoryViaReflection(RepositoryInformation information,
 Object... constructorArguments)

Creates a repository of the repository base class defined in the given RepositoryInformation using reflection.

Parameters:

information -

constructorArguments -

Returns:

getTargetRepositoryViaReflection

@Deprecated
protected final <R> R getTargetRepositoryViaReflection(Class<?> baseClass,
 Object... constructorArguments)

Deprecated.

since 2.6 because it has a misleading name. Use instantiateClass(Class, Object...) instead.

Creates a repository of the repository base class defined in the given RepositoryInformation using reflection.

Parameters:

baseClass -

constructorArguments -

Returns:

instantiateClass

protected final <R> R instantiateClass(Class<?> baseClass,
 Object... constructorArguments)

Convenience method to instantiate a class using the given constructorArguments by looking up a matching constructor.

Note that this method tries to set the constructor accessible if given a non-accessible (that is, non-public) constructor, and supports Kotlin classes with optional parameters and default values.

Parameters:

baseClass -

constructorArguments -

Returns:

Since:

2.6