com.aquenos.cassandra.pvarchiver.server.spring

Class ServerProperties

java.lang.Object

com.aquenos.cassandra.pvarchiver.server.spring.ServerProperties

All Implemented Interfaces:

InitializingBean

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

Configuration properties for configuring the archive server. These properties define settings that may be different for different servers. This object is injected with properties having the server.* prefix.

The server.uuid property allows setting various options that are only desirable during development (e.g. turning off caches) in a single place.

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

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	logger Logger for this class.

Constructor Summary

Constructors

Constructor and Description
ServerProperties()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
int	getAdminPort() Returns the TCP port number on which the web server for the administrative interface listens.
int	getArchiveAccessPort() Returns the TCP port number on which the web server for the access to the archive listens.
int	getInterNodeCommunicationPort() Returns the TCP port number on which the web server for the inter-node communication listens.
InetAddress	getListenAddress() Returns the address on which the server is supposed to listen.
UUID	getUuid() Returns the UUID identifying this server or null if the UUID has not been set.
File	getUuidFile() Returns the file from which the current UUID has been read or null if the current UUID has not been read from a file.
void	setAdminPort(int adminPort) Sets the TCP port number on which the web server for the administrative interface listens.
void	setArchiveAccessPort(int archiveAccessPort) Sets the TCP port number on which the web server for the access to the archive listens.
void	setInterNodeCommunicationPort(int interNodeCommunicationPort) Sets the TCP port number on which the web server for the inter-node communication listens.
void	setListenAddress(String listenAddress) Sets the address on which the server is supposed to listen.
void	setUuid(String uuid) Sets the UUID identifying this server.
void	setUuidFile(File uuidFile) Sets the current UUID by reading it from a file.

Methods inherited from class java.lang.Object

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

Field Detail

logger

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

Logger for this class. The logger is responsible for writing diagnostic messages related to activities of this class.

Constructor Detail

ServerProperties

public ServerProperties()

Method Detail

getListenAddress

public InetAddress getListenAddress()

Returns the address on which the server is supposed to listen. If the address is not specified explicitly, it defaults to address returned by InetAddress.getLocalHost(). If that method returns a loop-back address, the first non-loop-back address found on any interface is used. If the first interface with valid addresses has both an IPv4 and an IPv6 address, the IPv4 address is preferred.

Returns:

address on which the server is supposed to listen (never null).

setListenAddress

public void setListenAddress(String listenAddress)
                      throws IllegalArgumentException

Sets the address on which the server is supposed to listen. If the address is not specified explicitly, it defaults to address returned by InetAddress.getLocalHost(). If that method returns a loop-back address, the first non-loop-back address found on any interface is used. If the first interface with valid addresses has both an IPv4 and an IPv6 address, the IPv4 address is preferred.

Parameters:

listenAddress - address on which the server is supposed to listen. May be specified in the form of a numeric address or a resolvable host-name. This should not be a loop-back address because other servers will try to contact this server on this address. If null or the empty string, the listen address is going to be determined automatically.

Throws:

IllegalArgumentException - if the specified listenAddress is neither null nor an empty string but cannot be converted to an InetAddress.

getAdminPort

public int getAdminPort()

Returns the TCP port number on which the web server for the administrative interface listens. This server offers access through a graphical user-interface and through a web-service API.

Returns:

TCP port number for the administrative interface.

setAdminPort

public void setAdminPort(int adminPort)

Sets the TCP port number on which the web server for the administrative interface listens. This server offers access through a graphical user-interface and through a web-service API. The default is 4812.

Parameters:

adminPort - TCP port number for the administrative interface.

Throws:

IllegalArgumentException - if the specified number is not a valid TCP port number.

getArchiveAccessPort

public int getArchiveAccessPort()

Returns the TCP port number on which the web server for the access to the archive listens. This server offers access to the data stored in the archive through a web-service API.

Returns:

TCP port number for the archive-access interface.

setArchiveAccessPort

public void setArchiveAccessPort(int archiveAccessPort)

Sets the TCP port number on which the web server for the access to the archive listens. This server offers access to the data stored in the archive through a web-service API. The default is 9812.

Parameters:

archiveAccessPort - TCP port number for the archive-access interface.

Throws:

IllegalArgumentException - if the specified number is not a valid TCP port number.

getInterNodeCommunicationPort

public int getInterNodeCommunicationPort()

Returns the TCP port number on which the web server for the inter-node communication listens. This server is used by the archive servers belonging to the same cluster in order to communicate with each other.

Returns:

TCP port number for the inter-node communication.

setInterNodeCommunicationPort

public void setInterNodeCommunicationPort(int interNodeCommunicationPort)

Sets the TCP port number on which the web server for the inter-node communication listens. This server is used by the archive servers belonging to the same cluster in order to communicate with each other. The default is 9813.

Parameters:

interNodeCommunicationPort - TCP port number for the inter-node communication interface.

Throws:

IllegalArgumentException - if the specified number is not a valid TCP port number.

getUuid

public UUID getUuid()

Returns the UUID identifying this server or null if the UUID has not been set. The UUID must be set in order for a server to operate correctly and must be unique within the whole cluster.

Returns:

UUID identifying this server or null if the UUID has not been set.

See Also:

setUuid(String), setUuidFile(File)

setUuid

public void setUuid(String uuid)

Sets the UUID identifying this server. The UUID must be set in order for a server to operate correctly and must be unique within the whole cluster. Setting the UUID through this method overwrites any UUID set previously through setUuid(String) or setUuidFile(File) . If the specified string does not represent a valid UUID, the UUID is set to null.

Parameters:

uuid - string representing the UUID to be set (may be null).

See Also:

setUuidFile(File)

getUuidFile

public File getUuidFile()

Returns the file from which the current UUID has been read or null if the current UUID has not been read from a file.

Returns:

file from which the current UUID has been read or null if the current UUID has not been read from a file.

setUuidFile

public void setUuidFile(File uuidFile)

Sets the current UUID by reading it from a file. If the specified file does not exist but can be created, a new random UUID is generated and written to the file. If the file does not exist and cannot be created or if the file exists but does not contain a valid UUID, this method does nothing.

Parameters:

uuidFile - file from which the UUID shall be read.

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception