ServerConfiguration (org.macroing.cit.server API)

java.lang.Object
- org.macroing.cit.server.ServerConfiguration

```
public final class ServerConfiguration
extends java.lang.Object
```
A class for handling Server configuration.

Since:

1.0.0

Author:

Jörgen Lundgren

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DOMAIN_NAME_SYSTEM_53` The port for DNS with a port number of `53`.
`static int`	`FILE_TRANSFER_PROTOCOL_20` The port for FTP with a port number of `20`.
`static int`	`FILE_TRANSFER_PROTOCOL_21` The port for FTP with a port number of `21`.
`static int`	`HYPERTEXT_TRANSFER_PROTOCOL_80` The port for HTTP with a port number of `80`.
`static int`	`HYPERTEXT_TRANSFER_PROTOCOL_SECURE_443` The port for HTTPS with a port number of `443`.
`static int`	`INTERNET_MESSAGE_ACCESS_PROTOCOL_143` The port for IMAP with a port number of `143`.
`static int`	`NETWORK_NEWS_TRANSFER_PROTOCOL_119` The port for NNTP with a port number of `119`.
`static int`	`PORT_NUMBER_MAXIMUM` The maximum port number allowed.
`static int`	`PORT_NUMBER_MINIMUM` The minimum port number allowed.
`static int`	`POST_OFFICE_PROTOCOL_110` The port for POP with a port number of `110`.
`static int`	`SECURE_SHELL_22` The port for SSH with a port number of `22`.
`static int`	`SIMPLE_MAIL_TRANSFER_PROTOCOL_25` The port for SMTP with a port number of `25`.
`static int`	`SIMPLE_NETWORK_MANAGEMENT_PROTOCOL_161` The port for SNMP with a port number of `161`.
`static int`	`TELNET_23` The port for TelNet with a port number of `23`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.concurrent.Executor`	`getExecutor()` Returns the `Executor` that will process events.
`java.lang.String`	`getHostname()` Returns the currently set hostname.
`int`	`getPort()` Returns the currently set port.
`org.macroing.cit.network.Protocol`	`getProtocol()` Returns the currently set `Protocol`.
`int`	`getReceiveBufferSize()` Returns the size of the buffer containing the received data.
`int`	`getSendBufferSize()` Returns the size of the buffer containing the data to send.
`int`	`getThreadCount()` Returns the `Thread` count to use when processing events.
`boolean`	`isDisconnectOnUnbindEnabled()` Returns `true` if, and only if, disconnection should occur on unbind, `false` otherwise.
`boolean`	`isTCPNoDelayEnabled()` Returns the current TCP_NODELAY configuration.
`static ServerConfiguration`	`newInstance()` Returns a new `ServerConfiguration` instance.
`void`	`setDisconnectOnUnbindEnabled(boolean isDisconnectOnUnbindEnabled)` Sets the disconnect on unbind configuration for this `ServerConfiguration` instance.
`void`	`setExecutor(java.util.concurrent.Executor executor)` Sets the `Executor` that will be used to process events.
`void`	`setHostname(java.lang.String hostname)` Sets a hostname for this `ServerConfiguration`.
`void`	`setPort(int port)` Sets a port for this `ServerConfiguration`.
`void`	`setProtocol(org.macroing.cit.network.Protocol protocol)` Sets a `Protocol` for this `ServerConfiguration`.
`void`	`setReceiveBufferSize(int receiveBufferSize)` Sets the size of the buffer that will contain received data.
`void`	`setSendBufferSize(int sendBufferSize)` Sets the size of the buffer that will contain data to be sent.
`void`	`setTCPNoDelayEnabled(boolean isTCPNoDelayEnabled)` Sets a new TCP_NODELAY configuration for this `ServerConfiguration`.
`void`	`setThreadCount(int threadCount)` Sets the `Thread` count that will be used when processing events.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DOMAIN_NAME_SYSTEM_53
```
public static final int DOMAIN_NAME_SYSTEM_53
```
    The port for DNS with a port number of 53.
    
    See Also:
    
    Constant Field Values
  - FILE_TRANSFER_PROTOCOL_20
```
public static final int FILE_TRANSFER_PROTOCOL_20
```
    The port for FTP with a port number of 20.
    
    See Also:
    
    Constant Field Values
  - FILE_TRANSFER_PROTOCOL_21
```
public static final int FILE_TRANSFER_PROTOCOL_21
```
    The port for FTP with a port number of 21.
    
    See Also:
    
    Constant Field Values
  - HYPERTEXT_TRANSFER_PROTOCOL_SECURE_443
