org.springframework.data.repository.core.support

Class RepositoryFactorySupport

java.lang.Object

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

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware

public abstract class RepositoryFactorySupport
extends Object
implements BeanClassLoaderAware, BeanFactoryAware

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 QueryExecuterMethodInterceptor. Query detection strategy can be configured by setting QueryLookupStrategy.Key.

Author:

Oliver Gierke, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RepositoryFactorySupport.QueryExecutorMethodInterceptor This MethodInterceptor intercepts calls to methods of the custom implementation and delegates the to it if configured.

Constructor Summary

Constructors

Constructor and Description
RepositoryFactorySupport()

Method Summary

Modifier and Type	Method and Description
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 extends Serializable> EntityInformation<T,ID>	getEntityInformation(Class<T> domainClass) Returns the EntityInformation for the given domain class.
protected ProjectionFactory	getProjectionFactory(ClassLoader classLoader, BeanFactory beanFactory) Returns the ProjectionFactory to be used with the repository instances created.
protected QueryLookupStrategy	getQueryLookupStrategy(QueryLookupStrategy.Key key) Deprecated. favor #getQueryLookupStrategy(Key, EvaluationContextProvider)
protected QueryLookupStrategy	getQueryLookupStrategy(QueryLookupStrategy.Key key, EvaluationContextProvider evaluationContextProvider) Returns the QueryLookupStrategy for the given QueryLookupStrategy.Key and EvaluationContextProvider.
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 an instance providing implementation logic for custom logic.
protected abstract Class<?>	getRepositoryBaseClass(RepositoryMetadata metadata) Returns the base class backing the actual repository instance.
protected RepositoryInformation	getRepositoryInformation(RepositoryMetadata metadata, Class<?> customImplementationClass) Returns the RepositoryInformation for the given repository interface.
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 <R> R	getTargetRepositoryViaReflection(RepositoryInformation information, Object... constructorArguments) Creates a repository of the repository base class defined in the given RepositoryInformation using reflection.
void	setBeanClassLoader(ClassLoader classLoader)
void	setBeanFactory(BeanFactory beanFactory)
void	setEvaluationContextProvider(EvaluationContextProvider evaluationContextProvider) Sets the EvaluationContextProvider to be used to evaluate SpEL expressions in manually defined queries.
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 lookup 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 Detail

RepositoryFactorySupport

public RepositoryFactorySupport()

Method Detail

setQueryLookupStrategyKey

public void setQueryLookupStrategyKey(QueryLookupStrategy.Key key)

Sets the strategy of how to lookup a query to execute finders.

Parameters:

key -

setNamedQueries

public void setNamedQueries(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(ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Specified by:

setBeanFactory in interface BeanFactoryAware

Throws:

BeansException

setEvaluationContextProvider

public void setEvaluationContextProvider(EvaluationContextProvider evaluationContextProvider)

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

Parameters:

evaluationContextProvider - can be null, defaults to DefaultEvaluationContextProvider.INSTANCE.

setRepositoryBaseClass

public void setRepositoryBaseClass(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 -

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 RepositoryFactorySupport.QueryExecutorMethodInterceptor will be added to the proxy after the RepositoryProxyPostProcessors are considered.

Parameters:

processor -

getRepository

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

Returns a repository instance for the given interface.

Type Parameters:

T -

Parameters:

repositoryInterface -

Returns:

getRepository

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

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

Type Parameters:

T -

Parameters:

repositoryInterface -

customImplementation -

Returns:

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,
                                                         Class<?> customImplementationClass)

Returns the RepositoryInformation for the given repository interface.

Parameters:

metadata -

customImplementationClass -

Returns:

getQueryMethods

protected List<QueryMethod> getQueryMethods()

getEntityInformation

public abstract <T,ID extends Serializable> 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(RepositoryMetadata) returns an instance of this class.

Parameters:

metadata -

Returns:

getQueryLookupStrategy

protected QueryLookupStrategy getQueryLookupStrategy(QueryLookupStrategy.Key key)

Deprecated. favor #getQueryLookupStrategy(Key, EvaluationContextProvider)

Returns the QueryLookupStrategy for the given QueryLookupStrategy.Key.

Parameters:

key - can be null

Returns:

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

getQueryLookupStrategy

protected QueryLookupStrategy getQueryLookupStrategy(QueryLookupStrategy.Key key,
                                                     EvaluationContextProvider evaluationContextProvider)

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

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

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: