Module spring.data.cassandra

Package org.springframework.data.cassandra.core.cql.session.lookup

Class AbstractRoutingSessionFactory

java.lang.Object

org.springframework.data.cassandra.core.cql.session.lookup.AbstractRoutingSessionFactory

All Implemented Interfaces:

InitializingBean, SessionFactory

public abstract class AbstractRoutingSessionFactory
extends Object
implements SessionFactory, InitializingBean

Abstract SessionFactory implementation that routes getSession() calls to one of various target factories based on a lookup key. The latter is usually (but not necessarily) determined through some thread-bound transaction context.

Since:

2.0

Author:

Mark Paluch

See Also:

• setTargetSessionFactories(Map)
• setDefaultTargetSessionFactory(Object)
• determineCurrentLookupKey()
• SessionFactoryLookup

Constructor Summary

Constructors

Constructor	Description
AbstractRoutingSessionFactory()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected abstract Object	determineCurrentLookupKey()	Determine the current lookup key.
protected SessionFactory	determineTargetSessionFactory()	Retrieve the current target SessionFactory.
com.datastax.oss.driver.api.core.CqlSession	getSession()	Attempts to establish a CqlSession with the connection infrastructure that this SessionFactory object represents.
protected Object	resolveSpecifiedLookupKey(Object lookupKey)	Resolve the given lookup key object, as specified in the setTargetSessionFactories(Map) map, into the actual lookup key to be used for matching with the current lookup key.
protected SessionFactory	resolveSpecifiedSessionFactory(Object sessionFactory)	Resolve the specified sessionFactory object into a SessionFactory instance.
void	setDefaultTargetSessionFactory(Object defaultTargetSessionFactory)	Specify the default target SessionFactory, if any.
void	setLenientFallback(boolean lenientFallback)	Specify whether to apply a lenient fallback to the default SessionFactory if no specific SessionFactory could be found for the current lookup key.
void	setSessionFactoryLookup(SessionFactoryLookup sessionFactoryLookup)	Set the SessionFactoryLookup implementation to use for resolving session factory name Strings in the setTargetSessionFactories(Map) map.
void	setTargetSessionFactories(Map<Object,Object> targetSessionFactories)	Specify the map of target session factories, with the lookup key as key.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractRoutingSessionFactory

public AbstractRoutingSessionFactory()

Method Details

setTargetSessionFactories

public void setTargetSessionFactories(Map<Object,Object> targetSessionFactories)

Specify the map of target session factories, with the lookup key as key.

The mapped value can either be a corresponding SessionFactory instance or a data source name String (to be resolved via a setSessionFactoryLookup(SessionFactoryLookup)).

The key can be of arbitrary type; this class implements the generic lookup process only. The concrete key representation will be handled by resolveSpecifiedLookupKey(Object) and determineCurrentLookupKey().

setDefaultTargetSessionFactory

public void setDefaultTargetSessionFactory(Object defaultTargetSessionFactory)

Specify the default target SessionFactory, if any.

The mapped value can either be a corresponding SessionFactory instance or a data source name String (to be resolved via a setSessionFactoryLookup(SessionFactoryLookup)).

This SessionFactory will be used as target if none of the keyed setTargetSessionFactories(Map) match the determineCurrentLookupKey() current lookup key.

setLenientFallback

public void setLenientFallback(boolean lenientFallback)

Specify whether to apply a lenient fallback to the default SessionFactory if no specific SessionFactory could be found for the current lookup key.

Default is true, accepting lookup keys without a corresponding entry in the target SessionFactory map - simply falling back to the default SessionFactory in that case.

Switch this flag to false if you would prefer the fallback to only apply if the lookup key was null. Lookup keys without a SessionFactory entry will then lead to an IllegalStateException.

Parameters:

lenientFallback - true to accepting lookup keys without a corresponding entry in the target.

See Also:

• setTargetSessionFactories(java.util.Map<java.lang.Object, java.lang.Object>)
• setDefaultTargetSessionFactory(java.lang.Object)
• determineCurrentLookupKey()

setSessionFactoryLookup

public void setSessionFactoryLookup(@Nullable
 SessionFactoryLookup sessionFactoryLookup)

Set the SessionFactoryLookup implementation to use for resolving session factory name Strings in the setTargetSessionFactories(Map) map.

Default is a MapSessionFactoryLookup, allowing a string keyed map of session factories.

Parameters:

sessionFactoryLookup - the SessionFactoryLookup. Defaults to MapSessionFactoryLookup if null.

getSession

public com.datastax.oss.driver.api.core.CqlSession getSession()

Description copied from interface: SessionFactory

Attempts to establish a CqlSession with the connection infrastructure that this SessionFactory object represents.

Specified by:

getSession in interface SessionFactory

Returns:

a CqlSession to Apache Cassandra.

See Also:

• CqlSession

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

resolveSpecifiedLookupKey

protected Object resolveSpecifiedLookupKey(Object lookupKey)

Resolve the given lookup key object, as specified in the setTargetSessionFactories(Map) map, into the actual lookup key to be used for matching with the current lookup key.

The default implementation simply returns the given key as-is.

Parameters:

lookupKey - the lookup key object as specified by the user

Returns:

the lookup key as needed for matching

resolveSpecifiedSessionFactory

protected SessionFactory resolveSpecifiedSessionFactory(Object sessionFactory)
                                                 throws IllegalArgumentException

Resolve the specified sessionFactory object into a SessionFactory instance.

The default implementation handles SessionFactory instances and session factory names (to be resolved via a setSessionFactoryLookup(SessionFactoryLookup)).

Parameters:

sessionFactory - the session factory value object as specified in the setTargetSessionFactories(Map) map

Returns:

the resolved SessionFactory

Throws:

IllegalArgumentException - in case of an unsupported value type.

SessionFactoryLookupFailureException - if the lookup failed.

determineTargetSessionFactory

protected SessionFactory determineTargetSessionFactory()

Retrieve the current target SessionFactory. Determines the current lookup key, performs a lookup in the setTargetSessionFactories(Map) map, falls back to the specified default target SessionFactory if necessary.

See Also:

• determineCurrentLookupKey()

determineCurrentLookupKey

@Nullable
protected abstract Object determineCurrentLookupKey()

Determine the current lookup key. This will typically be implemented to check a thread-bound context.

Allows for arbitrary keys.

Returns:

the current lookup key. The returned key needs to match the stored lookup key type.