public final class ServerLauncher extends AbstractLauncher<String>
AbstractLauncher
,
LocatorLauncher
Modifier and Type | Class and Description |
---|---|
static class |
ServerLauncher.Builder
The Builder class, modeled after the Builder creational design pattern, is used to construct a properly configured
and initialized instance of the ServerLauncher to control and run GemFire servers (in particular, cache servers).
|
static class |
ServerLauncher.Command
An enumerated type representing valid commands to the Server launcher.
|
static class |
ServerLauncher.ServerState
The ServerState is an immutable type representing the state of the specified Locator at any given moment in time.
|
AbstractLauncher.ServiceState<T extends Comparable<T>>, AbstractLauncher.Status
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_SERVER_PID_FILE
Deprecated.
This is specific to the internal implementation and may go away in a future release.
|
DEFAULT_WORKING_DIRECTORY, SIGNAL_HANDLER_REGISTRATION_SYSTEM_PROPERTY
Modifier and Type | Method and Description |
---|---|
ServerLauncher.Command |
getCommand()
Get the Server launcher command used to invoke the Server.
|
Float |
getCriticalHeapPercentage() |
Float |
getEvictionHeapPercentage() |
String |
getHostNameForClients() |
String |
getId()
Gets an identifier that uniquely identifies and represents the Server associated with this launcher.
|
static ServerLauncher |
getInstance()
Gets the instance of the ServerLauncher used to launch the GemFire Cache Server, or null if this VM does not
have an instance of ServerLauncher indicating no GemFire Cache Server is running.
|
String |
getLogFileName()
Gets the name of the log file used to log information about this Server.
|
Integer |
getMaxConnections() |
Integer |
getMaxMessageCount() |
Integer |
getMaxThreads() |
String |
getMemberName()
Gets the name of this member (this Server) in the GemFire distributed system as determined by the 'name' GemFire
property.
|
Integer |
getMessageTimeToLive() |
Integer |
getPid()
Gets the user-specified process ID (PID) of the running Server that ServerLauncher uses to issue status and
stop commands to the Server.
|
Properties |
getProperties()
Gets the GemFire Distributed System (cluster) Properties.
|
InetAddress |
getServerBindAddress()
Gets the IP address to which the Server is bound listening for and accepting cache client connections.
|
String |
getServerBindAddressAsString()
Gets the host, as either hostname or IP address, on which the Server was bound and running.
|
Integer |
getServerPort()
Gets the port on which the Server is listening for cache client connections.
|
String |
getServerPortAsString()
Gets the server port on which the Server is listening for client requests represented as a String value.
|
static ServerLauncher.ServerState |
getServerState()
Gets the ServerState for this process or null if this process was not launched using this VM's
ServerLauncher reference .
|
String |
getServiceName()
Gets the name for a GemFire Server.
|
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 run.
|
void |
help(ServerLauncher.Command command)
Displays help for the specified Server launcher command to standard err.
|
boolean |
isAssignBuckets()
Determines whether buckets should be assigned to partitioned regions in the cache upon Server start.
|
boolean |
isDisableDefaultServer()
Determines whether a default cache server will be added when the GemFire Server comes online.
|
boolean |
isForcing()
Determines whether the PID file is allowed to be overwritten when the Server is started and a PID file
already exists in the Server's specified working directory.
|
boolean |
isHelping()
Determines whether this launcher will be used to display help information.
|
boolean |
isRebalancing()
Determines whether a rebalance operation on the cache will occur upon starting the GemFire server using this
launcher.
|
boolean |
isRedirectingOutput()
Determines whether this launcher will redirect output to system logs when
starting a new Locator process.
|
boolean |
isSpringXmlLocationSpecified()
Determines whether this GemFire Server was configured and initialized with Spring configuration meta-data.
|
static void |
main(String... args)
Launches a GemFire Server from the command-line configured with the given arguments.
|
void |
run()
A Runnable method used to invoke the GemFire server (cache server) with the specified command.
|
ServerLauncher.ServerState |
start()
Invokes the 'start' command and operation to startup a GemFire server (a cache server).
|
ServerLauncher.ServerState |
status()
Invokes the 'status' command and operation to check the status of a GemFire server (a cache server).
|
ServerLauncher.ServerState |
stop()
Invokes the 'stop' command and operation to stop a GemFire server (a cache server).
|
void |
usage()
Displays usage information on the proper invocation of the ServerLauncher from the command-line to standard err.
|
void |
waitOnServer()
Causes the calling Thread to block until the GemFire Cache Server/Data Member stops.
|
getMember, getMemberId, isDebugging, isRunning, setDebug, version
public static final String DEFAULT_SERVER_PID_FILE
public static void main(String... args)
args
- the command-line arguments used to configure the GemFire Server at runtime.public static ServerLauncher getInstance()
public static ServerLauncher.ServerState getServerState()
public final String getId()
getServerBindAddressAsString()
,
getServerPortAsString()
public ServerLauncher.Command getCommand()
ServerLauncher.Command
public boolean isAssignBuckets()
public boolean isDisableDefaultServer()
public boolean isForcing()
public boolean isHelping()
ServerLauncher.Command
public boolean isRebalancing()
public boolean isRedirectingOutput()
public String getLogFileName()
getLogFileName
in class AbstractLauncher<String>
public String getMemberName()
getMemberName
in class AbstractLauncher<String>
AbstractLauncher.getMemberName()
public Integer getPid()
getPid
in class AbstractLauncher<String>
public Properties getProperties()
Properties
public InetAddress getServerBindAddress()
public String getServerBindAddressAsString()
InetAddress
,
getServerBindAddress()
public Integer getServerPort()
public String getServerPortAsString()
getServerPort()
public String getServiceName()
getServiceName
in class AbstractLauncher<String>
public String getSpringXmlLocation()
ServerLauncher.Builder.getSpringXmlLocation()
public boolean isSpringXmlLocationSpecified()
public String getWorkingDirectory()
getWorkingDirectory
in class AbstractLauncher<String>
public Float getCriticalHeapPercentage()
public Float getEvictionHeapPercentage()
public String getHostNameForClients()
public Integer getMaxConnections()
public Integer getMaxMessageCount()
public Integer getMessageTimeToLive()
public Integer getMaxThreads()
public Integer getSocketBufferSize()
public void help(ServerLauncher.Command command)
command
- the Server launcher command in which to display help information.usage()
public void usage()
public void run()
Runnable
public ServerLauncher.ServerState start()
run()
public void waitOnServer()
public ServerLauncher.ServerState status()
public ServerLauncher.ServerState stop()
Copyright © 1997-2017 Pivotal Software, Inc. All rights reserved.