nats.io

Class NatsServerRunner

java.lang.Object

nats.io.NatsServerRunner

All Implemented Interfaces:

java.lang.AutoCloseable

public class NatsServerRunner
extends java.lang.Object
implements java.lang.AutoCloseable

Server Runner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NatsServerRunner.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PROCESS_CHECK_TRIES
static long	DEFAULT_PROCESS_CHECK_WAIT
static int	DEFAULT_RUN_CHECK_TRIES
static long	DEFAULT_RUN_CHECK_WAIT
static java.lang.String	ERROR_NOTE_PART_1
static java.lang.String	ERROR_NOTE_PART_2

Constructor Summary

Constructors

Modifier	Constructor and Description
	NatsServerRunner() Construct and start the Nats Server runner with all defaults: use an automatically allocated port no debug flag jetstream not enabled no custom config file no config inserts no custom args
	NatsServerRunner(boolean debug) Construct and start the Nats Server runner with defaults: use an automatically allocated port jetstream not enabled no custom config file no config inserts no custom args and this option:
	NatsServerRunner(boolean debug, boolean jetstream) Construct and start the Nats Server runner with defaults: Consider using NatsServerRunner.Builder use an automatically allocated port no custom config file no config inserts no custom args and these options:
	NatsServerRunner(int port, boolean debug) Construct and start the Nats Server runner with defaults: jetstream not enabled no custom config file no config inserts no custom args and these options:
	NatsServerRunner(int port, boolean debug, boolean jetstream) Construct and start the Nats Server runner with defaults: no custom config file no config inserts no custom args and these options:
	NatsServerRunner(int port, boolean debug, boolean jetstream, java.lang.String configFilePath, java.lang.String[] configInserts, java.lang.String[] customArgs) Construct and start the Nats Server runner with options Consider using NatsServerRunner.Builder
protected	NatsServerRunner(NatsServerRunner.Builder b)
	NatsServerRunner(NatsServerRunnerOptions natsServerRunnerOptions)
	NatsServerRunner(java.lang.String[] customArgs) Construct and start the Nats Server runner with defaults: Consider using NatsServerRunner.Builder use an automatically allocated port no debug flag jetstream not enabled no custom config file no config inserts and these options:
	NatsServerRunner(java.lang.String[] customArgs, boolean debug) Construct and start the Nats Server runner with defaults: Consider using NatsServerRunner.Builder use an automatically allocated port jetstream not enabled no custom config file no config inserts and these options:
	NatsServerRunner(java.lang.String[] customArgs, boolean debug, boolean jetstream) Construct and start the Nats Server runner with defaults: Consider using NatsServerRunner.Builder use an automatically allocated port no custom config file no config inserts and these options:
	NatsServerRunner(java.lang.String[] customArgs, int port, boolean debug) Construct and start the Nats Server runner with defaults: Consider using NatsServerRunner.Builder jetstream not enabled no custom config file no config inserts and these options:
	NatsServerRunner(java.lang.String configFilePath, boolean debug) Construct and start the Nats Server runner with defaults: Consider using NatsServerRunner.Builder use an automatically allocated port jetstream not enabled no config inserts no custom args and these options:
	NatsServerRunner(java.lang.String configFilePath, boolean debug, boolean jetstream) Construct and start the Nats Server runner with defaults: Consider using NatsServerRunner.Builder use an automatically allocated port jetstream not enabled no custom config file and these options:
	NatsServerRunner(java.lang.String configFilePath, int port, boolean debug) Construct and start the Nats Server runner with defaults: Consider using NatsServerRunner.Builder jetstream not enabled no config inserts no custom args and these options:
	NatsServerRunner(java.lang.String configFilePath, java.lang.String[] configInserts, int port, boolean debug) Construct and start the Nats Server runner with defaults: Consider using NatsServerRunner.Builder jetstream not enabled no custom args and these options:

Method Summary

Modifier and Type	Method and Description
static NatsServerRunner.Builder	builder() Get a new Builder
static void	clearPreferredServerPath()
void	close() For AutoCloseable, calls shutdown(true).
java.lang.String	getCmdLine() Get the command line used to start the server
java.lang.String	getConfigFile() Get the absolute path of the config file
int	getConfigPort()
static java.util.logging.Level	getDefaultOutputLevel()
static java.util.function.Supplier<Output>	getDefaultOutputSupplier()
java.lang.String	getExecutablePath() The resolved server executable path being used
int	getNatsPort()
int	getNonNatsPort()
int	getPort() Get the port number.
java.lang.Integer	getPort(java.lang.String key)
static java.lang.String	getPreferredServerPath()
java.lang.String	getURI() Get the uri in the form nats://localhost:port
int	getUserPort()
static void	setDefaultOutputLevel(java.util.logging.Level defaultOutputLevel)
static void	setDefaultOutputSupplier(java.util.function.Supplier<Output> outputSupplier)
static void	setPreferredServerPath(java.lang.String preferredServerPath)
void	shutdown() Shut the server down, waiting (blocking)
void	shutdown(boolean wait) Shut the server down

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_NOTE_PART_1

