com.aquenos.cassandra.pvarchiver.server.spring

Class CassandraProperties

java.lang.Object

com.aquenos.cassandra.pvarchiver.server.spring.CassandraProperties

All Implemented Interfaces:

InitializingBean

@ConfigurationProperties(prefix="cassandra",
                         ignoreUnknownFields=false)
public class CassandraProperties
extends Object
implements InitializingBean

Configuration properties that provide the configuration for the CassandraProvider. This object is injected with properties having the cassandra.* prefix.

The following properties are supported by this configuration object:

• cassandra.hosts (see getHosts())
• cassandra.port (see getPort(), setPort(int))
• cassandra.username (see getUsername(), setUsername(String))
• cassandra.password (see getPassword(), setPassword(String))
• cassandra.keyspace (see getKeyspace(), setKeyspace(String))
• cassandra.useLocalConsistencyLevel (see isUseLocalConsistencyLevel(), setUseLocalConsistencyLevel(boolean))

Instances of this class are safe for concurrent read access but are not safe for concurrent write access. Typically, this should not be a problem because an instance of this class is initialized once at application startup and then only used for read access.

Author:

Sebastian Marsching

Constructor Summary

Constructors

Constructor and Description
CassandraProperties() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
List<String>	getHosts() Returns the list of hosts that are uses to discover the cluster topology when initially connecting to the Cassandra cluster.
String	getKeyspace() Returns the name of the keyspace that is used by the Cassandra PV Archiver.
String	getPassword() Returns the password that is used in combination with the username in order to authenticate with the Cassandra cluster.
int	getPort() Returns the port number on which the Cassandra database servers listen.
String	getUsername() Returns the username used in combination with the password in order to authenticate with the Cassandra cluster.
boolean	isUseLocalConsistencyLevel() Tells whether the LOCAL_ variants of the consistency levels shall be used.
void	setKeyspace(String keyspace) Sets the name of the keyspace that is used by the Cassandra PV Archiver.
void	setPassword(String password) Sets the password that is used in combination with the username in order to authenticate with the Cassandra cluster.
void	setPort(int port) Sets the port number on which the Cassandra database servers listen.
void	setUseLocalConsistencyLevel(boolean useLocalConsistencyLevel) Defines whether the LOCAL_ variants of the consistency levels shall be used.
void	setUsername(String username) Sets the username used in combination with the password in order to authenticate with the Cassandra cluster.

Methods inherited from class java.lang.Object

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

Constructor Detail

CassandraProperties

public CassandraProperties()

Default constructor. Sets the list of hosts to contain "localhost", the port number to 9042, the keyspace to "pv_archive", and useLocalConsistencyLevel to false.

Method Detail

getHosts

public List<String> getHosts()

Returns the list of hosts that are uses to discover the cluster topology when initially connecting to the Cassandra cluster. Once the topology has been discovered, all servers in the cluster are used. However, it still makes sense to specify several servers so that the connection with the cluster can be established when one of the servers is down.

After initialization is complete ( afterPropertiesSet() has been called), the list returned by this method is read-only and attempts to modify it will result in an UnsupportedOperationException. Before that, the list can be modified so that the property injection mechanism provided by Spring can work.

This method never returns null. After afterPropertiesSet() has been called, the list is guaranteed to not contain any null elements. If null elements have been added to the list, afterPropertiesSet() will throw a NullPointerException.

Returns:

list of hosts that can be used when initially connecting to the Cassandra cluster.

getKeyspace

public String getKeyspace()

Returns the name of the keyspace that is used by the Cassandra PV Archiver. The default is "pv_archive".

Returns:

name of the keyspace that is used by the archiver instance.

setKeyspace

public void setKeyspace(String keyspace)

Sets the name of the keyspace that is used by the Cassandra PV Archiver. The default is "pv_archive".

Parameters:

keyspace - name of the keyspace that shall be used.

Throws:

NullPointerException - if keyspace is null).

isUseLocalConsistencyLevel

public boolean isUseLocalConsistencyLevel()

Tells whether the LOCAL_ variants of the consistency levels shall be used. One might want to use these variants if all archiver nodes are operating in the same datacenter, but the Cassandra cluster has a second datacenter that is used for replication (read-only). In this case, the archiver can continue operation when the connection to the second datacenter is interrupted. The default is false.

Returns:

true if the LOCAL_ variants of the consistency levels should be used (e.g. LOCAL_QUORUM instead of QUORUM), false if the regular (global) consistency levels should be used.

setUseLocalConsistencyLevel

public void setUseLocalConsistencyLevel(boolean useLocalConsistencyLevel)

Defines whether the LOCAL_ variants of the consistency levels shall be used. One might want to use these variants if all archiver nodes are operating in the same datacenter, but the Cassandra cluster has a second datacenter that is used for replication (read-only). In this case, the archiver can continue operation when the connection to the second datacenter is interrupted. The default is false.

Parameters:

useLocalConsistencyLevel - true if the LOCAL_ variants of the consistency levels should be used (e.g. LOCAL_QUORUM instead of QUORUM), false if the regular (global) consistency levels should be used.

getPassword

public String getPassword()

Returns the password that is used in combination with the username in order to authenticate with the Cassandra cluster.

Returns:

password used for authentication or null (or the empty string) if no password has been set.

See Also:

getUsername()

setPassword

public void setPassword(String password)

Sets the password that is used in combination with the username in order to authenticate with the Cassandra cluster.

Parameters:

password - password used for authentication (or null or the empty string if no password is required).

See Also:

setUsername(String)

getPort

public int getPort()

Returns the port number on which the Cassandra database servers listen. This port number must be identical for all hosts in the Cassandra cluster. The default is 9042.

Returns:

port number of the Cassandra database server(s).

setPort

public void setPort(int port)

Sets the port number on which the Cassandra database servers listen. This port number must be identical for all hosts in the Cassandra cluster. The default is 9042.

Parameters:

port - port number of the Cassandra database server(s).

Throws:

IllegalArgumentException - if port is less than 1 or greater than 65535.

getUsername

public String getUsername()

Returns the username used in combination with the password in order to authenticate with the Cassandra cluster. If empty or null, no authentication attempt is made and anonymous access is used. The default is null.

Returns:

username used for authentication or null (or the empty string) if anonymous access shall be used.

See Also:

getPassword()

setUsername

public void setUsername(String username)

Sets the username used in combination with the password in order to authenticate with the Cassandra cluster. If empty or null, no authentication attempt is made and anonymous access is used. The default is null.

Parameters:

username - username used for authentication or null (or the empty string) if anonymous access shall be used.

See Also:

setPassword(String)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception