io.micronaut.testresources.buildtools

Class ServerUtils

java.lang.Object

io.micronaut.testresources.buildtools.ServerUtils

public class ServerUtils
extends java.lang.Object

Utilities used to manage the lifecycle of a server process from build tools.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ServerUtils.ProcessParameters Forking process parameters.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTIES_FILE_NAME

Constructor Summary

Constructors

Constructor and Description
ServerUtils()

Method Summary

Modifier and Type	Method and Description
static java.nio.file.Path	getDefaultSharedSettingsPath() Returns the default path to the settings directory for the test resources server in case it needs to be shared between builds.
static java.nio.file.Path	getDefaultSharedSettingsPath(java.lang.String namespace) Returns the default path to the settings directory for the test resources server in case it needs to be shared between builds.
static boolean	isServerStarted(int port) Determines if a server is already started at the given port.
static java.util.Optional<ServerSettings>	readServerSettings(java.nio.file.Path settingsDirectory) Reads the server settings from an input directory.
static ServerSettings	startOrConnectToExistingServer(java.lang.Integer explicitPort, java.nio.file.Path portFilePath, java.nio.file.Path serverSettingsDirectory, java.lang.String accessToken, java.util.Collection<java.io.File> serverClasspath, java.lang.Integer clientTimeoutMs, ServerFactory serverFactory) Starts a server at the given port, or connects to an existing server running at the given port.
static ServerSettings	startOrConnectToExistingServer(java.lang.Integer explicitPort, java.nio.file.Path portFilePath, java.nio.file.Path serverSettingsDirectory, java.lang.String accessToken, java.nio.file.Path cdsDirectory, java.util.Collection<java.io.File> serverClasspath, java.lang.Integer clientTimeoutMs, ServerFactory serverFactory) Starts a server at the given port, or connects to an existing server running at the given port.
static void	stopServer(java.nio.file.Path serverSettingsDirectory) Stops a running server.
static void	writeServerSettings(java.nio.file.Path destinationDirectory, ServerSettings settings) Writes the server settings in an output directory.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTIES_FILE_NAME

public static final java.lang.String PROPERTIES_FILE_NAME

See Also:

Constant Field Values

Constructor Detail

ServerUtils

public ServerUtils()

Method Detail

writeServerSettings

public static void writeServerSettings(java.nio.file.Path destinationDirectory,
                                       ServerSettings settings)
                                throws java.io.IOException

Writes the server settings in an output directory.

Parameters:

destinationDirectory - the destination directory

settings - the settings

Throws:

java.io.IOException - if an error occurs

readServerSettings

public static java.util.Optional<ServerSettings> readServerSettings(java.nio.file.Path settingsDirectory)

Reads the server settings from an input directory.

Parameters:

settingsDirectory - the settings directory

Returns:

the server settings, if any

isServerStarted

public static boolean isServerStarted(int port)

Determines if a server is already started at the given port.

Parameters:

port - the port to check

Returns:

true if the port is already bound

startOrConnectToExistingServer

public static ServerSettings startOrConnectToExistingServer(java.lang.Integer explicitPort,
                                                            java.nio.file.Path portFilePath,
                                                            java.nio.file.Path serverSettingsDirectory,
                                                            java.lang.String accessToken,
                                                            java.nio.file.Path cdsDirectory,
                                                            java.util.Collection<java.io.File> serverClasspath,
                                                            java.lang.Integer clientTimeoutMs,
                                                            ServerFactory serverFactory)
                                                     throws java.io.IOException

Starts a server at the given port, or connects to an existing server running at the given port.

Parameters:

explicitPort - the explicit port to connect to, if it exists.

portFilePath - the path to the port file, where the port will be written.

serverSettingsDirectory - the server settings directory, will be written.

accessToken - the access token, if any

cdsDirectory - the CDS directory. If not null, class data sharing will be enabled

serverClasspath - the server classpath

clientTimeoutMs - the client timeout

serverFactory - the server factory, responsible for forking a process

Returns:

the server settings once the server is started

Throws:

java.io.IOException - if an error occurs

startOrConnectToExistingServer

public static ServerSettings startOrConnectToExistingServer(java.lang.Integer explicitPort,
                                                            java.nio.file.Path portFilePath,
                                                            java.nio.file.Path serverSettingsDirectory,
                                                            java.lang.String accessToken,
                                                            java.util.Collection<java.io.File> serverClasspath,
                                                            java.lang.Integer clientTimeoutMs,
                                                            ServerFactory serverFactory)
                                                     throws java.io.IOException

Starts a server at the given port, or connects to an existing server running at the given port.

Parameters:

explicitPort - the explicit port to connect to, if it exists.

portFilePath - the path to the port file, where the port will be written.

serverSettingsDirectory - the server settings directory, will be written.

accessToken - the access token, if any

serverClasspath - the server classpath

clientTimeoutMs - the client timeout

serverFactory - the server factory, responsible for forking a process

Returns:

the server settings once the server is started

Throws:

java.io.IOException - if an error occurs

stopServer

public static void stopServer(java.nio.file.Path serverSettingsDirectory)
                       throws java.io.IOException

Stops a running server. The server will be contacted thanks to the settings in the given directory.

Parameters:

serverSettingsDirectory - the settings directory

Throws:

java.io.IOException - if an error occurs

getDefaultSharedSettingsPath

public static java.nio.file.Path getDefaultSharedSettingsPath()

Returns the default path to the settings directory for the test resources server in case it needs to be shared between builds. Equivalent to calling getDefaultSharedSettingsPath(String) without a namespace.

Returns:

the default path to the settings directory

getDefaultSharedSettingsPath

public static java.nio.file.Path getDefaultSharedSettingsPath(java.lang.String namespace)

Returns the default path to the settings directory for the test resources server in case it needs to be shared between builds.

Parameters:

namespace - the namespace of the shared settings

Returns:

the default path to the settings directory