Class ReactiveCassandraAccessor

java.lang.Object

org.springframework.data.cassandra.core.cql.ReactiveCassandraAccessor

All Implemented Interfaces:

InitializingBean

Direct Known Subclasses:

ReactiveCqlTemplate

public abstract class ReactiveCassandraAccessor
extends Object
implements InitializingBean

Base class for ReactiveCqlTemplate and other CQL-accessing DAO helpers, defining common properties such as ReactiveSessionFactory and exception translator.

Not intended to be used directly.

Since:

2.0

Author:

Mark Paluch

See Also:

• InitializingBean
• ReactiveSession
• ReactiveCqlTemplate

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.apache.commons.logging.Log	logger	Logger available to subclasses

Constructor Summary

Constructors

Constructor	Description
ReactiveCassandraAccessor()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()	Ensures the Cassandra ReactiveSessionFactory and exception translator has been properly set.
CqlExceptionTranslator	getExceptionTranslator()	Returns the exception translator for this instance.
@Nullable ReactiveSessionFactory	getSessionFactory()	Returns the configured ReactiveSessionFactory.
void	setExceptionTranslator(CqlExceptionTranslator exceptionTranslator)	Sets the exception translator used by this template to translate Cassandra specific exceptions into Spring DAO's Exception Hierarchy.
void	setSessionFactory(ReactiveSessionFactory sessionFactory)	Sets the ReactiveSessionFactory to use.
protected static @Nullable String	toCql(@Nullable Object cqlProvider)	Determine CQL from potential provider object.
protected DataAccessException	translate(String task, @Nullable String cql, RuntimeException ex)	Translate the given DriverException into a generic DataAccessException.
protected @Nullable DataAccessException	translateExceptionIfPossible(RuntimeException ex)	Translate the given DriverException into a generic DataAccessException.

Methods inherited from class Object

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

Field Details

logger

protected final org.apache.commons.logging.Log logger

Logger available to subclasses

Constructor Details

ReactiveCassandraAccessor

public ReactiveCassandraAccessor()

Method Details

setSessionFactory

public void setSessionFactory(ReactiveSessionFactory sessionFactory)

Sets the ReactiveSessionFactory to use.

Parameters:

sessionFactory - must not be null.

getSessionFactory

public @Nullable ReactiveSessionFactory getSessionFactory()

Returns the configured ReactiveSessionFactory.

Returns:

the configured ReactiveSessionFactory.

setExceptionTranslator

public void setExceptionTranslator(CqlExceptionTranslator exceptionTranslator)

Sets the exception translator used by this template to translate Cassandra specific exceptions into Spring DAO's Exception Hierarchy.

Parameters:

exceptionTranslator - exception translator to set; must not be null.

See Also:

• CassandraExceptionTranslator
• DataAccessException

getExceptionTranslator

public CqlExceptionTranslator getExceptionTranslator()

Returns the exception translator for this instance.

Returns:

the Cassandra exception translator.

See Also:

• CassandraExceptionTranslator

afterPropertiesSet

public void afterPropertiesSet()

Ensures the Cassandra ReactiveSessionFactory and exception translator has been properly set.

Specified by:

afterPropertiesSet in interface InitializingBean

translateExceptionIfPossible

protected @Nullable DataAccessException translateExceptionIfPossible(RuntimeException ex)

Translate the given DriverException into a generic DataAccessException.

The returned DataAccessException is supposed to contain the original DriverException as root cause. However, client code may not generally rely on this due to DataAccessExceptions possibly being caused by other resource APIs as well. That said, a getRootCause() instanceof DataAccessException check (and subsequent cast) is considered reliable when expecting Cassandra-based access to have happened.

Parameters:

ex - the offending DriverException

Returns:

the DataAccessException, wrapping the DriverException

See Also:

• Consistent exception hierarchy
• DataAccessException

translate

protected DataAccessException translate(String task,
 @Nullable String cql,
 RuntimeException ex)

Translate the given DriverException into a generic DataAccessException.

The returned DataAccessException is supposed to contain the original DriverException as root cause. However, client code may not generally rely on this due to DataAccessExceptions possibly being caused by other resource APIs as well. That said, a getRootCause() instanceof DataAccessException check (and subsequent cast) is considered reliable when expecting Cassandra-based access to have happened.

Parameters:

task - readable text describing the task being attempted

cql - CQL query or update that caused the problem (can be null)

ex - the offending DriverException

Returns:

the DataAccessException, wrapping the DriverException

See Also:

• NestedRuntimeException.getRootCause()
• Consistent exception hierarchy

toCql

@Contract("null -> null; !null -> !null")
protected static @Nullable String toCql(@Nullable Object cqlProvider)

Determine CQL from potential provider object.

Parameters:

cqlProvider - object that's potentially a CqlProvider

Returns:

the CQL string, or null

Since:

3.2.7

See Also:

• CqlProvider