Return-Path:
+ * Description:
+ * The number of seconds the distributed
+ * system will wait after the ack-wait-threshold for a message to be
+ * acknowledged before it issues an alert at severe level. The
+ * default value is zero, which turns off this feature.
+ * When ack-severe-alert-threshold is used, GemFire will also initiate
+ * additional checks to see if the process is alive. These checks will
+ * begin when the ack-wait-threshold is reached and will continue until
+ * GemFire has been able to communicate with the process and ascertain its
+ * status.
+ * Default: "0"
+ *
+ * Allowed values: 0..2147483647
*/
String ACK_SEVERE_ALERT_THRESHOLD = "ack-severe-alert-threshold";
/**
- * The static definition of the "ack-wait-threshold"
- * property
+ * The static String definition of the "ack-wait-threshold" property
+ *
+ * Description: The IP address that this distributed system's + * server sockets will listen on. + * If set to an empty string then the local machine's + * default address will be listened on. + *
+ * Default: "" */ String BIND_ADDRESS = "bind-address"; /** - * The static definition of the "cache-xml-file" - * property + * The static String definition of the "cache-xml-file" property + *
+ * Description: Specifies the name of the XML file or resource + * to initialize the cache with when it is + * {@linkplain com.gemstone.gemfire.cache.CacheFactory#create created}. + * Create will first look for a file that matches the value of this property. + * If a file is not found then it will be searched for using + * {@link java.lang.ClassLoader#getResource}. If the value of this + * property is the empty string (""
), then the cache
+ * will not be declaratively initialized.
+ * Default: "cache.xml"
*/
String CACHE_XML_FILE = "cache-xml-file";
/**
- * The static definition of the "cluster-configuration-dir"
- * property
+ * The static String definition of the "cluster-configuration-dir" property
+ *
+ * Description: This property specifies the directory in which the cluster configuration related disk-store and artifacts are stored
+ * This property is only applicable to dedicated locators which have "enable-cluster-configuration" set to true.
+ *
+ * Default: ""
+ * Since: GemFire 8.1
*/
String CLUSTER_CONFIGURATION_DIR = "cluster-configuration-dir";
/**
- * The static definition of the "cluster-ssl-ciphers"
- * property
+ * The static String definition of the "cluster-ssl-ciphers" property
+ *
+ * Description: A space separated list of the SSL cipher suites to
+ * enable. Those listed must be supported by the available providers.Preferably
+ * use cluster-ssl-* properties rather than ssl-* properties.
+ *
+ * Default: "any"
+ * Since: GemFire 8.0
*/
String CLUSTER_SSL_CIPHERS = "cluster-ssl-ciphers";
/**
- * The static definition of the "cluster-ssl-enabled"
- * property
+ * The static String definition of the "cluster-ssl-enabled" property
+ *
+ * Description: If true, all gemfire socket communication is
+ * configured to use SSL through JSSE. Preferably Use cluster-ssl-* properties
+ * rather than ssl-* properties.
+ *
+ * Default: "false"
+ * Since: GemFire 8.0
*/
String CLUSTER_SSL_ENABLED = "cluster-ssl-enabled";
/**
- * The static definition of the "cluster-ssl-keystore"
- * property
+ * The static String definition of the "cluster-ssl-keystore" property
+ *
+ * DescriptionLocation of the Java keystore file containing
+ * certificate and private key.
+ * Default: ""
+ * Since: GemFire 8.0
*/
String CLUSTER_SSL_KEYSTORE = "cluster-ssl-keystore";
/**
- * The static definition of the "cluster-ssl-keystore-password"
- * property
+ * The static String definition of the "cluster-ssl-keystore-password" property
+ *
+ * DescriptionPassword to access the private key from the keystore
+ * file specified by javax.net.ssl.keyStore.
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String CLUSTER_SSL_KEYSTORE_PASSWORD = "cluster-ssl-keystore-password";
/**
- * The static definition of the "cluster-ssl-keystore-type"
- * property
+ * The static String definition of the "cluster-ssl-keystore-type" property
+ *
+ * DescriptionFor Java keystore file format, this property has the
+ * value jks (or JKS).
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String CLUSTER_SSL_KEYSTORE_TYPE = "cluster-ssl-keystore-type";
/**
- * The static definition of the "cluster-ssl-protocols"
- * property
+ * The static String definition of the "cluster-ssl-protocols" property
+ *
+ * Description: A space separated list of the SSL protocols to
+ * enable. Those listed must be supported by the available providers.Preferably
+ * use cluster-ssl-* properties rather than ssl-* properties.
+ *
+ * Default: "any"
+ * Since: GemFire 8.0
*/
String CLUSTER_SSL_PROTOCOLS = "cluster-ssl-protocols";
/**
- * The static definition of the "cluster-ssl-require-authentication"
- * property
+ * The static String definition of the "cluster-ssl-require-authentication" property
+ *
+ * Description: If false, allow ciphers that do not require the
+ * client side of the connection to be authenticated.Preferably use
+ * cluster-ssl-* properties rather than ssl-* properties.
+ *
+ * Default: "true"
+ * Since: GemFire 8.0
*/
String CLUSTER_SSL_REQUIRE_AUTHENTICATION = "cluster-ssl-require-authentication";
/**
- * The static definition of the "cluster-ssl-truststore"
- * property
+ * The static String definition of the "cluster-ssl-truststore" property
+ *
+ * DescriptionLocation of the Java keystore file containing the
+ * collection of CA certificates trusted by distributed member (trust store).
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String CLUSTER_SSL_TRUSTSTORE = "cluster-ssl-truststore";
/**
- * The static definition of the "cluster-ssl-truststore-password"
- * property
+ * The static String definition of the "cluster-ssl-truststore-password" property
+ *
+ * DescriptionPassword to unlock the keystore file (store password)
+ * specified by javax.net.ssl.trustStore.
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String CLUSTER_SSL_TRUSTSTORE_PASSWORD = "cluster-ssl-truststore-password";
/**
- * The static definition of the "conflate-events"
- * property
+ * The static String definition of the "conflate-events" property
+ *
+ * Description: This is a client-side property that is passed to
+ * the server. Allowable values are "server", "true", and "false". With the
+ * "server" setting, this client's servers use their own client queue
+ * conflation settings. With a "true" setting, the servers disregard their
+ * own configuration and enable conflation of events for all regions for the
+ * client. A "false" setting causes the client's servers to disable
+ * conflation for all regions for the client.
+ * Default: "server"
+ * Since: GemFire 5.7
*/
String CONFLATE_EVENTS = "conflate-events";
/**
- * The static definition of the "conserve-sockets"
- * property
+ * The static String definition of the "conserve-sockets" property
+ *
+ * Description: If "true" then a minimal number of sockets
+ * will be used when connecting to the distributed system. This conserves
+ * resource usage but can cause performance to suffer.
+ * If "false" then every application thread that sends
+ * distribution messages to other members of the distributed system
+ * will own its own sockets and have exclusive access to them.
+ * The length of time a thread can have exclusive access to a socket
+ * can be configured with "socket-lease-time".
+ * Default: "true"
+ * Allowed values: true|false
*/
String CONSERVE_SOCKETS = "conserve-sockets";
/**
- * The static definition of the "delta-propagation"
- * property
+ * The static String definition of the "delta-propagation" property
+ *
+ * System.getProperty("user.dir")
.
+ *
+ * Default: System.getProperty("user.dir")
+ * Since: GemFire 7.0
*/
String DEPLOY_WORKING_DIR = "deploy-working-dir";
/**
- * The static definition of the "disable-auto-reconnect"
- * property
+ * The static String definition of the "disable-auto-reconnect" property
+ *
+ * Description: By default GemFire will attempt to reconnect and
+ * reinitialize the cache when it has been forced out of the distributed system
+ * by a network-partition event or has otherwise been shunned by other members.
+ * This setting will turn off this behavior.
+ * Default: "false"
*/
String DISABLE_AUTO_RECONNECT = "disable-auto-reconnect";
/**
- * The static definition of the "disable-tcp"
- * property
+ * The static String definition of the "disable-tcp" property
+ * + * Description: Turns off use of tcp/ip sockets, forcing the + * cache to use datagram sockets for all communication. This is useful + * if you have a large number of processes in the distributed cache since + * it eliminates the per-connection reader-thread that is otherwise required. + * However, udp communications are somewhat slower than tcp/ip communications + * due to the extra work required in Java to break messages down to + * transmittable sizes, and the extra work required to guarantee + * message delivery. + *
+ * Default: "false"
+ * Allowed values: true or false
+ * Since: GemFire 5.0 */ String DISABLE_TCP = "disable-tcp"; /** - * The static definition of the "distributed-system-id" - * property + * The static String definition of the "distributed-system-id" property
+ *
+ * Decription:A number that uniquely identifies this distributed system, when
+ * using the WAN gateway to share data between multiple distributed systems. This
+ * setting is only required when using the WAN gateway in conjunction with
+ * the Portable Data eXchange (PDX) serialization format.
+ *
+ * If set, this setting must be the same for every member in this distributed
+ * system. It must be different than the number in other distributed systems
+ * that this one will connect to using the WAN.
+ * -1 means no setting.
+ * Range:-1..255
+ *
+ * Default:: "-1"
*/
String DISTRIBUTED_SYSTEM_ID = "distributed-system-id";
/**
- * The static definition of the "durable-client-id"
- * property
+ * The static String definition of the "durable-client-id" property
+ *
+ * By default, partitioned regions will try to put redundancy copies on different physical hosts, but it may + * put them on the same physical host if no other hosts are available. Setting this property to true + * will prevent partitions regions from ever putting redundant copies of data on the same physical host. + *
+ * Default: "false" */ String ENFORCE_UNIQUE_HOST = "enforce-unique-host"; /** - * The static definition of the "gateway-ssl-ciphers" - * property + * The static String definition of the "gateway-ssl-ciphers" property + * + * Description: A space seperated list of the SSL cipher suites to enable. + * Those listed must be supported by the available providers. + * + * Default:any
+ * Since: GemFire 8.0
*/
String GATEWAY_SSL_CIPHERS = "gateway-ssl-ciphers";
/**
- * The static definition of the "gateway-ssl-enabled"
- * property
+ * The static String definition of the "gateway-ssl-enabled" property
+ *
+ * Description: Specifies if gateway is started with separate ssl configuration.
+ * If not specified global property ssl-enabled (and its other related properties) are used
+ * to create gateway socket
+ *
+ * Default: false
+ * Since: GemFire 8.0
*/
String GATEWAY_SSL_ENABLED = "gateway-ssl-enabled";
/**
- * The static definition of the "gateway-ssl-keystore"
- * property
+ * The static String definition of the "gateway-ssl-keystore" property
+ *
+ * DescriptionLocation of the Java keystore file containing
+ * certificate and private key.
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String GATEWAY_SSL_KEYSTORE = "gateway-ssl-keystore";
/**
- * The static definition of the "gateway-ssl-keystore-password"
- * property
+ * The static String definition of the "gateway-ssl-keystore-password" property
+ *
+ * DescriptionPassword to access the private key from the keystore
+ * file specified by javax.net.ssl.keyStore.
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String GATEWAY_SSL_KEYSTORE_PASSWORD = "gateway-ssl-keystore-password";
/**
- * The static definition of the "gateway-ssl-keystore-type"
- * property
+ * The static String definition of the "gateway-ssl-keystore-type" property
+ *
+ * DescriptionFor Java keystore file format, this property has the
+ * value jks (or JKS).
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String GATEWAY_SSL_KEYSTORE_TYPE = "gateway-ssl-keystore-type";
/**
- * The static definition of the "gateway-ssl-protocols"
- * property
+ * The static String definition of the "gateway-ssl-protocols" property
+ *
+ * Description: A space seperated list of the SSL protocols to enable.
+ * Those listed must be supported by the available providers.
+ *
+ * Default: any
+ * Since: GemFire 8.0
*/
String GATEWAY_SSL_PROTOCOLS = "gateway-ssl-protocols";
/**
- * The static definition of the "gateway-ssl-require-authentication"
- * property
+ * The static String definition of the "gateway-ssl-require-authentication" property
+ *
+ * Description: If false, allow ciphers that do not require the Gateway Sender
+ * side of the connection to be authenticated.
+ *
+ * Default: any
+ * Since: GemFire 8.0
*/
String GATEWAY_SSL_REQUIRE_AUTHENTICATION = "gateway-ssl-require-authentication";
/**
- * The static definition of the "gateway-ssl-truststore"
- * property
+ * The static String definition of the "gateway-ssl-truststore" property
+ *
+ * DescriptionLocation of the Java keystore file containing the
+ * collection of CA certificates trusted by server (trust store).
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String GATEWAY_SSL_TRUSTSTORE = "gateway-ssl-truststore";
/**
- * The static definition of the "gateway-ssl-truststore-password"
- * property
+ * The static String definition of the "gateway-ssl-truststore-password" property
+ *
+ * Description: Password to unlock the keystore file (store password)
+ * specified by javax.net.ssl.trustStore.
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String GATEWAY_SSL_TRUSTSTORE_PASSWORD = "gateway-ssl-truststore-password";
/**
- * The static definition of the "groups"
- * property
+ * The static String definition of the "groups" property.
+ * + * Description: Defines the list of groups this member belongs to. + * Use commas to separate group names. + * Note that anything defined by the deprecated roles gemfire property will also be considered a group. + *
+ * Default: "" + *
+ * Since: GemFire 7.0 */ String GROUPS = "groups"; /** - * The static definition of the "http-service-bind-address" - * property + * The static String definition of the "http-service-bind-address" property + *
+ * Description: The address where the GemFire HTTP service will listen + * for remote connections. One can use this property to configure what ip + * address or host name the HTTP service will listen on. When not set, by + * default the HTTP service will listen on the local host's address. + * + * Default: "" + * Since: GemFire 8.0 */ String HTTP_SERVICE_BIND_ADDRESS = "http-service-bind-address"; /** - * The static definition of the "http-service-port" - * property + * The static String definition of the "http-service-port" property + * + * Description: Specifies the port used by the GemFire HTTP service. If + * configured with non-zero value, then an HTTP service will listen on this port. + * A value of "0" disables Gemfire HTTP service. + * + * Default: "7070" + * Allowed values: 0..65535 + * Since: GemFire 8.0 */ String HTTP_SERVICE_PORT = "http-service-port"; /** - * The static definition of the "http-service-ssl-ciphers" - * property + * The static String definition of the "http-service-ssl-ciphers" property + * + * Description: A space separated list of the SSL cipher suites to enable. + * Those listed must be supported by the available providers. + * + * Default:any
+ * Since: GemFire 8.1
*/
String HTTP_SERVICE_SSL_CIPHERS = "http-service-ssl-ciphers";
/**
- * The static definition of the "http-service-ssl-enabled"
- * property
+ * The static String definition of the "http-service-ssl-enabled" property
+ * a name="http-service-ssl-enabled"/a>
+ * Description: Specifies if http service is started with separate ssl configuration.
+ * If not specified, global property cluster-ssl-enabled (and its other related properties) are used
+ * to secure http service. All http-service-ssl-* properties are inherited from cluster-ssl-* properties.
+ * User can ovverride them using specific http-service-ssl-* property.
+ *
+ * Default: false
+ * Since: GemFire 8.1
*/
String HTTP_SERVICE_SSL_ENABLED = "http-service-ssl-enabled";
/**
- * The static definition of the "http-service-ssl-keystore"
- * property
+ * The static String definition of the "http-service-ssl-keystore" property
+ *
+ * Description: Location of the Java keystore file containing
+ * certificate and private key.
+ *
+ * Default: ""
+ * Since: GemFire 8.1
*/
String HTTP_SERVICE_SSL_KEYSTORE = "http-service-ssl-keystore";
/**
- * The static definition of the "http-service-ssl-keystore-password"
- * property
+ * The static String definition of the "http-service-ssl-keystore-password" property
+ *
+ * Description: Password to access the private key from the keystore
+ * file specified by javax.net.ssl.keyStore.
+ *
+ * Default: ""
+ * Since: GemFire 8.1
*/
String HTTP_SERVICE_SSL_KEYSTORE_PASSWORD = "http-service-ssl-keystore-password";
/**
- * The static definition of the "http-service-ssl-keystore-type"
- * property
+ * The static String definition of the "http-service-ssl-keystore-type" property
+ *
+ * Description: For Java keystore file format, this property has the
+ * value jks (or JKS).
+ *
+ * Default: ""
+ * Since: GemFire 8.1
*/
String HTTP_SERVICE_SSL_KEYSTORE_TYPE = "http-service-ssl-keystore-type";
/**
- * The static definition of the "http-service-ssl-protocols"
- * property
+ * The static String definition of the "http-service-ssl-protocols" property
+ *
+ * Description: A space separated list of the SSL protocols to enable.
+ * Those listed must be supported by the available providers.
+ *
+ * Default: any
+ * Since: GemFire 8.1
*/
String HTTP_SERVICE_SSL_PROTOCOLS = "http-service-ssl-protocols";
/**
- * The static definition of the "http-service-ssl-require-authentication"
- * property
+ * The static String definition of the "http-service-ssl-require-authentication" property
+ *
+ * Description: If false, allow ciphers that do not require the client
+ * side of the connection to be authenticated.
+ *
+ * Default: false
+ * Since: GemFire 8.1
*/
String HTTP_SERVICE_SSL_REQUIRE_AUTHENTICATION = "http-service-ssl-require-authentication";
/**
- * The static definition of the "http-service-ssl-truststore"
- * property
+ * The static String definition of the "http-service-ssl-truststore" property
+ *
+ * Description: Location of the Java keystore file containing the
+ * collection of CA certificates trusted by server (trust store).
+ *
+ * Default: ""
+ * Since: GemFire 8.1
*/
String HTTP_SERVICE_SSL_TRUSTSTORE = "http-service-ssl-truststore";
/**
- * The static definition of the "http-service-ssl-truststore-password"
- * property
+ * The static String definition of the "http-service-ssl-truststore-password" property
+ *
+ * Description: Password to unlock the keystore file (store password)
+ * specified by javax.net.ssl.trustStore.
+ *
+ * Default: ""
+ * Since: GemFire 8.1
*/
String HTTP_SERVICE_SSL_TRUSTSTORE_PASSWORD = "http-service-ssl-truststore-password";
/**
- * The static definition of the "jmx-manager"
- * property
+ * The static String definition of the "jmx-manager" property
+ *
+ * Description: If true then this member is willing to be a jmx-manager.
+ * All the other jmx-manager properties will be used when it does become a manager.
+ * If this property is false then all other jmx-manager properties are ignored.
+ *
+ * Default: "false except on locators"
*/
String JMX_MANAGER = "jmx-manager";
/**
- * The static definition of the "jmx-manager-access-file"
- * property
+ * The static String definition of the "jmx-manager-access-file" property
+ *
+ * Description: By default the jmx-manager will allow full access to all mbeans by any client.
+ * If this property is set to the name of a file then it can restrict clients to only being able to read
+ * mbeans; they will not be able to modify mbeans. The access level can be configured differently in this
+ * file for each user name defined in the password file.
+ * For more information about the format of this file see Oracle's documentation of the
+ * com.sun.management.jmxremote.access.file system property.
+ * Ignored if jmx-manager is false or if jmx-manager-port is zero.
+ *
+ * Default: ""
*/
String JMX_MANAGER_ACCESS_FILE = "jmx-manager-access-file";
/**
- * The static definition of the "jmx-manager-bind-address"
- * property
+ * The static String definition of the "jmx-manager-bind-address" property
+ *
+ * Description: By default the jmx-manager when configured with a port will listen
+ * on all the local host's addresses. You can use this property to configure what ip address
+ * or host name the jmx-manager will listen on. In addition, if the embedded http server is
+ * started, it will also bind to this address if it is set.
+ * Ignored if jmx-manager is false or jmx-manager-port is zero.
+ *
+ * Default: ""
*/
String JMX_MANAGER_BIND_ADDRESS = "jmx-manager-bind-address";
/**
- * The static definition of the "jmx-manager-hostname-for-clients"
- * property
+ * The static String definition of the "jmx-manager-hostname-for-clients" property
+ *
+ * Description: Lets you control what hostname will be given to clients that ask
+ * the locator for the location of a jmx manager. By default the ip address that the jmx-manager
+ * reports is used. But for clients on a different network this property allows you to configure
+ * a different hostname that will be given to clients.
+ * Ignored if jmx-manager is false or jmx-manager-port is zero.
+ *
+ * Default: ""
*/
String JMX_MANAGER_HOSTNAME_FOR_CLIENTS = "jmx-manager-hostname-for-clients";
/**
- * The static definition of the "jmx-manager-http-port"
- * property
+ * The static String definition of the "jmx-manager-http-port" property
+ *
+ * Description: If non-zero then when the jmx manager is started, an embedded
+ * web server will also be started and will listen on this port.
+ * The web server is used to host the GemFire Pulse application.
+ * If you are hosting the Pulse web app in your own web server, then disable
+ * this embedded server by setting this property to zero.
+ * Ignored if jmx-manager is false.
+ *
+ * Default: "7070"
+ * Deprecated: as of GemFire8.0 use http-service-port
instead.
*
* @deprecated as of GemFire 8.0 use {@link #HTTP_SERVICE_PORT} instead.
*/
String JMX_MANAGER_HTTP_PORT = "jmx-manager-http-port";
/**
- * The static definition of the "jmx-manager-password-file"
- * property
+ * The static String definition of the "jmx-manager-password-file" property
+ *
+ * Description: By default the jmx-manager will allow clients without credentials to connect.
+ * If this property is set to the name of a file then only clients that connect with credentials that
+ * match an entry in this file will be allowed.
+ * Most JVMs require that the file is only readable by the owner.
+ * For more information about the format of this file see Oracle's documentation of the
+ * com.sun.management.jmxremote.password.file system property.
+ * Ignored if jmx-manager is false or if jmx-manager-port is zero.
+ *
+ * Default: ""
*/
String JMX_MANAGER_PASSWORD_FILE = "jmx-manager-password-file";
/**
- * The static definition of the "jmx-manager-port"
- * property
+ * The static String definition of the "jmx-manager-port" property
+ *
+ * Description: The port this jmx manager will listen to for client connections.
+ * If this property is set to zero then GemFire will not allow remote client connections
+ * but you can alternatively use the standard system properties supported by the JVM
+ * for configuring access from remote JMX clients.
+ * Ignored if jmx-manager is false.
+ *
+ * Default: "1099"
*/
String JMX_MANAGER_PORT = "jmx-manager-port";
/**
- * * The static definition of the "jmx-manager-ssl"
- * property
+ * The static String definition of the "jmx-manager-ssl" property
+ *
+ * Description: If true and jmx-manager-port is not zero then the jmx-manager
+ * will only accept ssl connections. Note that the ssl-enabled property does not apply to the jmx-manager
+ * but the other ssl properties do. This allows ssl to be configured for just the jmx-manager
+ * without needing to configure it for the other GemFire connections.
+ * Ignored if jmx-manager is false.
+ *
+ * Default: "false"
+ * Deprecated: as of GemFire 8.0 use jmx-manager-ssl-enabled
instead.
+ *
* @deprecated as of GemFire 8.0 use {@link #JMX_MANAGER_SSL_ENABLED} instead.
*/
String JMX_MANAGER_SSL = "jmx-manager-ssl";
/**
- * The static definition of the "jmx-manager-start"
- * property
+ * The static String definition of the "jmx-manager-start" property
+ *
+ * Description: If true then this member will start a jmx manager when
+ * it creates a cache. Management tools like gfsh can be configured to connect
+ * to the jmx-manager. In most cases you should not set this because a jmx manager will
+ * automatically be started when needed on a member that sets "jmx-manager" to true.
+ * Ignored if jmx-manager is false.
+ *
+ * Default: "false"
*/
String JMX_MANAGER_START = "jmx-manager-start";
/**
- * The static definition of the "jmx-manager-update-rate"
- * property
+ * The static String definition of the "jmx-manager-update-rate" property
+ *
+ * Description: The rate, in milliseconds, at which this member will push updates
+ * to any jmx managers. Currently this value should be greater than or equal to the
+ * statistic-sample-rate. Setting this value too high will cause stale values to be
+ * seen by gfsh and pulse.
+ *
+ * Default: "2000"
*/
String JMX_MANAGER_UPDATE_RATE = "jmx-manager-update-rate";
/**
- * The static definition of the "jmx-manager-ssl-ciphers"
- * property
+ * The static String definition of the "jmx-manager-ssl-ciphers" property
+ *
+ * Description: A space seperated list of the SSL cipher suites to enable.
+ * Those listed must be supported by the available providers.
+ *
+ * Default: "any"
*/
String JMX_MANAGER_SSL_CIPHERS = "jmx-manager-ssl-ciphers";
/**
- * The static definition of the "jmx-manager-ssl-enabled"
- * property
+ * The static String definition of the "jmx-manager-ssl-enabled" property
+ *
+ * Description: If true and jmx-manager-port is not zero then the jmx-manager
+ * will only accept ssl connections. Note that the ssl-enabled property does not apply to the jmx-manager
+ * but the other ssl properties do. This allows ssl to be configured for just the jmx-manager
+ * without needing to configure it for the other GemFire connections.
+ * Ignored if jmx-manager is false.
+ *
+ * Default: "false"
*/
String JMX_MANAGER_SSL_ENABLED = "jmx-manager-ssl-enabled";
/**
- * The static definition of the "jmx-manager-ssl-keystore"
- * property
+ * The static String definition of the "jmx-manager-ssl-keystore" property
+ *
+ * Description: Location of the Java keystore file containing
+ * certificate and private key.
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String JMX_MANAGER_SSL_KEYSTORE = "jmx-manager-ssl-keystore";
/**
- * The static definition of the "jmx-manager-ssl-keystore-password"
- * property
+ * The static String definition of the "jmx-manager-ssl-keystore-password" property
+ *
+ * Description: Password to access the private key from the keystore
+ * file specified by javax.net.ssl.keyStore.
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String JMX_MANAGER_SSL_KEYSTORE_PASSWORD = "jmx-manager-ssl-keystore-password";
/**
- * The static definition of the "jmx-manager-ssl-keystore-type"
- * property
+ * The static String definition of the "jmx-manager-ssl-keystore-type" property
+ *
+ * Description: For Java keystore file format, this property has the
+ * value jks (or JKS).
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String JMX_MANAGER_SSL_KEYSTORE_TYPE = "jmx-manager-ssl-keystore-type";
/**
- * The static definition of the "jmx-manager-ssl-protocols"
- * property
+ * The static String definition of the "jmx-manager-ssl-protocols" property
+ *
+ * Description: A space seperated list of the SSL protocols to enable.
+ * Those listed must be supported by the available providers.
+ *
+ * Default: "any"
*/
String JMX_MANAGER_SSL_PROTOCOLS = "jmx-manager-ssl-protocols";
/**
- * The static definition of the "jmx-manager-ssl-require-authentication"
- * property
+ * The static String definition of the "jmx-manager-ssl-require-authentication" property
+ *
+ * Description: If false, allow ciphers that do not require the client
+ * side of the connection to be authenticated.
+ *
+ * Default: "true"
*/
String JMX_MANAGER_SSL_REQUIRE_AUTHENTICATION = "jmx-manager-ssl-require-authentication";
/**
- * The static definition of the "jmx-manager-ssl-truststore"
- * property
+ * The static String definition of the "jmx-manager-ssl-truststore" property
+ *
+ * Description: Location of the Java keystore file containing the
+ * collection of CA certificates trusted by manager (trust store).
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String JMX_MANAGER_SSL_TRUSTSTORE = "jmx-manager-ssl-truststore";
/**
- * The static definition of the "jmx-manager-ssl-truststore-password"
- * property
+ * The static String definition of the "jmx-manager-ssl-truststore-password" property
+ *
+ * Description: Password to unlock the keystore file (store password)
+ * specified by javax.net.ssl.trustStore.
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String JMX_MANAGER_SSL_TRUSTSTORE_PASSWORD = "jmx-manager-ssl-truststore-password";
String LICENCE_APPLICATION_CACHE = "license-application-cache";
@@ -386,359 +856,733 @@ public interface DistributedSystemConfigProperties {
String LICENCE_SERVER_TIMEOUT = "license-server-timeout";
String LICENCE_WORKING_DIR = "license-working-dir";
/**
- * The static definition of the "load-cluster-configuration-from-dir"
- * property
+ * The static String definition of the "load-cluster-configuration-from-dir" property
+ *
+ * Description: "true" causes loading of cluster configuration from "cluster_config" directory in the locator.
+ * This property is only applicable to dedicated locators which have "enable-cluster-configuration" set to true.
+ *
+ * Default: "false"
+ * Allowed values: true or false
+ * Since: GemFire 8.0
*/
String LOAD_CLUSTER_CONFIGURATION_FROM_DIR = "load-cluster-configuration-from-dir";
/**
- * The static definition of the "locator-wait-time"
- * property
+ * The static String definition of the "locator-wait-time" property
+ * + * Description: The number of seconds to wait for a locator to start + * if one is not available when attempting to join the distributed system. This + * setting can be used when locators and peers are being started all at once in + * order to have the peers be patient and wait for the locators to finish starting + * up before attempting to join the distributed system..
+ *
+ * Default: "0"
*/
String LOCATOR_WAIT_TIME = "locator-wait-time";
/**
- * The static definition of the "locators"
- * property
+ * The static String definition of the "locators" property
+ *
+ * Description: A list of locators (host and port) that
+ * are used to find other member of the distributed system. This
+ * attribute's value is a possibly empty comma separated list. Each
+ * element must be of the form "hostName[portNum]" and may be of the
+ * form "host:bindAddress[port]" if a specific bind address is to be
+ * used on the locator machine. The square
+ * brackets around the portNum are literal character and must be
+ * specified.
+ * Since IPv6 bind addresses may contain colons, you may use an at symbol
+ * instead of a colon to separate the host name and bind address.
+ * For example, "server1@fdf0:76cf:a0ed:9449::5[12233]" specifies a locator
+ * running on "server1" and bound to fdf0:76cf:a0ed:9449::5 on port 12233.
+ * If "locators" is empty
+ * then this distributed system will be isolated from all other GemFire
+ * processes.
+ *
+ * Default: ""
*/
String LOCATORS = "locators";
/**
- * The static definition of the "log-disk-space-limit"
- * property
+ * The static String definition of the "log-disk-space-limit" property
+ *
disable-auto-reconnect
) or if the deprecated required-roles
+ * feature is being used and a role-loss has triggered a shutdown and reconnect.
+ *
+ * Default: "60000"
+ * Since: GemFire 5.0
*/
String MAX_WAIT_TIME_RECONNECT = "max-wait-time-reconnect";
/**
- * The static definition of the "mcast-address"
- * property
+ * The static String definition of the "mcast-address" property
+ * + * Description: The IP address used for multicast + * networking. If mcast-port is zero, then mcast-address is + * ignored. + *
+ * Default: "239.192.81.1"
*/
String MCAST_ADDRESS = "mcast-address";
/**
- * The static definition of the "mcast-flow-control"
- * property
+ * The static String definition of the "mcast-flow-control" property
+ *
+ * Description: Configures the flow-of-control protocol for
+ * multicast messaging. There are three settings that are separated
+ * by commas: byteAllowance (integer), rechargeThreshold (float) and
+ * rechargeBlockMs (integer). The byteAllowance determines how many bytes
+ * can be sent without a recharge from other processes. The rechargeThreshold
+ * tells receivers how low the sender's initial to remaining allowance
+ * ratio should be before sending a recharge. The rechargeBlockMs
+ * tells the sender how long to wait for a recharge before explicitly
+ * requesting one.
+ * Deprecated: as of 9.0 GemFire does not include a flow-of-control protocol for multicast messaging.
+ * Default: "1048576,0.25,5000"
+ * Allowed values: 100000-maxInt, 0.1-0.5, 500-60000
+ * Since: GemFire 5.0
*/
String MCAST_FLOW_CONTROL = "mcast-flow-control";
/**
- * The static definition of the "mcast-port"
- * property
+ * The static String definition of the "mcast-port" property
+ *
+ * Description: The port used for multicast networking.
+ * If zero, then multicast will be disabled and unicast messaging will
+ * be used.
+ *
+ * Default: "0"
*/
String MCAST_PORT = "mcast-port";
/**
- * The static definition of the "mcast-recv-buffer-size"
- * property
+ * The static String definition of the "mcast-recv-buffer-size" property
+ *
+ * Description: Sets the size of the socket buffer used for
+ * incoming multicast transmissions. You should set this high if there will be
+ * high volumes of messages.
+ * Default: "1048576"
+ * Allowed values: 2048..Operating System maximum
+ * Since: GemFire 5.0
*/
String MCAST_RECV_BUFFER_SIZE = "mcast-recv-buffer-size";
/**
- * The static definition of the "mcast-send-buffer-size"
- * property
+ * The static String definition of the "mcast-send-buffer-size" property
+ *
+ * Description: Sets the size of the socket buffer used for
+ * outgoing multicast transmissions.
+ * Default: "65535"
+ * Allowed values: 2048..Operating System maximum
+ * Since: GemFire 5.0
*/
String MCAST_SEND_BUFFER_SIZE = "mcast-send-buffer-size";
/**
- * The static definition of the "mcast-ttl"
- * property
+ * The static String definition of the "mcast-ttl" property
+ *
+ * Description: Determines how far through your network
+ * the multicast packets used by GemFire will propagate.
+ * Default: "32"
+ * Allowed values: 0..255
+ * Since: GemFire 4.1
*/
String MCAST_TTL = "mcast-ttl";
/**
- * The static definition of the "member-timeout"
- * property
+ * The static String definition of the "member-timeout" property
+ *
+ * Description: Sets the timeout interval, in milliseconds, used
+ * to determine whether another process is alive or not. When another process
+ * appears to be gone, GemFire sends it an ARE-YOU-DEAD message and waits
+ * for the member-timeout period for it to respond and declare it is not dead.
+ *
+ * Default: "5000"
+ * Allowed values: 1000-600000
+ * Since: GemFire 5.0
*/
String MEMBER_TIMEOUT = "member-timeout";
/**
- * The static definition of the "membership-port-range"
- * property
+ * The static String definition of the "membership-port-range" property
+ *
+ * Description: The allowed range of ports for use in forming an
+ * unique membership identifier (UDP), for failure detection purposes (TCP) and
+ * to listen on for peer connections (TCP). This range is given as two numbers
+ * separated by a minus sign. Minimum 3 values in range are required to
+ * successfully startup.
+ *
+ * Default: 1024-65535
*/
String MEMBERSHIP_PORT_RANGE = "membership-port-range";
/**
- * The static definition of the "memcached-bind-address"
- * property
+ * The static String definition of the "memcached-bind-address" property
+ *
+ * Description: Uniquely identifies a member in its distributed system. + * If two members with the same name try to join the same distributed system + * then the second join will fail.
+ * Default: "" */ String NAME = "name"; /** - * The static definition of the "redundancy-zone" - * property + * The static String definition of the "redundancy-zone" property + *
+ * Description: Defines the redundancy zone from this member. If this property is set, partitioned + * regions will not put two redundant copies of data in two members with the same redundancy zone setting. + * + * Default: "" */ String REDUNDANCY_ZONE = "redundancy-zone"; /** - * The static definition of the "remote-locators" - * property + * The static String definition of the "remote-locators" property + *+ * Description: A list of locators (host and port) that a cluster + * will use in order to connect to a remote site in a multi-site (WAN) + * configuration. This attribute's value is a possibly comma separated list. + *
For each remote locator, provide a hostname and/or address + * (separated by '@', if you use both), followed by a port number in brackets. + *
Examples: + * remote-locators=address1[port1],address2[port2] + *
+ * remote-locators=hostName1@address1[port1],hostName2@address2[port2] + *
+ * remote-locators=hostName1[port1],hostName2[port2]
+ *
+ * Default: "" */ String REMOTE_LOCATORS = "remote-locators"; /** - * The static definition of the "remove-unresponsive-client" + * The static String definition of the "remove-unresponsive-client" * property */ String REMOVE_UNRESPONSIVE_CLIENT = "remove-unresponsive-client"; /** - * The static definition of the "roles" - * property + * The static String definition of the "roles" property + *
+ * Description: Specifies the application roles that this member + * performs in the distributed system. This is a comma delimited list of + * user-defined strings. Any number of members can be configured to perform + * the same role, and a member can be configured to perform any number of + * roles. + * Note that anything defined by the groups gemfire property will also be considered a role. + * + * Default: "" + * Since: GemFire 5.0 + * Deprecated: This feature is scheduled to be removed. + * + * @deprecated : This feature is scheduled to be removed. */ String ROLES = "roles"; /** - * The static definition of the security prefix "security-" used in conjuntion with other security-* properties - * property + * The static String definition of the security prefix "security-" used in conjunction with other security-* properties property + * + * Description: Mechanism to define client credentials. + * All tags with "security-" prefix is packaged together as security properties + * and passed as an argument to getCredentials of Authentication module. + * These tags cannot have null values. + * + * Default: Optional + * Allowed values: any string */ String SECURITY_PREFIX = "security-"; /** - * The static definition of the "security-client-accessor" + * The static String definition of the "security-client-accessor" * property */ String SECURITY_CLIENT_ACCESSOR = SECURITY_PREFIX + "client-accessor"; /** - * The static definition of the "security-client-accessor-pp" + * The static String definition of the "security-client-accessor-pp" * property */ String SECURITY_CLIENT_ACCESSOR_PP = SECURITY_PREFIX + "client-accessor-pp"; /** - * The static definition of the "security-client-auth-init" - * property + * The static String definition of the "security-client-auth-init" property + * + * Description: Authentication module name for Clients that requires to act + * upon credentials read from the gemfire.properties file. + * Module must implement AuthInitialize interface. + * + * Default: "" + * Allowed values: jar file:class name */ String SECURITY_CLIENT_AUTH_INIT = SECURITY_PREFIX + "client-auth-init"; /** - * The static definition of the "security-client-authenticator" + * The static String definition of the "security-client-authenticator" * property */ String SECURITY_CLIENT_AUTHENTICATOR = SECURITY_PREFIX + "client-authenticator"; /** - * The static definition of the "security-client-dhalgo" + * The static String definition of the "security-client-dhalgo" * property */ String SECURITY_CLIENT_DHALGO = SECURITY_PREFIX + "client-dhalgo"; /** - * The static definition of the "security-log-file" + * The static String definition of the "security-log-file" * property */ String SECURITY_LOG_FILE = SECURITY_PREFIX + "log-file"; /** - * The static definition of the "security-log-level" + * The static String definition of the "security-log-level" * property */ String SECURITY_LOG_LEVEL = SECURITY_PREFIX + "log-level"; /** - * The static definition of the "security-peer-auth-init" + * The static String definition of the "security-peer-auth-init" * property */ String SECURITY_PEER_AUTH_INIT = SECURITY_PREFIX + "peer-auth-init"; /** - * The static definition of the "security-peer-authenticator" + * The static String definition of the "security-peer-authenticator" * property */ String SECURITY_PEER_AUTHENTICATOR = SECURITY_PREFIX + "peer-authenticator"; /** - * The static definition of the "security-peer-verifymember-timeout" + * The static String definition of the "security-peer-verifymember-timeout" * property */ String SECURITY_PEER_VERIFY_MEMBER_TIMEOUT = SECURITY_PREFIX + "peer-verifymember-timeout"; /** - * The static definition of the "server-bind-address" - * property + * The static String definition of the "server-bind-address" property + *+ * Description: The IP address that this distributed system's + * server sockets in a client-server topology will listen on. + * If set to an empty string then all of the local machine's + * addresses will be listened on. + *
+ * Default: "" */ String SERVER_BIND_ADDRESS = "server-bind-address"; /** - * The static definition of the "server-ssl-ciphers" - * property + * The static String definition of the "server-ssl-ciphers" property + *
+ * Description: A space seperated list of the SSL cipher suites to enable. + * Those listed must be supported by the available providers. + * + * Default:any
+ * Since: GemFire 8.0
*/
String SERVER_SSL_CIPHERS = "server-ssl-ciphers";
/**
- * The static definition of the "server-ssl-enabled"
- * property
+ * The static String definition of the "server-ssl-enabled" property
+ *
+ * Description: Specifies if server is started with separate ssl configuration.
+ * If not specified global property ssl-enabled (and its other related properties) are used
+ * to create server socket
+ *
+ * Default: false
+ * Since: GemFire 8.0
*/
String SERVER_SSL_ENABLED = "server-ssl-enabled";
/**
- * The static definition of the "server-ssl-keystore"
- * property
+ * The static String definition of the "server-ssl-keystore" property
+ *
+ * Description: Location of the Java keystore file containing
+ * certificate and private key.
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String SERVER_SSL_KEYSTORE = "server-ssl-keystore";
/**
- * The static definition of the "server-ssl-keystore-password"
- * property
+ * The static String definition of the "server-ssl-keystore-password" property
+ *
+ * Description: Password to access the private key from the keystore
+ * file specified by javax.net.ssl.keyStore.
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String SERVER_SSL_KEYSTORE_PASSWORD = "server-ssl-keystore-password";
/**
- * The static definition of the "server-ssl-keystore-type"
- * property
+ * The static String definition of the "server-ssl-keystore-type" property
+ *
+ * Description: For Java keystore file format, this property has the
+ * value jks (or JKS).
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String SERVER_SSL_KEYSTORE_TYPE = "server-ssl-keystore-type";
/**
- * The static definition of the "server-ssl-protocols"
- * property
+ * The static String definition of the "server-ssl-protocols" property
+ *
+ * Description: A space seperated list of the SSL protocols to enable.
+ * Those listed must be supported by the available providers.
+ *
+ * Default: any
+ * Since: GemFire 8.0
*/
String SERVER_SSL_PROTOCOLS = "server-ssl-protocols";
/**
- * The static definition of the "server-ssl-require-authentication"
- * property
+ * The static String definition of the "server-ssl-require-authentication" property
+ *
+ * Description: If false, allow ciphers that do not require the client
+ * side of the connection to be authenticated.
+ *
+ * Default: any
+ * Since: GemFire 8.0
*/
String SERVER_SSL_REQUIRE_AUTHENTICATION = "server-ssl-require-authentication";
/**
- * The static definition of the "server-ssl-truststore"
- * property
+ * The static String definition of the "server-ssl-truststore" property
+ *
+ * Description: Location of the Java keystore file containing the
+ * collection of CA certificates trusted by server (trust store).
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String SERVER_SSL_TRUSTSTORE = "server-ssl-truststore";
/**
- * The static definition of the "server-ssl-truststore-password"
- * property
+ * The static String definition of the "server-ssl-truststore-password" property
+ *
+ * Description: Password to unlock the keystore file (store password)
+ * specified by javax.net.ssl.trustStore.
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String SERVER_SSL_TRUSTSTORE_PASSWORD = "server-ssl-truststore-password";
/**
- * The static definition of the "socket-buffer-size"
- * property
+ * The static String definition of the "socket-buffer-size" property
+ *
+ * Description: The size of each socket buffer, in bytes.
+ * Smaller buffers conserve memory. Larger buffers can improve performance;
+ * in particular if large messages are being sent.
+ * Default: "32768"
+ * Allowed values: 128..16777215
+ * Since: GemFire 4.1
*/
String SOCKET_BUFFER_SIZE = "socket-buffer-size";
/**
- * The static definition of the "socket-lease-time"
- * property
+ * The static String definition of the "socket-lease-time" property
+ *
+ * Description: The number of milliseconds a thread
+ * can keep exclusive access to a socket that it is not actively using.
+ * Once a thread loses its lease to a socket it will need to re-acquire
+ * a socket the next time it sends a message.
+ * A value of zero causes socket leases to never expire.
+ * This property is ignored if "conserve-sockets" is true.
+ * Default: "15000"
+ * Allowed values: 0..600000
+ * Since: GemFire 4.1
*/
String SOCKET_LEASE_TIME = "socket-lease-time";
/**
- * The static definition of the "start-dev-rest-api"
- * property
+ * The static String definition of the "start-dev-rest-api" property
+ *
+ * Description: If true then developer(API) REST service will be
+ * started when cache is created. REST service can be configured using
+ * http-service-port
and http-service-bind-address
+ * properties.
+ * Default: "false"
+ * Since: GemFire 8.0
*/
String START_DEV_REST_API = "start-dev-rest-api";
/**
- * The static definition of the "start-locator"
- * property
+ * The static String definition of the "start-locator" property
+ *
+ * Description: A host name or bind-address and port
+ * ("host[port],peer=+ *
+ * The peer and server parameters are optional. They specify whether + * the locator can be used for peers to discover each other, or for clients + * to discover peers. By default both are true. + *
+ * Default: "" (doesn't start a locator) */ String START_LOCATOR = "start-locator"; /** - * The static definition of the "statistic-archive-file" - * property + * The static String definition of the "statistic-archive-file" property + * + * Description: The file that statistic samples are + * written to. An empty string (default) disables statistic + * archival. + * + * Default: "" */ String STATISTIC_ARCHIVE_FILE = "statistic-archive-file"; /** - * The static definition of the "statistic-sample-rate" - * property + * The static String definition of the "statistic-sample-rate" property + * + * Description: The rate, in milliseconds, at which samples + * of the statistics will be taken. + * If set to a value less than 1000 the rate will be set to 1000 because + * the VSD tool does not support sub-second sampling. + * + * Default: "1000" + * Allowed values: 100..60000 */ String STATISTIC_SAMPLE_RATE = "statistic-sample-rate"; /** - * The static definition of the "statistic-sampling-enabled" - * property + * The static String definition of the "statistic-sampling-enabled" property + * + * Description: "true" causes the statistics to be + * sampled periodically and operating system statistics to be + * fetched each time a sample is taken. "false" disables sampling + * which also disables operating system statistic collection. Non + * OS statistics will still be recorded in memory and can be viewed + * by administration tools. However, charts will show no activity + * and no statistics will be archived while sampling is + * disabled. + * Starting in 7.0 the default value has been changed to true. + * If statistic sampling is disabled it will also cause various + * metrics seen in gfsh and pulse to always be zero. + * + * Default: "true" + * Allowed values: true|false */ String STATISTIC_SAMPLING_ENABLED = "statistic-sampling-enabled"; /** - * The static definition of the "tcp-port" - * property + * The static String definition of the "tcp-port" property + *+ * Description: A 16-bit integer that determines the tcp/ip port number to listen on + * for cache communications. If zero, the operating system will select + * an available port to listen on. Each process on a machine must have + * its own tcp-port. Note that some operating systems restrict the range + * of ports usable by non-privileged users, and using restricted port + * numbers can cause runtime errors in GemFire startup. + *
+ * Default: "0"
+ * Allowed values: 0..65535
+ * Since: GemFire 5.0
*/
String TCP_PORT = "tcp-port";
/**
- * The static definition of the "udp-fragment-size"
- * property
+ * The static String definition of the "udp-fragment-size" property
+ *
+ * Description: When messages are sent over datagram sockets,
+ * GemFire breaks large messages down into fragments for transmission.
+ * This property sets the maximum fragment size for transmission.
+ * Default: "60000"
+ * Allowed values: 1000..60000
+ * Since: GemFire 5.0
*/
String UDP_FRAGMENT_SIZE = "udp-fragment-size";
/**
- * The static definition of the "udp-recv-buffer-size"
- * property
+ * The static String definition of the "udp-recv-buffer-size" property
+ *
+ * Description: Sets the size of the socket buffer used for
+ * incoming udp point-to-point transmissions. Note: if multicast is not
+ * enabled and disable-tcp is not enabled, a reduced default size of
+ * 65535 is used.
+ * Default: "1048576 if multicast is enabled or disable-tcp is true, 131071 if not"
+ * Allowed values: 2048..Operating System maximum
+ * Since: GemFire 5.0
*/
String UDP_RECV_BUFFER_SIZE = "udp-recv-buffer-size";
/**
- * The static definition of the "udp-send-buffer-size"
- * property
+ * The static String definition of the "udp-send-buffer-size" property
+ *
+ * Description: Sets the size of the socket buffer used for
+ * outgoing udp point-to-point transmissions.
+ * Default: "65535"
+ * Allowed values: 2048..Operating System maximum
+ * Since: GemFire 5.0
*/
String UDP_SEND_BUFFER_SIZE = "udp-send-buffer-size";
/**
- * The static definition of the "use-cluster-configuration"
- * property
+ * The static String definition of the "use-cluster-configuration" property
+ *
CommandMarker
interface.
+ * Matching classes will be loaded when the VM starts and will be available
+ * in the GFSH command-line utility.
+ *
+ * Default: ""
+ * Since: GemFire 8.0
*/
String USER_COMMAND_PACKAGES = "user-command-packages";
/**
- * The static definition of the "off-heap-memory-size"
- * property
+ * The static String definition of the "off-heap-memory-size" property
+ *
+ * Description: The total size of off-heap memory specified as
+ * off-heap-memory-size=""
+ * Since: Geode 1.0
*/
String OFF_HEAP_MEMORY_SIZE = "off-heap-memory-size";
/**
- * The static definition of the "redis-port"
- * property
+ * The static String definition of the "redis-port" property
+ *
+ * Description: Specifies the port used by {@link com.gemstone.gemfire.redis.GemFireRedisServer}
+ * which enables redis clients to connect and store data in GemFire distributed system.
+ * see {@link com.gemstone.gemfire.redis.GemFireRedisServer} for other configuration options.
+ * Default: "0" disables GemFireMemcachedServer
+ * Allowed values: 0..65535
*/
String REDIS_PORT = "redis-port";
/**
- * The static definition of the "redis-bind-address"
- * property
+ * The static String definition of the "redis-bind-address" property
+ *
+ * Description: Specifies the bind address used by {@link com.gemstone.gemfire.redis.GemFireRedisServer}
+ * Default: ""
*/
String REDIS_BIND_ADDRESS = "redis-bind-address";
/**
- * The static definition of the "redis-password"
- * property
+ * The static String definition of the "redis-password" property
+ *
+ * Description: Specifies the password to authenticate a client of {@link com.gemstone.gemfire.redis.GemFireRedisServer}
+ * Default: ""
*/
String REDIS_PASSWORD = "redis-password";
/**
- * The static definition of the "lock-memory"
- * property
+ * The static String definition of the "lock-memory" property
+ *
+ * Description: Include this option to lock GemFire heap and off-heap memory pages into RAM.
+ * This prevents the operating sy