```
public static final int HYPERTEXT_TRANSFER_PROTOCOL_SECURE_443
```
    The port for HTTPS with a port number of 443.
    
    See Also:
    
    Constant Field Values
  - HYPERTEXT_TRANSFER_PROTOCOL_80
```
public static final int HYPERTEXT_TRANSFER_PROTOCOL_80
```
    The port for HTTP with a port number of 80.
    
    See Also:
    
    Constant Field Values
  - INTERNET_MESSAGE_ACCESS_PROTOCOL_143
```
public static final int INTERNET_MESSAGE_ACCESS_PROTOCOL_143
```
    The port for IMAP with a port number of 143.
    
    See Also:
    
    Constant Field Values
  - NETWORK_NEWS_TRANSFER_PROTOCOL_119
```
public static final int NETWORK_NEWS_TRANSFER_PROTOCOL_119
```
    The port for NNTP with a port number of 119.
    
    See Also:
    
    Constant Field Values
  - PORT_NUMBER_MAXIMUM
```
public static final int PORT_NUMBER_MAXIMUM
```
    The maximum port number allowed.
    
    See Also:
    
    Constant Field Values
  - PORT_NUMBER_MINIMUM
```
public static final int PORT_NUMBER_MINIMUM
```
    The minimum port number allowed.
    
    See Also:
    
    Constant Field Values
  - POST_OFFICE_PROTOCOL_110
```
public static final int POST_OFFICE_PROTOCOL_110
```
    The port for POP with a port number of 110.
    
    See Also:
    
    Constant Field Values
  - SECURE_SHELL_22
```
public static final int SECURE_SHELL_22
```
    The port for SSH with a port number of 22.
    
    See Also:
    
    Constant Field Values
  - SIMPLE_MAIL_TRANSFER_PROTOCOL_25
```
public static final int SIMPLE_MAIL_TRANSFER_PROTOCOL_25
```
    The port for SMTP with a port number of 25.
    
    See Also:
    
    Constant Field Values
  - SIMPLE_NETWORK_MANAGEMENT_PROTOCOL_161
```
public static final int SIMPLE_NETWORK_MANAGEMENT_PROTOCOL_161
```
    The port for SNMP with a port number of 161.
    
    See Also:
    
    Constant Field Values
  - TELNET_23
```
public static final int TELNET_23
```
    The port for TelNet with a port number of 23.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isDisconnectOnUnbindEnabled
```
public boolean isDisconnectOnUnbindEnabled()
```
    Returns true if, and only if, disconnection should occur on unbind, false otherwise.
    By default, this configuration is turned on.
    
    Returns:
    
    true if, and only if, disconnection should occur on unbind, false otherwise
  - isTCPNoDelayEnabled
```
public boolean isTCPNoDelayEnabled()
```
    Returns the current TCP_NODELAY configuration.
    By default, TCP_NODELAY will be turned off.
    
    Returns:
    
    the current TCP_NODELAY configuration
  - getExecutor
```
public java.util.concurrent.Executor getExecutor()
```
    Returns the Executor that will process events.
    By default, Executors.newCachedThreadPool() will be used.
    
    Returns:
    
    the Executor that will process events
  - getPort
```
public int getPort()
```
    Returns the currently set port.
    If no port has been explicitly set, ServerConfiguration.HYPERTEXT_TRANSFER_PROTOCOL_80 will be returned.
    
    Returns:
    
    the currently set port
  - getReceiveBufferSize
```
public int getReceiveBufferSize()
```
    Returns the size of the buffer containing the received data.
    By default, the size is set to 5000.
    
    Returns:
    
    the size of the buffer containing the received data
  - getSendBufferSize
```
public int getSendBufferSize()
```
    Returns the size of the buffer containing the data to send.
    By default, the size is set to 5000.
    
    Returns:
    
    the size of the buffer containing the data to send
  - getThreadCount
```
public int getThreadCount()
```
    Returns the Thread count to use when processing events.
    By default, the count is set to Runtime.getRuntime().availableProcessors() + 1.
    
    Returns:
    
    the Thread count to use when processing events
  - getProtocol
```
public org.macroing.cit.network.Protocol getProtocol()
```
    Returns the currently set Protocol.
    If no Protocol has been explicitly set, a default Protocol will be returned.
    This default Protocol forwards the Message as is, and no transformations or optimizations are performed.
    
    Returns:
    
    the currently set Protocol
  - getHostname
```
public java.lang.String getHostname()
```
    Returns the currently set hostname.
    If no hostname has been explicitly set, a default hostname will be returned.
    This default hostname is "127.0.0.1".
    
    Returns:
    
    the currently set hostname
  - setDisconnectOnUnbindEnabled
