nats.io

Class NatsRunnerUtils

java.lang.Object

nats.io.NatsRunnerUtils

public abstract class NatsRunnerUtils
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONF_FILE_EXT
static java.lang.String	CONF_FILE_PREFIX
static java.lang.String	CONFIG_FILE_OPTION_NAME
static java.lang.String	CONFIG_PORT_KEY
static int	DEFAULT_CLUSTER_COUNT
static java.lang.String	DEFAULT_CLUSTER_NAME
static java.lang.String	DEFAULT_HOST
static int	DEFAULT_LISTEN_START
static int	DEFAULT_MONITOR_START
static java.lang.String	DEFAULT_NATS_SERVER
static int	DEFAULT_PORT_START
static java.lang.String	DEFAULT_SERVER_NAME_PREFIX
static java.lang.String	JETSTREAM_OPTION
static java.lang.String	LOCALHOST
static java.lang.String	NATS
static java.lang.String	NATS_PORT_KEY
static java.lang.String	NATS_SERVER_PATH_ENV
static java.lang.String	NON_NATS_PORT_KEY
static java.lang.String	PORT_MAPPED_REGEX
static java.lang.String	PORT_PROPERTY
static java.lang.String	PORT_REGEX
static java.lang.String	USER_PORT_KEY
static java.lang.String	VERSION_OPTION

Method Summary

Modifier and Type	Method and Description
static void	clearServerPath() Deprecated. Use NatsServerRunner.clearPreferredServerPath() instead
static java.util.List<ClusterInsert>	createClusterInserts()
static java.util.List<ClusterInsert>	createClusterInserts(int count)
static java.util.List<ClusterInsert>	createClusterInserts(int count, java.nio.file.Path jsStoreDirBase)
static java.util.List<ClusterInsert>	createClusterInserts(int count, java.lang.String clusterName, java.lang.String serverNamePrefix)
static java.util.List<ClusterInsert>	createClusterInserts(int count, java.lang.String clusterName, java.lang.String serverNamePrefix, boolean monitor)
static java.util.List<ClusterInsert>	createClusterInserts(int count, java.lang.String clusterName, java.lang.String serverNamePrefix, boolean monitor, java.nio.file.Path jsStoreDirBase)
static java.util.List<ClusterInsert>	createClusterInserts(int count, java.lang.String clusterName, java.lang.String serverNamePrefix, java.nio.file.Path jsStoreDirBase)
static java.util.List<ClusterInsert>	createClusterInserts(java.util.List<ClusterNode> nodes)
static java.util.List<ClusterInsert>	createClusterInserts(java.nio.file.Path jsStoreDirBase)
static java.util.List<ClusterNode>	createNodes(int count, java.lang.String clusterName, java.lang.String serverNamePrefix, boolean monitor, java.nio.file.Path jsStoreDirBase)
static java.util.List<ClusterNode>	createNodes(int count, java.lang.String clusterName, java.lang.String serverNamePrefix, java.nio.file.Path jsStoreDirBase, java.lang.String host, int portStart, int listenStart, java.lang.Integer monitorStart)
static void	defaultHost(java.lang.String defaultHost)
static void	defaultListenStart(int defaultListenStart)
static void	defaultMonitorStart(int defaultMonitorStart)
static void	defaultPortStart(int defaultPortStart)
static java.lang.String	getLocalhostUri(java.lang.String schema, int port) Build a schema://localhost:port uri
static java.lang.String	getNatsLocalhostUri(int port) Build a nats://localhost:port uri
static java.lang.String	getNatsServerVersionString() Get the version string from the nats server i.e.
static java.lang.String	getNatsServerVersionString(java.lang.String serverPath) Get the version string from the nats server i.e.
static java.lang.String	getNatsUri(java.lang.String host, int port) Build a nats://host:port uri
static java.lang.String	getResolvedServerPath() Resolves the server executable path in this order: Checking the "nats_server_path" environment variable Checking the value set via NatsServerRunner.setPreferredServerPath(java.lang.String) method "nats-server"
static java.lang.String	getUri(java.lang.String schema, java.lang.String host, int port) Build a schema://host:port uri
static java.lang.String	getURIForPort(int port) Deprecated. Use getNatsLocalhostUri(int) instead.
static int	nextPort() Get a port number automatically allocated by the system, typically from an ephemeral port range.
static void	setServerPath(java.lang.String serverPath) Deprecated. Use NatsServerRunner.setPreferredServerPath(java.lang.String) instead

