com.cinchapi.concourse.config

Class ConcourseServerConfiguration

Object

Configuration

PreferencesHandler

ConcourseServerPreferences

ConcourseServerConfiguration

public class ConcourseServerConfiguration
extends ConcourseServerPreferences

A wrapper around the configuration files that can be used to configure Concourse Server.

Instantiate using from(Path...); providing paths to files in order from lowest to highest priority.

Method Summary

Modifier and Type	Method and Description
static ConcourseServerConfiguration	from(Path... files) Return a ConcourseServerConfiguration handler that is sourced from the files.
String	getBufferDirectory() The absolute path to the directory where the Buffer data is stored.
long	getBufferPageSize() The size for each page in the Buffer.
int	getClientPort() The listener port (1-65535) for client connections.
String	getDatabaseDirectory() The absolute path to the directory where the Database record and index files are stored.
String	getDefaultEnvironment() The default environment that is automatically loaded when the server starts and is used whenever a client does not specify an environment for its connection.
boolean	getEnableConsoleLogging() Determine whether log messages should also be printed to the console (STDOUT).
String	getJavaHome() The absolute path to the Java installation that Concourse Server should use.
int	getJmxPort() The listener port (1-65535) for management commands via JMX.
Level	getLogLevel() # The amount of runtime information logged by the system.
int	getShutdownPort() The listener port (1-65535) for shutdown commands.
void	setBufferDirectory(String bufferDirectory) Set the value associated with the buffer_directory key.
void	setBufferPageSize(long sizeInBytes) Set the value associated with the buffer_page_size key.
void	setClientPort(int clientPort) Set the value associated with the client_port key.
void	setDatabaseDirectory(String databaseDirectory) Set the value associated with the database_directory key.
void	setDefaultEnvironment(String defaultEnvironment) Set the value associated with the default_environment key.
void	setEnableConsoleLogging(boolean enableConsoleLogging) Set the value associated with the enable_console_logging key.
void	setJavaHome(String javaHome) Set the value associated with the java_home key.
void	setJmxPort(int port) Set the value associated with the jmx_port key.
void	setLogLevel(Level level) Set the value associated with the log_level key.
void	setShutdownPort(int shutdownPort) Set the value associated with the shutdown_port key.

Methods inherited from class ConcourseServerPreferences

open

Methods inherited from class PreferencesHandler

getEnum, getSize

Methods inherited from class Configuration

contains, containsIgnoreCaseFormat, get, get, getIgnoreCaseFormat, getIgnoreCaseFormat, getIgnoreCaseFormatOrDefault, getIgnoreCaseFormatOrDefault, getOrDefault, getOrDefault, override, set

Methods inherited from class Object

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

Method Detail

from

public static ConcourseServerConfiguration from(Path... files)

Return a ConcourseServerConfiguration handler that is sourced from the files.

Parameters:

files -

Returns:

the sources

getBufferDirectory

public String getBufferDirectory()

The absolute path to the directory where the Buffer data is stored. For optimal write performance, the Buffer should be placed on a separate disk partition (ideally a separate physical device) from the database_directory.

Specified by:

getBufferDirectory in class ConcourseServerPreferences

Returns:

the buffer directory

getBufferPageSize

public long getBufferPageSize()

The size for each page in the Buffer. During reads, Buffer pages are individually locked, so it is desirable to have several smaller pages as opposed to few larger ones. Nevertheless, be sure to balance the desire to maximize lock granularity with the risks of having too many open buffer files simultaneously.

Specified by:

getBufferPageSize in class ConcourseServerPreferences

Returns:

the buffer page size in bytes

getClientPort

public int getClientPort()

The listener port (1-65535) for client connections. Choose a port between 49152 and 65535 to minimize the possibility of conflicts with other services on this host.

Specified by:

getClientPort in class ConcourseServerPreferences

Returns:

the client port

getDatabaseDirectory

public String getDatabaseDirectory()

The absolute path to the directory where the Database record and index files are stored. For optimal performance, the Database should be placed on a separate disk partition (ideally a separate physical device) from the buffer_directory.

Specified by:

getDatabaseDirectory in class ConcourseServerPreferences