```
public void setDisconnectOnUnbindEnabled(boolean isDisconnectOnUnbindEnabled)
```
    Sets the disconnect on unbind configuration for this ServerConfiguration instance.
    By default, this configuration is turned on.
    
    Parameters:
    
    isDisconnectOnUnbindEnabled - true if, and only if, unbinding should cause disconnection, false otherwise
  - setExecutor
```
public void setExecutor(java.util.concurrent.Executor executor)
```
    Sets the Executor that will be used to process events.
    By default, Executors.newCachedThreadPool() will be used.
    If executor is null, a NullPointerException will be thrown.
    
    Parameters:
    
    executor - the Executor that will be used to process events
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, executor is null
  - setHostname
```
public void setHostname(java.lang.String hostname)
```
    Sets a hostname for this ServerConfiguration.
    If hostname is null, a NullPointerException will be thrown.
    
    Parameters:
    
    hostname - the hostname to set
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, hostname is null
  - setPort
```
public void setPort(int port)
```
    Sets a port for this ServerConfiguration.
    If port is less than ServerConfiguration.PORT_NUMBER_MINIMUM, or greater than ServerConfiguration.PORT_NUMBER_MAXIMUM, an IllegalArgumentException will be thrown.
    
    Parameters:
    
    port - the port to set
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if, and only if, port is less than ServerConfiguration.PORT_NUMBER_MINIMUM, or greater than ServerConfiguration.PORT_NUMBER_MAXIMUM
  - setProtocol
```
public void setProtocol(org.macroing.cit.network.Protocol protocol)
```
    Sets a Protocol for this ServerConfiguration.
    If protocol is null, a NullPointerException will be thrown.
    
    Parameters:
    
    protocol - the Protocol to be set
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, protocol is null
  - setReceiveBufferSize
```
public void setReceiveBufferSize(int receiveBufferSize)
```
    Sets the size of the buffer that will contain received data.
    By default, the size is set to 5000.
    If receiveBufferSize is less than 0, an IllegalArgumentException will be thrown.
    
    Parameters:
    
    receiveBufferSize - the size of the buffer that will contain received data
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if, and only if, receiveBufferSize is less than 0
  - setSendBufferSize
```
public void setSendBufferSize(int sendBufferSize)
```
    Sets the size of the buffer that will contain data to be sent.
    By default, the size is set to 5000.
    If sendBufferSize is less than 0, an IllegalArgumentException will be thrown.
    
    Parameters:
    
    sendBufferSize - the size of the buffer that will contain data to be sent
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if, and only if, sendBufferSize is less than 0
  - setTCPNoDelayEnabled
```
public void setTCPNoDelayEnabled(boolean isTCPNoDelayEnabled)
```
    Sets a new TCP_NODELAY configuration for this ServerConfiguration.
    By default, TCP_NODELAY will be turned off.
    
    Parameters:
    
    isTCPNoDelayEnabled - the TCP_NODELAY configuration to use
  - setThreadCount
```
public void setThreadCount(int threadCount)
```
    Sets the Thread count that will be used when processing events.
    By default, the count is set to Runtime.getRuntime().availableProcessors() + 1.
    If threadCount is less than 1, an IllegalArgumentException will be thrown.
    
    Parameters:
    
    threadCount - the Thread count that will be used when processing events
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if, and only if, threadCount is less than 1
  - newInstance
```
public static ServerConfiguration newInstance()
```
    Returns a new ServerConfiguration instance.
    
    Returns:
    
    a new ServerConfiguration instance

Class ServerConfiguration

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DOMAIN_NAME_SYSTEM_53

FILE_TRANSFER_PROTOCOL_20

FILE_TRANSFER_PROTOCOL_21

HYPERTEXT_TRANSFER_PROTOCOL_SECURE_443

HYPERTEXT_TRANSFER_PROTOCOL_80

INTERNET_MESSAGE_ACCESS_PROTOCOL_143

NETWORK_NEWS_TRANSFER_PROTOCOL_119

PORT_NUMBER_MAXIMUM

PORT_NUMBER_MINIMUM

POST_OFFICE_PROTOCOL_110

SECURE_SHELL_22

SIMPLE_MAIL_TRANSFER_PROTOCOL_25

SIMPLE_NETWORK_MANAGEMENT_PROTOCOL_161

TELNET_23

Method Detail

isDisconnectOnUnbindEnabled

isTCPNoDelayEnabled

getExecutor

getPort

getReceiveBufferSize

getSendBufferSize

getThreadCount

getProtocol

getHostname

setDisconnectOnUnbindEnabled

setExecutor

setHostname

setPort

setProtocol

setReceiveBufferSize

setSendBufferSize

setTCPNoDelayEnabled

setThreadCount

newInstance