berlin.yuna.natsserver.logic

Class Nats

java.lang.Object

berlin.yuna.natsserver.logic.NatsBase

berlin.yuna.natsserver.logic.Nats

All Implemented Interfaces:

AutoCloseable

public class Nats
extends NatsBase

Nats

Since:

1.0

Author:

Yuna Morgenstern

See Also:

SystemUtil, Nats

Field Summary

Fields inherited from class berlin.yuna.natsserver.logic.NatsBase

NATS_PREFIX

Constructor Summary

Constructors

Constructor and Description
Nats() Create Nats without any start able configuration
Nats(int port) Create Nats with the simplest start able configuration
Nats(List<String> customArgs) Create Nats with custom args
Nats(String... kv) Create custom Nats with the simplest configuration config(String...)

Method Summary

Modifier and Type	Method and Description
void	close()
Map<NatsConfig,MapValue>	config() GetNatServerConfig
Nats	config(Map<NatsConfig,String> config) Configures the nats server
Nats	config(NatsConfig key, String value) Configures the nats server
Nats	config(String... kv) Configures the nats server
Nats	start() Starts the server in ProcessBuilder with the given config config(String...)
Nats	start(long timeoutMs) Starts the server in ProcessBuilder with the given config config(String...)
Nats	stop() Stops the ProcessBuilder and kills the Nats Only a log error will occur if the Nats were never started
Nats	stop(long timeoutMs) Stops the ProcessBuilder and kills the Nats Only a log error will occur if the Nats were never started
Nats	tryStart() Starts the server in ProcessBuilder with the given parameterConfig config(String...) Throws all exceptions as RuntimeException
Nats	tryStart(long timeoutMs) Starts the server in ProcessBuilder with the given config config(String...) Throws all exceptions as RuntimeException

Methods inherited from class berlin.yuna.natsserver.logic.NatsBase

args, args, binaryFile, downloadUrl, getConfigFile, getValue, getValue, pid, pidFile, port, toString, url

Methods inherited from class java.lang.Object

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

Constructor Detail

Nats

public Nats()

Create Nats without any start able configuration

Nats

public Nats(List<String> customArgs)

Create Nats with custom args

Nats

public Nats(int port)

Create Nats with the simplest start able configuration

Parameters:

port - start port, -1 = random, default is 4222

Nats

public Nats(String... kv)

Create custom Nats with the simplest configuration config(String...)

Parameters:

kv - passes the original parameters to the server. example: port:4222, user:admin, password:admin

Method Detail

config

public Map<NatsConfig,MapValue> config()

GetNatServerConfig

Returns:

the Nats configuration

config

public Nats config(NatsConfig key,
                   String value)

Configures the nats server

Returns:

the Nats configuration

config

public Nats config(Map<NatsConfig,String> config)

Configures the nats server

Parameters:

config - passes the original parameters to the server.

Returns:

Nats

See Also:

config(String...), NatsConfig

config

public Nats config(String... kv)

Configures the nats server

Parameters:

kv - example: port, 4222, user, admin, password, admin

Returns:

Nats

See Also:

NatsConfig

tryStart

public Nats tryStart()

Starts the server in ProcessBuilder with the given parameterConfig config(String...) Throws all exceptions as RuntimeException

Returns:

Nats

tryStart

public Nats tryStart(long timeoutMs)

Starts the server in ProcessBuilder with the given config config(String...) Throws all exceptions as RuntimeException

Parameters:

timeoutMs - defines the start-up timeout -1 no timeout, else waits until port up

Returns:

Nats

start

public Nats start()
           throws Exception

Starts the server in ProcessBuilder with the given config config(String...)

Returns:

Nats

Throws:

IOException - if Nats is not found or unsupported on the SystemUtil

BindException - if port is already taken

PortUnreachableException - if Nats is not starting cause port is not free

Exception

start

public Nats start(long timeoutMs)
           throws Exception

Starts the server in ProcessBuilder with the given config config(String...)

Parameters:

timeoutMs - defines the start-up timeout -1 no timeout, else waits until port up

Returns:

Nats

Throws:

IOException - if Nats is not found or unsupported on the SystemUtil

BindException - if port is already taken

PortUnreachableException - if Nats is not starting cause port is not free

Exception

close

public void close()

stop

public Nats stop()

Stops the ProcessBuilder and kills the Nats Only a log error will occur if the Nats were never started

Returns:

Nats

stop

public Nats stop(long timeoutMs)

Stops the ProcessBuilder and kills the Nats Only a log error will occur if the Nats were never started

Parameters:

timeoutMs - defines the tear down timeout, -1 no timeout, else waits until port is free again

Returns:

Nats