Returns:

the database directory

getDefaultEnvironment

public String getDefaultEnvironment()

The default environment that is automatically loaded when the server starts and is used whenever a client does not specify an environment for its connection.

Specified by:

getDefaultEnvironment in class ConcourseServerPreferences

Returns:

the default environment

getEnableConsoleLogging

public boolean getEnableConsoleLogging()

Determine whether log messages should also be printed to the console (STDOUT).

Specified by:

getEnableConsoleLogging in class ConcourseServerPreferences

Returns:

the determination whether to enable console logging

getJavaHome

public String getJavaHome()

The absolute path to the Java installation that Concourse Server should use.

Returns:

the java home path, or null if not configured

getJmxPort

public int getJmxPort()

The listener port (1-65535) for management commands via JMX. Choose a port between 49152 and 65535 to minimize the possibility of conflicts with other services on this host.

Specified by:

getJmxPort in class ConcourseServerPreferences

Returns:

the jmx port

getLogLevel

public Level getLogLevel()

# The amount of runtime information logged by the system. The options below are listed from least to most verbose. In addition to the indicated types of information, each level also logs the information for each less verbose level (i.e. ERROR only prints error messages, but INFO prints info, warn and error messages).

ERROR: critical information when the system reaches a potentially fatal state and may not operate normally.

WARN: useful information when the system reaches a less than ideal state but can continue to operate normally.

INFO: status information about the system that can be used for sanity checking.

DEBUG: detailed information about the system that can be used to diagnose bugs.

Logging is important, but may cause performance degradation. Only use the DEBUG level for staging environments or instances when detailed information is needed to diagnose a bug. Otherwise use the WARN or INFO levels.

Specified by:

getLogLevel in class ConcourseServerPreferences

Returns:

the log level

getShutdownPort

public int getShutdownPort()

The listener port (1-65535) for shutdown commands. Choose a port between 49152 and 65535 to minimize the possibility of conflicts with other services on this host.

Specified by:

getShutdownPort in class ConcourseServerPreferences

Returns:

the shutdown port

setBufferDirectory

public void setBufferDirectory(String bufferDirectory)

Set the value associated with the buffer_directory key.

Specified by:

setBufferDirectory in class ConcourseServerPreferences

Parameters:

bufferDirectory -

setBufferPageSize

public void setBufferPageSize(long sizeInBytes)

Set the value associated with the buffer_page_size key.

Specified by:

setBufferPageSize in class ConcourseServerPreferences

setClientPort

public void setClientPort(int clientPort)

Set the value associated with the client_port key.

Specified by:

setClientPort in class ConcourseServerPreferences

Parameters:

clientPort -

setDatabaseDirectory

public void setDatabaseDirectory(String databaseDirectory)

Set the value associated with the database_directory key.

Specified by:

setDatabaseDirectory in class ConcourseServerPreferences

Parameters:

databaseDirectory -

setDefaultEnvironment

public void setDefaultEnvironment(String defaultEnvironment)

Set the value associated with the default_environment key.

Specified by:

setDefaultEnvironment in class ConcourseServerPreferences

Parameters:

defaultEnvironment -

setEnableConsoleLogging

public void setEnableConsoleLogging(boolean enableConsoleLogging)

Set the value associated with the enable_console_logging key.

Specified by:

setEnableConsoleLogging in class ConcourseServerPreferences

Parameters:

enableConsoleLogging -

setJavaHome

public void setJavaHome(String javaHome)

Set the value associated with the java_home key.

Parameters:

javaHome - the absolute path to the Java installation

setJmxPort

public void setJmxPort(int port)

Set the value associated with the jmx_port key.

Specified by:

setJmxPort in class ConcourseServerPreferences

Parameters:

port -

setLogLevel

public void setLogLevel(Level level)

Set the value associated with the log_level key.

Specified by:

setLogLevel in class ConcourseServerPreferences

Parameters:

level -

setShutdownPort

public void setShutdownPort(int shutdownPort)

Set the value associated with the shutdown_port key.

Specified by:

setShutdownPort in class ConcourseServerPreferences

Parameters:

shutdownPort -