Package berlin.yuna.natsserver.logic

Class NatsStreaming

java.lang.Object

berlin.yuna.natsserver.logic.NatsBase

berlin.yuna.natsserver.logic.NatsStreaming

All Implemented Interfaces:

AutoCloseable

public class NatsStreaming
extends NatsBase

NatsStreaming

Field Summary

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

NATS_PREFIX

Constructor Summary

Constructors

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

Method Summary

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

NatsStreaming

public NatsStreaming()

Create NatsStreaming without any start able configuration

NatsStreaming

public NatsStreaming(List<String> customArgs)

Create NatsStreaming with custom args

NatsStreaming

public NatsStreaming(int port)

Create NatsStreaming with the simplest start able configuration

Parameters:

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

NatsStreaming

public NatsStreaming(String... kv)

Create custom NatsStreaming 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<NatsStreamingConfig,MapValue> config()

GetNatServerConfig

Returns:

the NatsStreaming configuration

config

public NatsStreaming config(NatsStreamingConfig key,
                            String value)

Configures the nats server

Returns:

the NatsStreaming configuration

config

public NatsStreaming config(Map<NatsStreamingConfig,String> config)

Configures the nats server

Parameters:

config - passes the original parameters to the server.

Returns:

NatsStreaming

See Also:

config(String...), NatsStreamingConfig

config

public NatsStreaming config(String... kv)

Configures the nats server

Parameters:

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

Returns:

NatsStreaming

See Also:

NatsStreamingConfig

tryStart

public NatsStreaming tryStart()

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

Returns:

NatsStreaming

tryStart

public NatsStreaming 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:

NatsStreaming

start

public NatsStreaming start()
                    throws Exception

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

Returns:

NatsStreaming

Throws:

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

BindException - if port is already taken

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

Exception

start

public NatsStreaming 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:

NatsStreaming

Throws:

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

BindException - if port is already taken

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

Exception

close

public void close()

stop

public NatsStreaming stop()

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

Returns:

NatsStreaming

stop

public NatsStreaming stop(long timeoutMs)

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

Parameters:

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

Returns:

NatsStreaming