public static class ServerLauncher.Builder extends Object
Constructor and Description |
---|
ServerLauncher.Builder()
Default constructor used to create an instance of the Builder class for programmatical access.
|
ServerLauncher.Builder(String... args)
Constructor used to create and configure an instance of the Builder class with the specified arguments, passed in
from the command-line when launching an instance of this class from the command-line using the Java launcher.
|
Modifier and Type | Method and Description |
---|---|
ServerLauncher |
build()
Validates the Builder configuration settings and then constructs an instance of the ServerLauncher class
to invoke operations on a GemFire Server.
|
Boolean |
getAssignBuckets()
Determines whether buckets should be assigned to partitioned regions in the cache upon Server start.
|
ServerLauncher.Command |
getCommand()
Gets the Server launcher command used during the invocation of the ServerLauncher.
|
Float |
getCriticalHeapPercentage() |
Boolean |
getDebug()
Determines whether the new instance of the ServerLauncher will be set to debug mode.
|
Boolean |
getDisableDefaultServer()
Determines whether a default cache server will be added when the GemFire Server comes online.
|
Properties |
getDistributedSystemProperties()
Gets the GemFire Distributed System (cluster) Properties configuration.
|
Float |
getEvictionHeapPercentage() |
Boolean |
getForce()
Gets the boolean value used by the Server to determine if it should overwrite the PID file if it already exists.
|
Boolean |
getHelp()
Determines whether the new instance of the ServerLauncher will be used to output help information for either
a specific command, or for using ServerLauncher in general.
|
String |
getHostNameForClients() |
Integer |
getMaxConnections() |
Integer |
getMaxMessageCount() |
Integer |
getMaxThreads() |
String |
getMemberName()
Gets the member name of this Server in GemFire.
|
Integer |
getMessageTimeToLive() |
Integer |
getPid()
Gets the process ID (PID) of the running Server indicated by the user as an argument to the ServerLauncher.
|
Boolean |
getRebalance()
Determines whether a rebalance operation on the cache will occur upon starting the GemFire server.
|
Boolean |
getRedirectOutput()
Determines whether the new instance of LocatorLauncher will redirect
output to system logs when starting a Locator.
|
InetAddress |
getServerBindAddress()
Gets the IP address to which the Server will be bound listening for and accepting cache client connections in
a client/server topology.
|
Integer |
getServerPort()
Gets the port on which the Server will listen for and accept cache client connections in a client/server topology.
|
Integer |
getSocketBufferSize() |
String |
getSpringXmlLocation()
Gets the location of the Spring XML configuration meta-data file used to bootstrap, configure and initialize
the GemFire Server on start.
|
String |
getWorkingDirectory()
Gets the working directory pathname in which the Server will be ran.
|
ServerLauncher.Builder |
set(String propertyName,
String propertyValue)
Sets a GemFire Distributed System Property.
|
ServerLauncher.Builder |
setAssignBuckets(Boolean assignBuckets)
Sets whether buckets should be assigned to partitioned regions in the cache upon Server start.
|
ServerLauncher.Builder |
setCommand(ServerLauncher.Command command)
Sets the Sever launcher command used during the invocation of the ServerLauncher
|
ServerLauncher.Builder |
setCriticalHeapPercentage(Float criticalHeapPercentage) |
ServerLauncher.Builder |
setDebug(Boolean debug)
Sets whether the new instance of the ServerLauncher will be set to debug mode.
|
ServerLauncher.Builder |
setDisableDefaultServer(Boolean disableDefaultServer)
Sets a boolean value indicating whether to add a default cache when the GemFire Server comes online.
|
ServerLauncher.Builder |
setEvictionHeapPercentage(Float evictionHeapPercentage) |
ServerLauncher.Builder |
setForce(Boolean force)
Sets the boolean value used by the Server to determine if it should overwrite the PID file if it already exists.
|
ServerLauncher.Builder |
setHelp(Boolean help)
Sets whether the new instance of ServerLauncher will be used to output help information for either a specific
command, or for using ServerLauncher in general.
|
ServerLauncher.Builder |
setHostNameForClients(String hostNameForClients) |
ServerLauncher.Builder |
setMaxConnections(Integer maxConnections) |
ServerLauncher.Builder |
setMaxMessageCount(Integer maxMessageCount) |
ServerLauncher.Builder |
setMaxThreads(Integer maxThreads) |
ServerLauncher.Builder |
setMemberName(String memberName)
Sets the member name of the Server in GemFire.
|
ServerLauncher.Builder |
setMessageTimeToLive(Integer messageTimeToLive) |
ServerLauncher.Builder |
setPdxDiskStore(String pdxDiskStore)
Sets the GemFire Disk Store to be used to persist PDX type meta-data.
|
ServerLauncher.Builder |
setPdxIgnoreUnreadFields(boolean ignore)
Sets whether fields in the PDX instance should be ignored when unread.
|
ServerLauncher.Builder |
setPdxPersistent(boolean persistent)
Sets whether the PDX type meta-data should be persisted to disk.
|
ServerLauncher.Builder |
setPdxReadSerialized(boolean readSerialized)
Sets whether PDX instances should be returned as is when Region.get(key:String):Object is called.
|
ServerLauncher.Builder |
setPdxSerializer(PdxSerializer pdxSerializer)
Set the PdxSerializer to use to serialize POJOs to the GemFire Cache Region or when sent between peers,
client/server, or during persistence to disk.
|
ServerLauncher.Builder |
setPid(Integer pid)
Sets the process ID (PID) of the running Server indicated by the user as an argument to the ServerLauncher.
|
ServerLauncher.Builder |
setRebalance(Boolean rebalance)
Set a boolean value indicating whether a rebalance operation on the cache should occur upon starting
the GemFire server.
|
ServerLauncher.Builder |
setRedirectOutput(Boolean redirectOutput)
Sets whether the new instance of LocatorLauncher will redirect output to system logs when starting a Locator.
|
ServerLauncher.Builder |
setServerBindAddress(String serverBindAddress)
Sets the IP address to which the Server will be bound listening for and accepting cache client connections in
a client/server topology.
|
ServerLauncher.Builder |
setServerPort(Integer serverPort)
Sets the port on which the Server will listen for and accept cache client connections in a client/server topology.
|
ServerLauncher.Builder |
setSocketBufferSize(Integer socketBufferSize) |
ServerLauncher.Builder |
setSpringXmlLocation(String springXmlLocation)
Sets the location of the Spring XML configuration meta-data file used to bootstrap, configure and initialize
the GemFire Server on start.
|
ServerLauncher.Builder |
setWorkingDirectory(String workingDirectory)
Sets the working directory in which the Server will be ran.
|
public ServerLauncher.Builder()
public ServerLauncher.Builder(String... args)
args
- the array of arguments used to configure the Builder.parseArguments(String...)
public ServerLauncher.Command getCommand()
setCommand(com.gemstone.gemfire.distributed.ServerLauncher.Command)
,
ServerLauncher.Command
public ServerLauncher.Builder setCommand(ServerLauncher.Command command)
command
- the targeted Server launcher command used during the invocation (run) of ServerLauncher.getCommand()
,
ServerLauncher.Command
public Boolean getAssignBuckets()
setAssignBuckets(Boolean)
public ServerLauncher.Builder setAssignBuckets(Boolean assignBuckets)
assignBuckets
- a boolean indicating if buckets should be assigned upon Server start.getAssignBuckets()
public Boolean getDebug()
setDebug(Boolean)
public ServerLauncher.Builder setDebug(Boolean debug)
debug
- a boolean value indicating whether debug mode is to be enabled or disabled.getDebug()
public Boolean getDisableDefaultServer()
setDisableDefaultServer(Boolean)
public ServerLauncher.Builder setDisableDefaultServer(Boolean disableDefaultServer)
disableDefaultServer
- a boolean value indicating whether to add a default cache server.getDisableDefaultServer()
public Properties getDistributedSystemProperties()
Properties
public Boolean getForce()
LocalProcessLauncher
,
setForce(Boolean)
public ServerLauncher.Builder setForce(Boolean force)
force
- a boolean value indicating whether to overwrite the PID file when it already exists.LocalProcessLauncher
,
getForce()
public Boolean getHelp()
setHelp(Boolean)
public ServerLauncher.Builder setHelp(Boolean help)
help
- a boolean indicating whether help information is to be displayed during invocation of ServerLauncher.getHelp()
public Boolean getRebalance()
setRebalance(Boolean)
public ServerLauncher.Builder setRebalance(Boolean rebalance)
rebalance
- a boolean indicating if the cache will be rebalanced when the GemFire server starts.getRebalance()
public String getMemberName()
setMemberName(String)
public ServerLauncher.Builder setMemberName(String memberName)
memberName
- a String indicating the member name of this Server in GemFire.IllegalArgumentException
- if the member name is invalid.getMemberName()
public Integer getPid()
setPid(Integer)
public ServerLauncher.Builder setPid(Integer pid)
pid
- a user specified Integer value indicating the process ID of the running Server.IllegalArgumentException
- if the process ID (PID) is not valid (greater than zero if not null).getPid()
public Boolean getRedirectOutput()
setRedirectOutput(Boolean)
public ServerLauncher.Builder setRedirectOutput(Boolean redirectOutput)
redirectOutput
- a boolean value indicating if output will be redirected to system logs when starting
a Locator.getRedirectOutput()
public InetAddress getServerBindAddress()
setServerBindAddress(String)
public ServerLauncher.Builder setServerBindAddress(String serverBindAddress)
serverBindAddress
- a String specifying the IP address or hostname that the Server will be bound to listen
for and accept cache client connections in a client/server topology.IllegalArgumentException
- wrapping the UnknownHostException if the IP address or hostname for the
server bind address is unknown.getServerBindAddress()
public Integer getServerPort()
setServerPort(Integer)
public ServerLauncher.Builder setServerPort(Integer serverPort)
serverPort
- an Integer value specifying the port the Server will listen on and accept cache client
connections in a client/server topology.IllegalArgumentException
- if the port number is not valid.getServerPort()
public String getSpringXmlLocation()
setSpringXmlLocation(String)
public ServerLauncher.Builder setSpringXmlLocation(String springXmlLocation)
springXmlLocation
- a String indicating the location of the Spring XML configuration file.getSpringXmlLocation()
public String getWorkingDirectory()
setWorkingDirectory(String)
public ServerLauncher.Builder setWorkingDirectory(String workingDirectory)
workingDirectory
- a String indicating the pathname of the directory in which the Server will be ran.IllegalArgumentException
- wrapping a FileNotFoundException if the working directory pathname cannot be
found.getWorkingDirectory()
,
FileNotFoundException
public Float getCriticalHeapPercentage()
public ServerLauncher.Builder setCriticalHeapPercentage(Float criticalHeapPercentage)
public Float getEvictionHeapPercentage()
public ServerLauncher.Builder setEvictionHeapPercentage(Float evictionHeapPercentage)
public String getHostNameForClients()
public ServerLauncher.Builder setHostNameForClients(String hostNameForClients)
public Integer getMaxConnections()
public ServerLauncher.Builder setMaxConnections(Integer maxConnections)
public Integer getMaxMessageCount()
public ServerLauncher.Builder setMaxMessageCount(Integer maxMessageCount)
public Integer getMaxThreads()
public ServerLauncher.Builder setMaxThreads(Integer maxThreads)
public Integer getMessageTimeToLive()
public ServerLauncher.Builder setMessageTimeToLive(Integer messageTimeToLive)
public Integer getSocketBufferSize()
public ServerLauncher.Builder setSocketBufferSize(Integer socketBufferSize)
public ServerLauncher.Builder set(String propertyName, String propertyValue)
propertyName
- a String indicating the name of the GemFire Distributed System property.propertyValue
- a String value for the GemFire Distributed System property.public ServerLauncher.Builder setPdxPersistent(boolean persistent)
persistent
- a boolean indicating whether PDX type meta-data should be persisted to disk.public ServerLauncher.Builder setPdxDiskStore(String pdxDiskStore)
pdxDiskStore
- a String indicating the name of the GemFire Disk Store to use to store PDX type meta-datapublic ServerLauncher.Builder setPdxIgnoreUnreadFields(boolean ignore)
ignore
- a boolean indicating whether unread fields in the PDX instance should be ignored.public ServerLauncher.Builder setPdxReadSerialized(boolean readSerialized)
readSerialized
- a boolean indicating whether the PDX instance should be returned from a call to
Region.get(key:String):Objectpublic ServerLauncher.Builder setPdxSerializer(PdxSerializer pdxSerializer)
pdxSerializer
- the PdxSerializer that is used to serialize application domain objects into PDX.public ServerLauncher build()
validate()
,
ServerLauncher
Copyright © 1997-2017 Pivotal Software, Inc. All rights reserved.