ConcourseServerPreferences (Concourse Java API)

Object
- Configuration
- - PreferencesHandler
  - - ConcourseServerPreferences

Direct Known Subclasses:

ConcourseServerConfiguration

Deprecated.
Use ConcourseServerConfiguration instead
```
@Deprecated
public abstract class ConcourseServerPreferences
extends PreferencesHandler
```
A wrapper around the concourse.prefs file that is used to configure the server.
Instantiate using open(String)

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static ConcourseServerPreferences`	`from(Path... files)` Deprecated. Return a `ConcourseServerPreferences` handler that is sourced from the `files`.
`abstract String`	`getBufferDirectory()` Deprecated. The absolute path to the directory where the Buffer data is stored.
`abstract long`	`getBufferPageSize()` Deprecated. The size for each page in the Buffer.
`abstract int`	`getClientPort()` Deprecated. The listener port (1-65535) for client connections.
`abstract String`	`getDatabaseDirectory()` Deprecated. The absolute path to the directory where the Database record and index files are stored.
`abstract String`	`getDefaultEnvironment()` Deprecated. 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.
`abstract boolean`	`getEnableConsoleLogging()` Deprecated. Determine whether log messages should also be printed to the console (STDOUT).
`abstract int`	`getJmxPort()` Deprecated. The listener port (1-65535) for management commands via JMX.
`abstract Level`	`getLogLevel()` Deprecated. # The amount of runtime information logged by the system.
`abstract int`	`getShutdownPort()` Deprecated. The listener port (1-65535) for shutdown commands.
`static ConcourseServerPreferences`	`open(String file)` Deprecated. use `from(Path...)` instead
`abstract void`	`setBufferDirectory(String bufferDirectory)` Deprecated. Set the value associated with the `buffer_directory` key.
`abstract void`	`setBufferPageSize(long sizeInBytes)` Deprecated. Set the value associated with the `buffer_page_size` key.
`abstract void`	`setClientPort(int clientPort)` Deprecated. Set the value associated with the `client_port` key.
`abstract void`	`setDatabaseDirectory(String databaseDirectory)` Deprecated. Set the value associated with the `database_directory` key.
`abstract void`	`setDefaultEnvironment(String defaultEnvironment)` Deprecated. Set the value associated with the `default_environment` key.
`abstract void`	`setEnableConsoleLogging(boolean enableConsoleLogging)` Deprecated. Set the value associated with the `enable_console_logging` key.
`abstract void`	`setJmxPort(int port)` Deprecated. Set the value associated with the `jmx_port` key.
`abstract void`	`setLogLevel(Level level)` Deprecated. Set the value associated with the `log_level` key.
`abstract void`	`setShutdownPort(int shutdownPort)` Deprecated. Set the value associated with the `shutdown_port` key.

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
  - 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)
```
    Deprecated.
    
    Return a ConcourseServerPreferences handler that is sourced from the files.
    
    Parameters:
    
    files -
    
    Returns:
    
    the sources
  - getBufferDirectory
```
public abstract String getBufferDirectory()
```
    Deprecated.
    
    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 abstract long getBufferPageSize()
```
    Deprecated.
    
    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 abstract int getClientPort()
```
    Deprecated.
    
    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 abstract String getDatabaseDirectory()
```
    Deprecated.
    
    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 abstract String getDefaultEnvironment()
```
    Deprecated.
    
    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 abstract boolean getEnableConsoleLogging()
```
    Deprecated.
    
    Determine whether log messages should also be printed to the console (STDOUT).
    
    Returns:
    
    the determination whether to enable console logging
  - getJmxPort
```
public abstract int getJmxPort()
```
    Deprecated.
    
    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 abstract Level getLogLevel()
```
    Deprecated.
    
    # 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 abstract int getShutdownPort()
```
    Deprecated.
    
    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 abstract void setBufferDirectory(String bufferDirectory)
```
    Deprecated.
    
    Set the value associated with the buffer_directory key.
    
    Parameters:
    
    bufferDirectory -
  - setBufferPageSize
```
public abstract void setBufferPageSize(long sizeInBytes)
```
    Deprecated.
    
    Set the value associated with the buffer_page_size key.
  - setClientPort
```
public abstract void setClientPort(int clientPort)
```
    Deprecated.
    
    Set the value associated with the client_port key.
    
    Parameters:
    
    clientPort -
  - setDatabaseDirectory
```
public abstract void setDatabaseDirectory(String databaseDirectory)
```
    Deprecated.
    
    Set the value associated with the database_directory key.
    
    Parameters:
    
    databaseDirectory -
  - setDefaultEnvironment
```
public abstract void setDefaultEnvironment(String defaultEnvironment)
```
    Deprecated.
    
    Set the value associated with the default_environment key.
    
    Parameters:
    
    defaultEnvironment -
  - setEnableConsoleLogging
```
public abstract void setEnableConsoleLogging(boolean enableConsoleLogging)
```
    Deprecated.
    
    Set the value associated with the enable_console_logging key.
    
    Parameters:
    
    enableConsoleLogging -
  - setJmxPort
```
public abstract void setJmxPort(int port)
```
    Deprecated.
    
    Set the value associated with the jmx_port key.
    
    Parameters:
    
    port -
  - setLogLevel
```
public abstract void setLogLevel(Level level)
```
    Deprecated.
    
    Set the value associated with the log_level key.
    
    Parameters:
    
    level -
  - setShutdownPort
```
public abstract void setShutdownPort(int shutdownPort)
```
    Deprecated.
    
    Set the value associated with the shutdown_port key.
    
    Parameters:
    
    shutdownPort -

Class ConcourseServerPreferences

Method Summary

Methods inherited from class PreferencesHandler

Methods inherited from class Configuration

Methods inherited from class Object

Method Detail

open

from

getBufferDirectory

getBufferPageSize

getClientPort

getDatabaseDirectory

getDefaultEnvironment

getEnableConsoleLogging

getJmxPort

getLogLevel

getShutdownPort

setBufferDirectory

setBufferPageSize

setClientPort

setDatabaseDirectory

setDefaultEnvironment

setEnableConsoleLogging

setJmxPort

setLogLevel

setShutdownPort