SystemProperties (GemFire XD Java API Documentation)

java.lang.Object
- com.gemstone.gemfire.internal.shared.SystemProperties

```
public final class SystemProperties
extends Object
```
Set the global system properties. This class is the supported way to change system properties before client (or server) side API is invoked that uses one or more properties defined in the class.

Since:

gfxd 1.1

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SystemProperties.Callbacks` Common internal product callbacks on client and server side to possibly plugin some system behaviour.
`static class`	`SystemProperties.DefaultCallbacks`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_DNS_CACHE_FLUSH_INTERVAL`
`static int`	`DEFAULT_DNS_CACHE_SIZE`
`static String`	`DEFAULT_GFXDCLIENT_PROPERTY_NAME_PREFIX`
`static int`	`DEFAULT_INPUT_BUFFER_SIZE`
`static int`	`DEFAULT_KEEPALIVE_CNT`
`static int`	`DEFAULT_KEEPALIVE_IDLE`
`static int`	`DEFAULT_KEEPALIVE_INTVL`
`static String`	`DEFAULT_LOG_FILE`
`static int`	`DEFAULT_OUTPUT_BUFFER_SIZE`
`static String`	`DEFAULT_PROPERTY_NAME_PREFIX`
`static String`	`DNS_CACHE_FLUSH_INTERVAL` Time interval in seconds after which `DNSCacheService` is flushed and refreshed on demand for DNS entries that do no specify a TTL.
`static String`	`DNS_CACHE_SIZE` The maximum size of `DNSCacheService`.
`static String`	`GFXD_FACTORY_PROVIDER`
`static String`	`KEEPALIVE_CNT_NAME` TCP KeepAlive COUNT for the network server and client sockets.
`static String`	`KEEPALIVE_IDLE_NAME` TCP KeepAlive IDLE timeout in seconds for the network server and client sockets.
`static String`	`KEEPALIVE_INTVL_NAME` TCP KeepAlive INTERVAL timeout in seconds for the network server and client sockets.
`static String`	`LOG_FILE_NAME` The name of the "logFile" property
`static String`	`READ_TIMEOUT_NAME` Read timeout for the connection, in seconds.
`static String`	`SOCKET_INPUT_BUFFER_SIZE_NAME` The socket buffer size to use for reading.
`static String`	`SOCKET_OUTPUT_BUFFER_SIZE_NAME` The socket buffer size to use for writing.
`static String`	`THRIFT_SELECTOR_SERVER` Whether to use selector based server (recommended) for the thrift server or per connection thread server model.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`getBoolean(String name, boolean defaultValue)`
`SystemProperties.Callbacks`	`getCallbacks()`
`static SystemProperties`	`getClientInstance()` Get an instance appropriate for client instances.
`int`	`getDNSCacheFlushInterval()`
`int`	`getDNSCacheSize()`
`static SystemProperties.Callbacks`	`getGFXDServerCallbacks()`
`int`	`getInteger(String name, int defaultValue)`
`int`	`getKeepAliveCount()`
`int`	`getKeepAliveIdle()`
`int`	`getKeepAliveInterval()`
`String`	`getLogFile()`
`long`	`getLong(String name, long defaultValue)`
`static SystemProperties`	`getServerInstance()` Get an instance appropriate for server instances.
`int`	`getSocketInputBufferSize()`
`int`	`getSocketOutputBufferSize()`
`String`	`getString(String name, String defaultValue)`
`String`	`getSystemPropertyNamePrefix()`
`static boolean`	`isUsingGemFireXDEntryPoint()`
`void`	`refreshProperties()`
`void`	`setCallbacks(SystemProperties.Callbacks cb)`
`void`	`setDNSCacheFlushInterval(int v)`
`void`	`setDNSCacheSize(int v)`
`void`	`setKeepAliveCount(int v)`
`void`	`setKeepAliveIdle(int v)`
`void`	`setKeepAliveInterval(int v)`
`void`	`setLogFile(String fileName)`
`void`	`setSocketInputBufferSize(int size)`
`void`	`setSocketOutputBufferSize(int size)`

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

- Field Detail
  - LOG_FILE_NAME
```
public static final String LOG_FILE_NAME
```
    The name of the "logFile" property
    
    See Also:
    Constant Field Values
  - SOCKET_INPUT_BUFFER_SIZE_NAME
```
public static final String SOCKET_INPUT_BUFFER_SIZE_NAME
```
    The socket buffer size to use for reading.
    
    See Also:
    Constant Field Values
  - SOCKET_OUTPUT_BUFFER_SIZE_NAME
