org.springframework.data.cassandra.config

Class PoolingOptionsFactoryBean

java.lang.Object

org.springframework.data.cassandra.config.PoolingOptionsFactoryBean

All Implemented Interfaces:

FactoryBean<com.datastax.driver.core.PoolingOptions>, InitializingBean

public class PoolingOptionsFactoryBean
extends Object
implements FactoryBean<com.datastax.driver.core.PoolingOptions>, InitializingBean

Spring FactoryBean for the Cassandra Java driver PoolingOptions.

Author:

Matthew T. Adams, David Webb, Mark Paluch, John Blum

See Also:

FactoryBean, InitializingBean, PoolingOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PoolingOptionsFactoryBean.HostDistancePoolingOptions The HostDistancePoolingOptions class models the PoolingOptions state and connection settings for a particular HostDistance.

Constructor Summary

Constructors

Constructor and Description
PoolingOptionsFactoryBean()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected com.datastax.driver.core.PoolingOptions	configureLocalHostDistancePoolingOptions(com.datastax.driver.core.PoolingOptions poolingOptions) Configures the HostDistance.LOCAL connection settings on the given PoolingOptions.
protected com.datastax.driver.core.PoolingOptions	configureRemoteHostDistancePoolingOptions(com.datastax.driver.core.PoolingOptions poolingOptions) Configures the HostDistance.REMOTE connection settings on the given PoolingOptions.
int	getHeartbeatIntervalSeconds() Gets the heart beat interval, after which a message is sent on an idle connection to make sure it's still alive.
int	getIdleTimeoutSeconds() Get the timeout before an idle connection is removed.
Executor	getInitializationExecutor() Gets the Executor to use for connection initialization.
Integer	getLocalCoreConnections() Gets the core number of connections per host for the HostDistance.LOCAL scope.
Integer	getLocalMaxConnections() Gets the maximum number of connections per host for the HostDistance.LOCAL scope.
Integer	getLocalMaxSimultaneousRequests() Gets the maximum number of requests per connection for the HostDistance.LOCAL scope.
Integer	getLocalMinSimultaneousRequests() Gets the threshold that triggers the creation of a new connection to a host for the HostDistance.LOCAL scope.
Integer	getMaxQueueSize() Gets the maximum number of requests that get enqueued if no connection is available.
com.datastax.driver.core.PoolingOptions	getObject()
Class<?>	getObjectType()
int	getPoolTimeoutMilliseconds() Gets the timeout when trying to acquire a connection from a host's pool.
Integer	getRemoteCoreConnections() Gets the core number of connections per host for the HostDistance.REMOTE scope.
Integer	getRemoteMaxConnections() Gets the maximum number of connections per host for the HostDistance.REMOTE scope.
Integer	getRemoteMaxSimultaneousRequests() Gets the maximum number of requests per connection for the HostDistance.REMOTE scope.
Integer	getRemoteMinSimultaneousRequests() Gets the threshold that triggers the creation of a new connection to a host for the HostDistance.REMOTE scope.
boolean	isSingleton()
protected PoolingOptionsFactoryBean.HostDistancePoolingOptions	newLocalHostDistancePoolingOptions() Constructs and returns a PoolingOptionsFactoryBean.HostDistancePoolingOptions instance initialized with the HostDistance.LOCAL-based PoolingOptions as configured on this PoolingOptionsFactoryBean.
protected PoolingOptionsFactoryBean.HostDistancePoolingOptions	newRemoteHostDistancePoolingOptions() Constructs and returns a PoolingOptionsFactoryBean.HostDistancePoolingOptions instance initialized with the HostDistance.REMOTE-based PoolingOptions as configured on this PoolingOptionsFactoryBean.
void	setHeartbeatIntervalSeconds(int heartbeatIntervalSeconds) Sets the heart beat interval, after which a message is sent on an idle connection to make sure it's still alive.
void	setIdleTimeoutSeconds(int idleTimeoutSeconds) Sets the timeout before an idle connection is removed.
void	setInitializationExecutor(Executor initializationExecutor) Sets the Executor to use for connection initialization.
void	setLocalCoreConnections(Integer localCoreConnections) Sets the core number of connections per host for the HostDistance.LOCAL scope.
void	setLocalMaxConnections(Integer localMaxConnections) Sets the maximum number of connections per host for the HostDistance.LOCAL scope.
void	setLocalMaxSimultaneousRequests(Integer localMaxSimultaneousRequests) Sets the maximum number of requests per connection for the HostDistance.LOCAL scope.
void	setLocalMinSimultaneousRequests(Integer localMinSimultaneousRequests) Sets the threshold that triggers the creation of a new connection to a host for the HostDistance.LOCAL scope.
void	setMaxQueueSize(Integer maxQueueSize) Sets the maximum number of requests that get enqueued if no connection is available.
void	setPoolTimeoutMilliseconds(int poolTimeoutMilliseconds) Sets the timeout when trying to acquire a connection from a host's pool.
void	setRemoteCoreConnections(Integer remoteCoreConnections) Sets the core number of connections per host for the HostDistance.REMOTE scope.
void	setRemoteMaxConnections(Integer remoteMaxConnections) Sets the maximum number of connections per host for the HostDistance.REMOTE scope.
void	setRemoteMaxSimultaneousRequests(Integer remoteMaxSimultaneousRequests) Sets the maximum number of requests per connection for the HostDistance.REMOTE scope.
void	setRemoteMinSimultaneousRequests(Integer remoteMinSimultaneousRequests) Sets the threshold that triggers the creation of a new connection to a host for the HostDistance.REMOTE scope.