public static final java.lang.String ERROR_NOTE_PART_1

See Also:

Constant Field Values

ERROR_NOTE_PART_2

public static final java.lang.String ERROR_NOTE_PART_2

See Also:

Constant Field Values

DEFAULT_PROCESS_CHECK_WAIT

public static long DEFAULT_PROCESS_CHECK_WAIT

DEFAULT_PROCESS_CHECK_TRIES

public static int DEFAULT_PROCESS_CHECK_TRIES

DEFAULT_RUN_CHECK_WAIT

public static long DEFAULT_RUN_CHECK_WAIT

DEFAULT_RUN_CHECK_TRIES

public static int DEFAULT_RUN_CHECK_TRIES

Constructor Detail

NatsServerRunner

public NatsServerRunner()
                 throws java.io.IOException

Construct and start the Nats Server runner with all defaults:

• use an automatically allocated port
• no debug flag
• jetstream not enabled
• no custom config file
• no config inserts
• no custom args

Throws:

java.io.IOException - thrown when the server cannot start

NatsServerRunner

public NatsServerRunner(boolean debug)
                 throws java.io.IOException

Construct and start the Nats Server runner with defaults:

• use an automatically allocated port
• jetstream not enabled
• no custom config file
• no config inserts
• no custom args

and this option:

Parameters:

debug - whether to start the server with the -DV flags

Throws:

java.io.IOException - thrown when the server cannot start

NatsServerRunner

public NatsServerRunner(boolean debug,
                        boolean jetstream)
                 throws java.io.IOException

Construct and start the Nats Server runner with defaults: Consider using NatsServerRunner.Builder

• use an automatically allocated port
• no custom config file
• no config inserts
• no custom args

and these options:

Parameters:

debug - whether to start the server with the -DV flags

jetstream - whether to enable JetStream

Throws:

java.io.IOException - thrown when the server cannot start

NatsServerRunner

public NatsServerRunner(int port,
                        boolean debug)
                 throws java.io.IOException

Construct and start the Nats Server runner with defaults:

• jetstream not enabled
• no custom config file
• no config inserts
• no custom args

and these options:

Parameters:

port - the port to start on or <=0 to use an automatically allocated port

debug - whether to start the server with the -DV flags

Throws:

java.io.IOException - thrown when the server cannot start

NatsServerRunner

public NatsServerRunner(int port,
                        boolean debug,
                        boolean jetstream)
                 throws java.io.IOException

Construct and start the Nats Server runner with defaults:

• no custom config file
• no config inserts
• no custom args

and these options:

Parameters:

port - the port to start on or <=0 to use an automatically allocated port

debug - whether to start the server with the -DV flags

jetstream - whether to enable JetStream

Throws:

java.io.IOException - thrown when the server cannot start

NatsServerRunner

public NatsServerRunner(java.lang.String configFilePath,
                        boolean debug)
                 throws java.io.IOException

Construct and start the Nats Server runner with defaults: Consider using NatsServerRunner.Builder

• use an automatically allocated port
• jetstream not enabled
• no config inserts
• no custom args

and these options:

Parameters:

debug - whether to start the server with the -DV flags

configFilePath - path to a custom config file

Throws:

java.io.IOException - thrown when the server cannot start

NatsServerRunner

public NatsServerRunner(java.lang.String configFilePath,
                        boolean debug,
                        boolean jetstream)
                 throws java.io.IOException

Construct and start the Nats Server runner with defaults: Consider using NatsServerRunner.Builder

• use an automatically allocated port
• jetstream not enabled
• no custom config file

and these options:

Parameters:

debug - whether to start the server with the -DV flags

jetstream - whether to enable JetStream

configFilePath - path to a custom config file

Throws:

java.io.IOException - thrown when the server cannot start

NatsServerRunner

public NatsServerRunner(java.lang.String configFilePath,
                        java.lang.String[] configInserts,
                        int port,
                        boolean debug)
                 throws java.io.IOException

Construct and start the Nats Server runner with defaults: Consider using NatsServerRunner.Builder

• jetstream not enabled
• no custom args

and these options:

Parameters:

port - the port to start on or <=0 to use an automatically allocated port

debug - whether to start the server with the -DV flags

configFilePath - path to a custom config file

configInserts - an array of custom lines to add to the config file

Throws:

java.io.IOException - thrown when the server cannot start

NatsServerRunner

public NatsServerRunner(java.lang.String configFilePath,
                        int port,
                        boolean debug)
                 throws java.io.IOException

Construct and start the Nats Server runner with defaults: Consider using NatsServerRunner.Builder

• jetstream not enabled
• no config inserts
• no custom args

and these options:

Parameters:

port - the port to start on or <=0 to use an automatically allocated port

debug - whether to start the server with the -DV flags

configFilePath - path to a custom config file

Throws:

java.io.IOException - thrown when the server cannot start

NatsServerRunner