```
public static final String SOCKET_OUTPUT_BUFFER_SIZE_NAME
```
    The socket buffer size to use for writing.
    
    See Also:
    Constant Field Values
  - READ_TIMEOUT_NAME
```
public static final String READ_TIMEOUT_NAME
```
    Read timeout for the connection, in seconds. Only for thin client connections.
    
    See Also:
    Constant Field Values
  - KEEPALIVE_IDLE_NAME
```
public static final String KEEPALIVE_IDLE_NAME
```
    TCP KeepAlive IDLE timeout in seconds for the network server and client sockets. This is the idle time after which a TCP KeepAlive probe is sent over the socket to determine if the other side is alive or not.
    
    See Also:
    Constant Field Values
  - KEEPALIVE_INTVL_NAME
```
public static final String KEEPALIVE_INTVL_NAME
```
    TCP KeepAlive INTERVAL timeout in seconds for the network server and client sockets. This is the time interval between successive TCP KeepAlive probes if there is no response to the previous probe (KEEPALIVE_IDLE_NAME) to determine if the other side is alive or not. Note that this may not be supported by all platforms (e.g. Solaris), in which case this will be ignored and an info-level message logged that the option could not be enabled on the socket.
    
    See Also:
    Constant Field Values
  - KEEPALIVE_CNT_NAME
```
public static final String KEEPALIVE_CNT_NAME
```
    TCP KeepAlive COUNT for the network server and client sockets. This is the number of TCP KeepAlive probes sent before declaring the other side to be dead. Note that this may not be supported by all platforms (e.g. Solaris), in which case this will be ignored and an info-level message logged that the option could not be enabled on the socket.
    
    See Also:
    Constant Field Values
  - DNS_CACHE_SIZE
```
public static final String DNS_CACHE_SIZE
```
    The maximum size of DNSCacheService. Zero or negative means to use Java default DNS cache and not DNSCacheService. Default is 0.
    
    See Also:
    Constant Field Values
  - DNS_CACHE_FLUSH_INTERVAL
```
public static final String DNS_CACHE_FLUSH_INTERVAL
```
    Time interval in seconds after which DNSCacheService is flushed and refreshed on demand for DNS entries that do no specify a TTL. A value of zero or negative means the cache is never flushed of such records. Default is 3600 seconds.
    
    See Also:
    Constant Field Values
  - THRIFT_SELECTOR_SERVER
```
public static final String THRIFT_SELECTOR_SERVER
```
    Whether to use selector based server (recommended) for the thrift server or per connection thread server model. Thrift SSL implementation cannot use selectors yet. Default is true for non-SSL and false for SSL.
    
    See Also:
    Constant Field Values
  - DEFAULT_PROPERTY_NAME_PREFIX
```
public static final String DEFAULT_PROPERTY_NAME_PREFIX
```
    See Also:
    Constant Field Values
  - DEFAULT_GFXDCLIENT_PROPERTY_NAME_PREFIX
```
public static final String DEFAULT_GFXDCLIENT_PROPERTY_NAME_PREFIX
```
    See Also:
    Constant Field Values
  - DEFAULT_LOG_FILE
```
public static String DEFAULT_LOG_FILE
```
  - DEFAULT_INPUT_BUFFER_SIZE
```
public static final int DEFAULT_INPUT_BUFFER_SIZE
```
    See Also:
    Constant Field Values
  - DEFAULT_OUTPUT_BUFFER_SIZE
```
public static final int DEFAULT_OUTPUT_BUFFER_SIZE
```
    See Also:
    Constant Field Values
  - DEFAULT_KEEPALIVE_IDLE
```
public static final int DEFAULT_KEEPALIVE_IDLE
```
    See Also:
    Constant Field Values
  - DEFAULT_KEEPALIVE_INTVL
```
public static final int DEFAULT_KEEPALIVE_INTVL
```
    See Also:
    Constant Field Values
  - DEFAULT_KEEPALIVE_CNT
```
public static final int DEFAULT_KEEPALIVE_CNT
```
    See Also:
    Constant Field Values
  - DEFAULT_DNS_CACHE_SIZE
```
public static final int DEFAULT_DNS_CACHE_SIZE
```
    See Also:
    Constant Field Values
  - DEFAULT_DNS_CACHE_FLUSH_INTERVAL
```
public static final int DEFAULT_DNS_CACHE_FLUSH_INTERVAL
```
    See Also:
    Constant Field Values
  - GFXD_FACTORY_PROVIDER
```
public static final String GFXD_FACTORY_PROVIDER
```
    See Also:
    Constant Field Values