Methods inherited from class java.lang.Object

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

Field Detail

NATS_SERVER_PATH_ENV

public static final java.lang.String NATS_SERVER_PATH_ENV

See Also:

Constant Field Values

DEFAULT_NATS_SERVER

public static final java.lang.String DEFAULT_NATS_SERVER

See Also:

Constant Field Values

CONFIG_FILE_OPTION_NAME

public static final java.lang.String CONFIG_FILE_OPTION_NAME

See Also:

Constant Field Values

VERSION_OPTION

public static final java.lang.String VERSION_OPTION

See Also:

Constant Field Values

JETSTREAM_OPTION

public static final java.lang.String JETSTREAM_OPTION

See Also:

Constant Field Values

CONF_FILE_PREFIX

public static final java.lang.String CONF_FILE_PREFIX

See Also:

Constant Field Values

CONF_FILE_EXT

public static final java.lang.String CONF_FILE_EXT

See Also:

Constant Field Values

PORT_REGEX

public static final java.lang.String PORT_REGEX

See Also:

Constant Field Values

PORT_MAPPED_REGEX

public static final java.lang.String PORT_MAPPED_REGEX

See Also:

Constant Field Values

PORT_PROPERTY

public static final java.lang.String PORT_PROPERTY

See Also:

Constant Field Values

CONFIG_PORT_KEY

public static final java.lang.String CONFIG_PORT_KEY

See Also:

Constant Field Values

USER_PORT_KEY

public static final java.lang.String USER_PORT_KEY

See Also:

Constant Field Values

NATS_PORT_KEY

public static final java.lang.String NATS_PORT_KEY

See Also:

Constant Field Values

NON_NATS_PORT_KEY

public static final java.lang.String NON_NATS_PORT_KEY

See Also:

Constant Field Values

DEFAULT_CLUSTER_COUNT

public static final int DEFAULT_CLUSTER_COUNT

See Also:

Constant Field Values

DEFAULT_CLUSTER_NAME

public static final java.lang.String DEFAULT_CLUSTER_NAME

See Also:

Constant Field Values

DEFAULT_SERVER_NAME_PREFIX

public static final java.lang.String DEFAULT_SERVER_NAME_PREFIX

See Also:

Constant Field Values

NATS

public static final java.lang.String NATS

See Also:

Constant Field Values

LOCALHOST

public static final java.lang.String LOCALHOST

See Also:

Constant Field Values

DEFAULT_HOST

public static java.lang.String DEFAULT_HOST

DEFAULT_PORT_START

public static int DEFAULT_PORT_START

DEFAULT_LISTEN_START

public static int DEFAULT_LISTEN_START

DEFAULT_MONITOR_START

public static int DEFAULT_MONITOR_START

Method Detail

getURIForPort

@Deprecated
public static java.lang.String getURIForPort(int port)

Deprecated. Use getNatsLocalhostUri(int) instead.

Build a standard nats://localhost:port uri

Parameters:

port - the port

Returns:

the uri

getNatsLocalhostUri

public static java.lang.String getNatsLocalhostUri(int port)

Build a nats://localhost:port uri

Parameters:

port - the port

Returns:

the uri

getNatsUri

public static java.lang.String getNatsUri(java.lang.String host,
                                          int port)

Build a nats://host:port uri

Parameters:

host - the host

port - the port

Returns:

the uri

getLocalhostUri

public static java.lang.String getLocalhostUri(java.lang.String schema,
                                               int port)

Build a schema://localhost:port uri

Parameters:

schema - the schema

port - the port

Returns:

the uri

getUri

public static java.lang.String getUri(java.lang.String schema,
                                      java.lang.String host,
                                      int port)

Build a schema://host:port uri

Parameters:

schema - the schema

host - the host

port - the port

Returns:

the uri

setServerPath

@Deprecated
public static void setServerPath(java.lang.String serverPath)

Deprecated. Use NatsServerRunner.setPreferredServerPath(java.lang.String) instead

