com.mysql.cj.admin

Class ServerController

java.lang.Object

com.mysql.cj.admin.ServerController

public class ServerController
extends java.lang.Object

Controls a MySQL server using Java RunTime methods

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASEDIR_KEY Where is the server installed?
static java.lang.String	DATADIR_KEY Where are the databases installed?
static java.lang.String	DEFAULTS_FILE_KEY Where is the config file located?
static java.lang.String	EXECUTABLE_NAME_KEY What is the name of the executable to run?
static java.lang.String	EXECUTABLE_PATH_KEY What is the path to the mysql server executable (if not standard?)
private java.lang.Process	serverProcess The process representing the MySQL server
private java.util.Properties	serverProps The list of properties for this server

Constructor Summary

Constructors

Constructor and Description
ServerController(java.lang.String baseDir) Creates a ServerController with the directory for the MySQL server.
ServerController(java.lang.String basedir, java.lang.String datadir) Creates a server controller for the MySQL server with the given basedir and datadir.

Method Summary

Modifier and Type	Method and Description
private java.lang.String	buildOptionalCommandLine() Builds the list of command-line arguments that will be passed to the mysql server to be started.
void	forceStop() Forcefully terminates the server process (if started).
private java.lang.String	getCommandLine() Returns the full commandline used to start the mysql server, including and arguments to be passed to the server process.
private java.lang.String	getFullExecutablePath() Returns the fully-qualifed path to the 'mysqld' executable
java.util.Properties	getServerProps() Returns the list of properties that will be used to start/control the server.
private boolean	isNonCommandLineArgument(java.lang.String propName) Returns true if the property does not belong as a command-line argument
private boolean	runningOnWindows() Is this ServerController running on a Windows operating system?
void	setBaseDir(java.lang.String baseDir) Sets the basedir to use when starting MySQL.
void	setDataDir(java.lang.String dataDir) Sets the data to use when starting MySQL.
java.lang.Process	start() Starts the server, returning a java.lang.Process instance that represents the mysql server.
void	stop(boolean forceIfNecessary) Stops the server (if started)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BASEDIR_KEY

public static final java.lang.String BASEDIR_KEY

Where is the server installed?

See Also:

Constant Field Values

DATADIR_KEY

public static final java.lang.String DATADIR_KEY

Where are the databases installed?

See Also:

Constant Field Values

DEFAULTS_FILE_KEY

public static final java.lang.String DEFAULTS_FILE_KEY

Where is the config file located?

See Also:

Constant Field Values

EXECUTABLE_NAME_KEY

public static final java.lang.String EXECUTABLE_NAME_KEY

What is the name of the executable to run?

See Also:

Constant Field Values

EXECUTABLE_PATH_KEY

public static final java.lang.String EXECUTABLE_PATH_KEY

What is the path to the mysql server executable (if not standard?)

See Also:

Constant Field Values

serverProcess

private java.lang.Process serverProcess

The process representing the MySQL server

serverProps

private java.util.Properties serverProps

The list of properties for this server

Constructor Detail

ServerController

public ServerController(java.lang.String baseDir)

Creates a ServerController with the directory for the MySQL server. The 'datadir' is set to the same directory.

Parameters:

baseDir - the base directory for the MySQL server.

ServerController

public ServerController(java.lang.String basedir,
                        java.lang.String datadir)

Creates a server controller for the MySQL server with the given basedir and datadir.

Parameters:

basedir - the basedir to use when starting MySQL.

datadir - the datadir to use when starting MySQL.

Method Detail

setBaseDir

public void setBaseDir(java.lang.String baseDir)

Sets the basedir to use when starting MySQL.

Parameters:

baseDir - the basedir to use when starting MySQL.

setDataDir

public void setDataDir(java.lang.String dataDir)

Sets the data to use when starting MySQL.

Parameters:

dataDir - the basedir to use when starting MySQL.

start

public java.lang.Process start()
                        throws java.io.IOException

Starts the server, returning a java.lang.Process instance that represents the mysql server.

Returns:

Process a java.lang.Process instance representing the mysql server process.

Throws:

java.io.IOException - if an error occurs while starting the mysql server.

stop

public void stop(boolean forceIfNecessary)
          throws java.io.IOException

Stops the server (if started)

Parameters:

forceIfNecessary - use forceStop if mysqladmin doesn't shut the server down

Throws:

java.io.IOException - if an error occurs while stopping the server

forceStop

public void forceStop()

Forcefully terminates the server process (if started).

getServerProps

public java.util.Properties getServerProps()

Returns the list of properties that will be used to start/control the server.

Returns:

Properties the list of properties.

getCommandLine

private java.lang.String getCommandLine()

Returns the full commandline used to start the mysql server, including and arguments to be passed to the server process.

Returns:

String the commandline used to start the mysql server.

getFullExecutablePath

private java.lang.String getFullExecutablePath()

Returns the fully-qualifed path to the 'mysqld' executable

Returns:

String the path to the server executable.

buildOptionalCommandLine

private java.lang.String buildOptionalCommandLine()

Builds the list of command-line arguments that will be passed to the mysql server to be started.

Returns:

String the list of command-line arguments.

isNonCommandLineArgument

private boolean isNonCommandLineArgument(java.lang.String propName)

Returns true if the property does not belong as a command-line argument

Parameters:

propName - property name

Returns:

boolean if the property should not be a command-line argument.

runningOnWindows

private boolean runningOnWindows()

Is this ServerController running on a Windows operating system?

Returns:

boolean if this ServerController is running on Windows