- Method Detail
  - isUsingGemFireXDEntryPoint
```
public static boolean isUsingGemFireXDEntryPoint()
```
  - getServerInstance
```
public static SystemProperties getServerInstance()
```
    Get an instance appropriate for server instances. Usually this will use a different prefix and means of reading file properties than "client" instances.
  - getClientInstance
```
public static SystemProperties getClientInstance()
```
    Get an instance appropriate for client instances. Usually this will use a different prefix and means of reading file properties than "server" instances.
    NOTE: This will also read server prefixed instances as fallback to handle the case for few common properties (like in ClientSharedUtils) when used in JVMs that are configure to be both client and server.
  - getGFXDServerCallbacks
```
public static SystemProperties.Callbacks getGFXDServerCallbacks()
```
  - setCallbacks
```
public void setCallbacks(SystemProperties.Callbacks cb)
```
  - getCallbacks
```
public SystemProperties.Callbacks getCallbacks()
```
  - refreshProperties
```
public void refreshProperties()
```
  - getString
```
public String getString(String name,
               String defaultValue)
```
  - getInteger
```
public int getInteger(String name,
             int defaultValue)
```
  - getLong
```
public long getLong(String name,
           long defaultValue)
```
  - getBoolean
```
public boolean getBoolean(String name,
                 boolean defaultValue)
```
  - getSystemPropertyNamePrefix
```
public String getSystemPropertyNamePrefix()
```
  - getLogFile
```
public String getLogFile()
```
  - setLogFile
```
public void setLogFile(String fileName)
```
  - getSocketInputBufferSize
```
public int getSocketInputBufferSize()
```
  - setSocketInputBufferSize
```
public void setSocketInputBufferSize(int size)
```
  - getSocketOutputBufferSize
```
public int getSocketOutputBufferSize()
```
  - setSocketOutputBufferSize
```
public void setSocketOutputBufferSize(int size)
```
  - getKeepAliveIdle
```
public int getKeepAliveIdle()
```
  - setKeepAliveIdle
```
public void setKeepAliveIdle(int v)
```
  - getKeepAliveInterval
```
public int getKeepAliveInterval()
```
  - setKeepAliveInterval
```
public void setKeepAliveInterval(int v)
```
  - getKeepAliveCount
```
public int getKeepAliveCount()
```
  - setKeepAliveCount
```
public void setKeepAliveCount(int v)
```
  - getDNSCacheSize
```
public int getDNSCacheSize()
```
  - setDNSCacheSize
```
public void setDNSCacheSize(int v)
```
  - getDNSCacheFlushInterval
```
public int getDNSCacheFlushInterval()
```
  - setDNSCacheFlushInterval
```
public void setDNSCacheFlushInterval(int v)
```

Class SystemProperties

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG_FILE_NAME

SOCKET_INPUT_BUFFER_SIZE_NAME

SOCKET_OUTPUT_BUFFER_SIZE_NAME

READ_TIMEOUT_NAME

KEEPALIVE_IDLE_NAME

KEEPALIVE_INTVL_NAME

KEEPALIVE_CNT_NAME

DNS_CACHE_SIZE

DNS_CACHE_FLUSH_INTERVAL

THRIFT_SELECTOR_SERVER

DEFAULT_PROPERTY_NAME_PREFIX

DEFAULT_GFXDCLIENT_PROPERTY_NAME_PREFIX

DEFAULT_LOG_FILE

DEFAULT_INPUT_BUFFER_SIZE

DEFAULT_OUTPUT_BUFFER_SIZE

DEFAULT_KEEPALIVE_IDLE

DEFAULT_KEEPALIVE_INTVL

DEFAULT_KEEPALIVE_CNT

DEFAULT_DNS_CACHE_SIZE

DEFAULT_DNS_CACHE_FLUSH_INTERVAL

GFXD_FACTORY_PROVIDER

Method Detail

isUsingGemFireXDEntryPoint

getServerInstance

getClientInstance

getGFXDServerCallbacks

setCallbacks

getCallbacks

refreshProperties

getString

getInteger

getLong

getBoolean

getSystemPropertyNamePrefix

getLogFile

setLogFile

getSocketInputBufferSize

setSocketInputBufferSize

getSocketOutputBufferSize

setSocketOutputBufferSize

getKeepAliveIdle

setKeepAliveIdle

getKeepAliveInterval

setKeepAliveInterval

getKeepAliveCount

setKeepAliveCount

getDNSCacheSize

setDNSCacheSize

getDNSCacheFlushInterval

setDNSCacheFlushInterval