Methods inherited from class java.lang.Object

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

Constructor Detail

PoolingOptionsFactoryBean

public PoolingOptionsFactoryBean()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

newLocalHostDistancePoolingOptions

protected PoolingOptionsFactoryBean.HostDistancePoolingOptions newLocalHostDistancePoolingOptions()

Constructs and returns a PoolingOptionsFactoryBean.HostDistancePoolingOptions instance initialized with the HostDistance.LOCAL-based PoolingOptions as configured on this PoolingOptionsFactoryBean.

Returns:

PoolingOptionsFactoryBean.HostDistancePoolingOptions initialized with this PoolingOptionsFactoryBean's HostDistance.LOCAL-based PoolingOptions.

See Also:

HostDistance.LOCAL, PoolingOptions, PoolingOptionsFactoryBean.HostDistancePoolingOptions, PoolingOptionsFactoryBean.LocalHostDistancePoolingOptions

newRemoteHostDistancePoolingOptions

protected PoolingOptionsFactoryBean.HostDistancePoolingOptions newRemoteHostDistancePoolingOptions()

Constructs and returns a PoolingOptionsFactoryBean.HostDistancePoolingOptions instance initialized with the HostDistance.REMOTE-based PoolingOptions as configured on this PoolingOptionsFactoryBean.

Returns:

PoolingOptionsFactoryBean.HostDistancePoolingOptions initialized with this PoolingOptionsFactoryBean's HostDistance.REMOTE-based PoolingOptions.

See Also:

HostDistance.REMOTE, PoolingOptions, PoolingOptionsFactoryBean.HostDistancePoolingOptions, PoolingOptionsFactoryBean.RemoteHostDistancePoolingOptions

configureLocalHostDistancePoolingOptions

protected com.datastax.driver.core.PoolingOptions configureLocalHostDistancePoolingOptions(com.datastax.driver.core.PoolingOptions poolingOptions)

Configures the HostDistance.LOCAL connection settings on the given PoolingOptions.

Parameters:

poolingOptions - the PoolingOptions to configure.

Returns:

the given PoolingOptions.

See Also:

HostDistance.LOCAL, PoolingOptions, newLocalHostDistancePoolingOptions()

configureRemoteHostDistancePoolingOptions

protected com.datastax.driver.core.PoolingOptions configureRemoteHostDistancePoolingOptions(com.datastax.driver.core.PoolingOptions poolingOptions)

Configures the HostDistance.REMOTE connection settings on the given PoolingOptions.

Parameters:

poolingOptions - the PoolingOptions to configure.

Returns:

the given PoolingOptions.

See Also:

HostDistance.REMOTE, PoolingOptions, newRemoteHostDistancePoolingOptions()

getObject

public com.datastax.driver.core.PoolingOptions getObject()
                                                  throws Exception

Specified by:

getObject in interface FactoryBean<com.datastax.driver.core.PoolingOptions>

Throws:

Exception

getObjectType

public Class<?> getObjectType()

Specified by:

getObjectType in interface FactoryBean<com.datastax.driver.core.PoolingOptions>

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface FactoryBean<com.datastax.driver.core.PoolingOptions>

setHeartbeatIntervalSeconds

public void setHeartbeatIntervalSeconds(int heartbeatIntervalSeconds)

Sets the heart beat interval, after which a message is sent on an idle connection to make sure it's still alive.

Parameters:

heartbeatIntervalSeconds - interval in seconds between heartbeat messages to keep idle connections alive.

getHeartbeatIntervalSeconds

public int getHeartbeatIntervalSeconds()

Gets the heart beat interval, after which a message is sent on an idle connection to make sure it's still alive.

Returns:

the heartbeatIntervalSeconds.

setIdleTimeoutSeconds

public void setIdleTimeoutSeconds(int idleTimeoutSeconds)

Sets the timeout before an idle connection is removed.

Parameters:

idleTimeoutSeconds - idle timeout in seconds before a connection is removed.

getIdleTimeoutSeconds

public int getIdleTimeoutSeconds()

Get the timeout before an idle connection is removed.

Returns:

the idleTimeoutSeconds.

setInitializationExecutor

public void setInitializationExecutor(Executor initializationExecutor)

Sets the Executor to use for connection initialization.

Parameters:

initializationExecutor - Executor used to initialize the connection.

getInitializationExecutor

@Nullable
public Executor getInitializationExecutor()

Gets the Executor to use for connection initialization.

Returns:

the initializationExecutor.

setPoolTimeoutMilliseconds

