com.cinchapi.concourse.config

Class ConcourseServerPreferences

Object

Configuration

PreferencesHandler

ConcourseServerPreferences

public class ConcourseServerPreferences
extends PreferencesHandler

A wrapper around the concourse.prefs file that is used to configure the server.

Instantiate using open(String)

Method Summary

Modifier and Type	Method and Description
static ConcourseServerPreferences	from(Path... files) Return a ConcourseServerPreferences 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).
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.
static ConcourseServerPreferences	open(String file) Deprecated. use from(Path...) instead
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	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 PreferencesHandler

getEnum, getSize

Methods inherited from class Configuration

get, get, getOrDefault, getOrDefault, override, set

Methods inherited from class Object

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

Method Detail

open

@Deprecated
public static ConcourseServerPreferences open(String file)

Deprecated. use from(Path...) instead

Return a ConcourseServerPreferences handler that is backed by the configuration information in file.

Parameters:

file - the absolute path to the preferences file (relative paths will resolve to the user's home directory)

Returns:

the preferences handler

from

public static ConcourseServerPreferences from(Path... files)

Return a ConcourseServerPreferences 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.

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.

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.

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.

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.

Returns:

the default environment

getEnableConsoleLogging

public boolean getEnableConsoleLogging()

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

Returns:

the determination whether to enable console logging

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.

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.

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.

Returns:

the shutdown port

setBufferDirectory

public void setBufferDirectory(String bufferDirectory)

Set the value associated with the buffer_directory key.

Parameters:

bufferDirectory -

setBufferPageSize

public void setBufferPageSize(long sizeInBytes)

Set the value associated with the buffer_page_size key.

setClientPort

public void setClientPort(int clientPort)

Set the value associated with the client_port key.

Parameters:

clientPort -

setDatabaseDirectory

public void setDatabaseDirectory(String databaseDirectory)

Set the value associated with the database_directory key.

Parameters:

databaseDirectory -

setDefaultEnvironment

public void setDefaultEnvironment(String defaultEnvironment)

Set the value associated with the default_environment key.

Parameters:

defaultEnvironment -

setEnableConsoleLogging

public void setEnableConsoleLogging(boolean enableConsoleLogging)

Set the value associated with the enable_console_logging key.

Parameters:

enableConsoleLogging -

setJmxPort

public void setJmxPort(int port)

Set the value associated with the jmx_port key.

Parameters:

port -

setLogLevel

public void setLogLevel(Level level)

Set the value associated with the log_level key.

Parameters:

level -

setShutdownPort

public void setShutdownPort(int shutdownPort)

Set the value associated with the shutdown_port key.

Parameters:

shutdownPort -