Class ServerUtils

java.lang.Object

io.micronaut.testresources.buildtools.ServerUtils

public class ServerUtils
extends Object

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTIES_FILE_NAME
protected static final String	SERVER_TEST_PROPERTY	Used only in tests to skip actual port checking.

Constructor Summary

Constructors

Constructor	Description
ServerUtils()

Method Summary

Modifier and Type	Method	Description
static 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 Path	getDefaultSharedSettingsPath(@Nullable 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 Optional<ServerSettings>	readServerSettings(Path settingsDirectory)	Reads the server settings from an input directory.
static ServerSettings	startOrConnectToExistingServer(@Nullable Integer explicitPort, Path portFilePath, Path serverSettingsDirectory, @Nullable String accessToken, @Nullable Path cdsDirectory, Collection<File> serverClasspath, @Nullable Integer clientTimeoutMs, @Nullable Integer serverIdleTimeoutMinutes, ServerFactory serverFactory)	Starts a server at the given port, or connects to an existing server running at the given port.
static ServerSettings	startOrConnectToExistingServer(@Nullable Integer explicitPort, Path portFilePath, Path serverSettingsDirectory, @Nullable String accessToken, Collection<File> serverClasspath, @Nullable Integer clientTimeoutMs, @Nullable Integer serverIdleTimeoutMinutes, ServerFactory serverFactory)	Starts a server at the given port, or connects to an existing server running at the given port.
static void	stopServer(Path serverSettingsDirectory)	Stops a running server.
static void	writeServerSettings(Path destinationDirectory, ServerSettings settings)	Writes the server settings in an output directory.

Methods inherited from class Object

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

Field Details

PROPERTIES_FILE_NAME

public static final String PROPERTIES_FILE_NAME

See Also:

• Constant Field Values

SERVER_TEST_PROPERTY

protected static final String SERVER_TEST_PROPERTY

Used only in tests to skip actual port checking.

See Also:

• Constant Field Values

Constructor Details

ServerUtils

public ServerUtils()

Method Details

writeServerSettings

public static void writeServerSettings(Path destinationDirectory,
 ServerSettings settings)
                                throws IOException

Writes the server settings in an output directory.

Parameters:

destinationDirectory - the destination directory

settings - the settings

Throws:

IOException - if an error occurs

readServerSettings

public static Optional<ServerSettings> readServerSettings(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(@Nullable Integer explicitPort,
 Path portFilePath,
 Path serverSettingsDirectory,
 @Nullable String accessToken,
 @Nullable Path cdsDirectory,
 Collection<File> serverClasspath,
 @Nullable Integer clientTimeoutMs,
 @Nullable Integer serverIdleTimeoutMinutes,
 ServerFactory serverFactory)
                                                     throws 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

serverIdleTimeoutMinutes - the server idle timeout

serverFactory - the server factory, responsible for forking a process

Returns:

the server settings once the server is started

Throws:

IOException - if an error occurs

startOrConnectToExistingServer

public static ServerSettings startOrConnectToExistingServer(@Nullable Integer explicitPort,
 Path portFilePath,
 Path serverSettingsDirectory,
 @Nullable String accessToken,
 Collection<File> serverClasspath,
 @Nullable Integer clientTimeoutMs,
 @Nullable Integer serverIdleTimeoutMinutes,
 ServerFactory serverFactory)
                                                     throws 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

serverIdleTimeoutMinutes - the server idle timeout

serverFactory - the server factory, responsible for forking a process

Returns:

the server settings once the server is started

Throws:

IOException - if an error occurs

stopServer

public static void stopServer(Path serverSettingsDirectory)
                       throws IOException

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

Parameters:

serverSettingsDirectory - the settings directory

Throws:

IOException - if an error occurs

getDefaultSharedSettingsPath

public static 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 Path getDefaultSharedSettingsPath(@Nullable 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