public void setPoolTimeoutMilliseconds(int poolTimeoutMilliseconds)

Sets the timeout when trying to acquire a connection from a host's pool.

Parameters:

poolTimeoutMilliseconds - timeout in milliseconds used to acquire a connection from the host's pool.

getPoolTimeoutMilliseconds

public int getPoolTimeoutMilliseconds()

Gets the timeout when trying to acquire a connection from a host's pool.

Returns:

the poolTimeoutMilliseconds.

setMaxQueueSize

public void setMaxQueueSize(Integer maxQueueSize)

Sets the maximum number of requests that get enqueued if no connection is available.

Parameters:

maxQueueSize - maximum number of requests that get enqueued if no connection is available.

getMaxQueueSize

public Integer getMaxQueueSize()

Gets the maximum number of requests that get enqueued if no connection is available.

Returns:

the maxQueueSize.

setLocalCoreConnections

public void setLocalCoreConnections(@Nullable
                                    Integer localCoreConnections)

Sets the core number of connections per host for the HostDistance.LOCAL scope.

Parameters:

localCoreConnections - core number of local connections per host.

getLocalCoreConnections

@Nullable
public Integer getLocalCoreConnections()

Gets the core number of connections per host for the HostDistance.LOCAL scope.

Returns:

the {@code localCoreConnections).

setLocalMaxConnections

public void setLocalMaxConnections(@Nullable
                                   Integer localMaxConnections)

Sets the maximum number of connections per host for the HostDistance.LOCAL scope.

Parameters:

localMaxConnections - max number of local connections per host.

getLocalMaxConnections

@Nullable
public Integer getLocalMaxConnections()

Gets the maximum number of connections per host for the HostDistance.LOCAL scope.

Returns:

the localMaxConnections.

setLocalMaxSimultaneousRequests

public void setLocalMaxSimultaneousRequests(@Nullable
                                            Integer localMaxSimultaneousRequests)

Sets the maximum number of requests per connection for the HostDistance.LOCAL scope.

Parameters:

localMaxSimultaneousRequests - max number of requests for local connections.

getLocalMaxSimultaneousRequests

@Nullable
public Integer getLocalMaxSimultaneousRequests()

Gets the maximum number of requests per connection for the HostDistance.LOCAL scope.

Returns:

the localMaxSimultaneousRequests.

setLocalMinSimultaneousRequests

public void setLocalMinSimultaneousRequests(@Nullable
                                            Integer localMinSimultaneousRequests)

Sets the threshold that triggers the creation of a new connection to a host for the HostDistance.LOCAL scope.

Parameters:

localMinSimultaneousRequests - threshold triggering the creation of local connections to a host.

getLocalMinSimultaneousRequests

@Nullable
public Integer getLocalMinSimultaneousRequests()

Gets the threshold that triggers the creation of a new connection to a host for the HostDistance.LOCAL scope.

Returns:

the localMinSimultaneousRequests.

setRemoteCoreConnections

public void setRemoteCoreConnections(@Nullable
                                     Integer remoteCoreConnections)

Sets the core number of connections per host for the HostDistance.REMOTE scope.

Parameters:

remoteCoreConnections - core number of remote connections per host.

getRemoteCoreConnections

@Nullable
public Integer getRemoteCoreConnections()

Gets the core number of connections per host for the HostDistance.REMOTE scope.

Returns:

the {@code remoteCoreConnections).

setRemoteMaxConnections

public void setRemoteMaxConnections(@Nullable
                                    Integer remoteMaxConnections)

Sets the maximum number of connections per host for the HostDistance.REMOTE scope.

Parameters:

remoteMaxConnections - max number of remote connections per host.

getRemoteMaxConnections

@Nullable
public Integer getRemoteMaxConnections()

Gets the maximum number of connections per host for the HostDistance.REMOTE scope.

Returns:

the remoteMaxConnections.

setRemoteMaxSimultaneousRequests

public void setRemoteMaxSimultaneousRequests(@Nullable
                                             Integer remoteMaxSimultaneousRequests)

Sets the maximum number of requests per connection for the HostDistance.REMOTE scope.

Parameters:

remoteMaxSimultaneousRequests - max number of requests for local connections.

getRemoteMaxSimultaneousRequests

@Nullable
public Integer getRemoteMaxSimultaneousRequests()

Gets the maximum number of requests per connection for the HostDistance.REMOTE scope.

Returns:

the remoteMaxSimultaneousRequests.

setRemoteMinSimultaneousRequests

public void setRemoteMinSimultaneousRequests(@Nullable
                                             Integer remoteMinSimultaneousRequests)

Sets the threshold that triggers the creation of a new connection to a host for the HostDistance.REMOTE scope.

Parameters:

remoteMinSimultaneousRequests - threshold triggering the creation of remote connections to a host.

getRemoteMinSimultaneousRequests

@Nullable
public Integer getRemoteMinSimultaneousRequests()

Gets the threshold that triggers the creation of a new connection to a host for the HostDistance.REMOTE scope.

Returns:

the remoteMinSimultaneousRequests.