Set the path for the server. Will be used if "nats_server_path" environment variable is not set.

Parameters:

serverPath - the fully qualified path of the server

clearServerPath

@Deprecated
public static void clearServerPath()

Deprecated. Use NatsServerRunner.clearPreferredServerPath() instead

Clear the default path for the server.

getResolvedServerPath

public static java.lang.String getResolvedServerPath()

Resolves the server executable path in this order:

1. Checking the "nats_server_path" environment variable
2. Checking the value set via NatsServerRunner.setPreferredServerPath(java.lang.String) method
3. "nats-server"

Returns:

the resolved path

nextPort

public static int nextPort()
                    throws java.io.IOException

Get a port number automatically allocated by the system, typically from an ephemeral port range.

Returns:

the port number

Throws:

java.io.IOException - if there is a problem getting a port

getNatsServerVersionString

public static java.lang.String getNatsServerVersionString()

Get the version string from the nats server i.e. nats-server: v2.2.2 Using the server resolved by getResolvedServerPath()

Returns:

the version string

getNatsServerVersionString

public static java.lang.String getNatsServerVersionString(java.lang.String serverPath)

Get the version string from the nats server i.e. nats-server: v2.2.2

Parameters:

serverPath - the specific server path to check

Returns:

the version string

createClusterInserts

public static java.util.List<ClusterInsert> createClusterInserts()
                                                          throws java.io.IOException

Throws:

java.io.IOException

createClusterInserts

public static java.util.List<ClusterInsert> createClusterInserts(java.nio.file.Path jsStoreDirBase)
                                                          throws java.io.IOException

Throws:

java.io.IOException

createClusterInserts

public static java.util.List<ClusterInsert> createClusterInserts(int count)
                                                          throws java.io.IOException

Throws:

java.io.IOException

createClusterInserts

public static java.util.List<ClusterInsert> createClusterInserts(int count,
                                                                 java.nio.file.Path jsStoreDirBase)
                                                          throws java.io.IOException

Throws:

java.io.IOException

createClusterInserts

public static java.util.List<ClusterInsert> createClusterInserts(int count,
                                                                 java.lang.String clusterName,
                                                                 java.lang.String serverNamePrefix)
                                                          throws java.io.IOException

Throws:

java.io.IOException

createClusterInserts

public static java.util.List<ClusterInsert> createClusterInserts(int count,
                                                                 java.lang.String clusterName,
                                                                 java.lang.String serverNamePrefix,
                                                                 java.nio.file.Path jsStoreDirBase)
                                                          throws java.io.IOException

Throws:

java.io.IOException

createClusterInserts

public static java.util.List<ClusterInsert> createClusterInserts(int count,
                                                                 java.lang.String clusterName,
                                                                 java.lang.String serverNamePrefix,
                                                                 boolean monitor)
                                                          throws java.io.IOException

Throws:

java.io.IOException

createClusterInserts

public static java.util.List<ClusterInsert> createClusterInserts(int count,
                                                                 java.lang.String clusterName,
                                                                 java.lang.String serverNamePrefix,
                                                                 boolean monitor,
                                                                 java.nio.file.Path jsStoreDirBase)
                                                          throws java.io.IOException

Throws:

java.io.IOException

defaultHost

public static void defaultHost(java.lang.String defaultHost)

defaultPortStart

public static void defaultPortStart(int defaultPortStart)

defaultListenStart

public static void defaultListenStart(int defaultListenStart)

defaultMonitorStart

public static void defaultMonitorStart(int defaultMonitorStart)

createNodes

public static java.util.List<ClusterNode> createNodes(int count,
                                                      java.lang.String clusterName,
                                                      java.lang.String serverNamePrefix,
                                                      boolean monitor,
                                                      java.nio.file.Path jsStoreDirBase)

createNodes

public static java.util.List<ClusterNode> createNodes(int count,
                                                      java.lang.String clusterName,
                                                      java.lang.String serverNamePrefix,
                                                      java.nio.file.Path jsStoreDirBase,
                                                      java.lang.String host,
                                                      int portStart,
                                                      int listenStart,
                                                      java.lang.Integer monitorStart)

createClusterInserts

public static java.util.List<ClusterInsert> createClusterInserts(java.util.List<ClusterNode> nodes)