public NatsServerRunner(java.lang.String[] customArgs)
                 throws java.io.IOException

Construct and start the Nats Server runner with defaults: Consider using NatsServerRunner.Builder

• use an automatically allocated port
• no debug flag
• jetstream not enabled
• no custom config file
• no config inserts

and these options:

Parameters:

customArgs - any custom args to add to the command line

Throws:

java.io.IOException - thrown when the server cannot start

NatsServerRunner

public NatsServerRunner(java.lang.String[] customArgs,
                        boolean debug)
                 throws java.io.IOException

Construct and start the Nats Server runner with defaults: Consider using NatsServerRunner.Builder

• use an automatically allocated port
• jetstream not enabled
• no custom config file
• no config inserts

and these options:

Parameters:

debug - whether to start the server with the -DV flags

customArgs - any custom args to add to the command line

Throws:

java.io.IOException - thrown when the server cannot start

NatsServerRunner

public NatsServerRunner(java.lang.String[] customArgs,
                        boolean debug,
                        boolean jetstream)
                 throws java.io.IOException

Construct and start the Nats Server runner with defaults: Consider using NatsServerRunner.Builder

• use an automatically allocated port
• no custom config file
• no config inserts

and these options:

Parameters:

customArgs - any custom args to add to the command line

debug - whether to start the server with the -DV flags

jetstream - whether to enable JetStream

Throws:

java.io.IOException - thrown when the server cannot start

NatsServerRunner

public NatsServerRunner(java.lang.String[] customArgs,
                        int port,
                        boolean debug)
                 throws java.io.IOException

Construct and start the Nats Server runner with defaults: Consider using NatsServerRunner.Builder

• jetstream not enabled
• no custom config file
• no config inserts

and these options:

Parameters:

customArgs - any custom args to add to the command line

port - the port to start on or <=0 to use an automatically allocated port

debug - whether to start the server with the -DV flags

Throws:

java.io.IOException - thrown when the server cannot start

NatsServerRunner

public NatsServerRunner(int port,
                        boolean debug,
                        boolean jetstream,
                        java.lang.String configFilePath,
                        java.lang.String[] configInserts,
                        java.lang.String[] customArgs)
                 throws java.io.IOException

Construct and start the Nats Server runner with options Consider using NatsServerRunner.Builder

Parameters:

port - the port to start on or <=0 to use an automatically allocated port

debug - whether to start the server with the -DV flags

jetstream - whether to enable JetStream

configFilePath - path to a custom config file

configInserts - an array of custom lines to add to the config file

customArgs - any custom args to add to the command line

Throws:

java.io.IOException - thrown when the server cannot start

NatsServerRunner

public NatsServerRunner(NatsServerRunnerOptions natsServerRunnerOptions)
                 throws java.lang.Exception

Throws:

java.lang.Exception

NatsServerRunner

protected NatsServerRunner(NatsServerRunner.Builder b)
                    throws java.io.IOException

Throws:

java.io.IOException

Method Detail

builder

public static NatsServerRunner.Builder builder()

Get a new Builder

Returns:

the builder

getExecutablePath

public java.lang.String getExecutablePath()

The resolved server executable path being used

Returns:

the path

getPort

public int getPort()

Get the port number. Useful if it was automatically assigned

Returns:

the port number

getUserPort

public int getUserPort()

getNatsPort

public int getNatsPort()

getConfigPort

public int getConfigPort()

getNonNatsPort

public int getNonNatsPort()

getPort

public java.lang.Integer getPort(java.lang.String key)

getConfigFile

public java.lang.String getConfigFile()

Get the absolute path of the config file

Returns:

the path

getURI

public java.lang.String getURI()

Get the uri in the form nats://localhost:port

Returns:

the uri string

getCmdLine

public java.lang.String getCmdLine()

Get the command line used to start the server

Returns:

the command line

shutdown

public void shutdown(boolean wait)
              throws java.lang.InterruptedException

Shut the server down

Parameters:

wait - whether to block while waiting for the process to shut down

Throws:

java.lang.InterruptedException - if the wait was interrupted

shutdown

public void shutdown()
              throws java.lang.InterruptedException

Shut the server down, waiting (blocking)

Throws:

java.lang.InterruptedException - if the wait was interrupted

close

public void close()
           throws java.lang.Exception

For AutoCloseable, calls shutdown(true).

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception

getDefaultOutputSupplier

public static java.util.function.Supplier<Output> getDefaultOutputSupplier()

setDefaultOutputSupplier

public static void setDefaultOutputSupplier(java.util.function.Supplier<Output> outputSupplier)

getDefaultOutputLevel

public static java.util.logging.Level getDefaultOutputLevel()

setDefaultOutputLevel

public static void setDefaultOutputLevel(java.util.logging.Level defaultOutputLevel)

getPreferredServerPath

public static java.lang.String getPreferredServerPath()

setPreferredServerPath

public static void setPreferredServerPath(java.lang.String preferredServerPath)

clearPreferredServerPath

public static void clearPreferredServerPath()