java.lang.Object
- berlin.yuna.natsserver.logic.Nats

All Implemented Interfaces:

NatsInterface, AutoCloseable
```
public class Nats
extends Object
implements NatsInterface
```
Nats

Since:

1.0

Author:

Yuna Morgenstern

See Also:

SystemUtil, NatsInterface

Field Summary

Fields
Modifier and Type	Field	Description
`protected Map<NatsConfig,MapValue>`	`configMap`
`protected String`	`name`
`static String`	`NATS_PREFIX`
`protected AtomicReference<berlin.yuna.clu.logic.Terminal>`	`terminal`
`protected Long`	`timeoutMs`

Constructor Summary

Constructors
Constructor	Description
`Nats()`	Throws all exceptions as `NatsStartException` which is a `RuntimeException` Possible wrapped exceptions: `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
`Nats(int port)`	Starts the server if `NatsConfig.NATS_AUTOSTART` == true Throws all exceptions as `NatsStartException` which is a `RuntimeException` Possible wrapped exceptions: `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
`Nats(NatsOptionsBuilder natsOptions)`	Starts the server if `NatsConfig.NATS_AUTOSTART` == true Throws all exceptions as `NatsStartException` which is a `RuntimeException` Possible wrapped exceptions: `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
`Nats(NatsOptions natsOptions)`	Starts the server if `NatsConfig.NATS_AUTOSTART` == true Throws all exceptions as `NatsStartException` which is a `RuntimeException` Possible wrapped exceptions: `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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`addConfig(NatsConfig key, Object value)`
`protected void`	`addConfig(ValueSource source, NatsConfig key, String value)`
`Path`	`binary()`
`void`	`close()`
`Map<NatsConfig,String>`	`config()`
`Path`	`configFile()`
`Path`	`configPropertyFile()`
`String[]`	`customArgs()`
`boolean`	`debug()`
`protected void`	`deletePidFile()`
`protected Path`	`downloadNats()`
`String`	`downloadUrl()`	Nats download url which is usually a zip file
`String`	`getValue(NatsConfig key)`	Gets resolved config value from key
`String`	`getValue(NatsConfig key, Supplier<String> or)`	Gets resolved config value from key
`boolean`	`jetStream()`
`Logger`	`logger()`
`Level`	`loggingLevel()`
`int`	`pid()`	get process id
`Path`	`pidFile()`	get process id file which only exists when the process is running
`int`	`port()`
`protected String`	`prepareCommand()`
`Process`	`process()`
`protected void`	`sendStopSignal()`
`protected void`	`setConfigFromNatsOptions(NatsOptions natsOptions)`
`protected void`	`setConfigFromProperties()`
`protected void`	`setDefaultConfig()`
`protected void`	`setEnvConfig()`
`protected int`	`setNextFreePort()`
`protected void`	`shutdown()`
`Nats`	`start()`	Starts the server if not already started e.g.
`protected void`	`startProcess(String command)`
`String`	`toString()`
`String`	`url()`	nats server URL from bind to host address
`protected void`	`waitForShutDown(long timeoutMs)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - name
```
protected final String name
```
  - timeoutMs
```
protected final Long timeoutMs
```
  - configMap
```
protected final Map<NatsConfig,MapValue> configMap
```
  - terminal
```
protected final AtomicReference<berlin.yuna.clu.logic.Terminal> terminal
```
  - NATS_PREFIX
```
public static final String NATS_PREFIX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Nats
```
public Nats()
```
    Throws all exceptions as NatsStartException which is a RuntimeException
    Possible wrapped exceptions:
    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
  - Nats
```
public Nats(int port)
```
    Starts the server if NatsConfig.NATS_AUTOSTART == true Throws all exceptions as NatsStartException which is a RuntimeException
    Possible wrapped exceptions:
    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
    
    Parameters:
    
    port - the port to start on or <=0 to use an automatically allocated port
  - Nats
```
public Nats(NatsOptionsBuilder natsOptions)
```
    Starts the server if NatsConfig.NATS_AUTOSTART == true Throws all exceptions as NatsStartException which is a RuntimeException
    Possible wrapped exceptions:
    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
    
    Parameters:
    
    natsOptions - nats options
  - Nats
```
public Nats(NatsOptions natsOptions)
```
    Starts the server if NatsConfig.NATS_AUTOSTART == true Throws all exceptions as NatsStartException which is a RuntimeException
    Possible wrapped exceptions:
    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
    
    Parameters:
    
    natsOptions - nats options
- Method Detail
  - start
```
public Nats start()
```
    Starts the server if not already started e.g. by NatsConfig.NATS_AUTOSTART == true
    TThrows all exceptions as NatsStartException which is a RuntimeException
    Possible wrapped exceptions:
    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
    
    Returns:
    
    Nats
  - process
```
public Process process()
```
    Specified by:
    
    process in interface NatsInterface
  - customArgs
```
public String[] customArgs()
```
    Specified by:
    
    customArgs in interface NatsInterface
  - logger
```
public Logger logger()
```
    Specified by:
    
    logger in interface NatsInterface
  - loggingLevel
```
public Level loggingLevel()
```
    Specified by:
    
    loggingLevel in interface NatsInterface
  - binary
```
public Path binary()
```
    Specified by:
    
    binary in interface NatsInterface
    
    Returns:
    
    Path to binary file
    see NatsConfig.NATS_BINARY_PATH
  - port
```
public int port()
```
    Specified by:
    
    port in interface NatsInterface
    
    Returns:
    
    Port (if <=0, the port will be visible after start() - see also NatsConfig.NATS_AUTOSTART)
    see NatsConfig.PORT
  - jetStream
```
public boolean jetStream()
```
    Specified by:
    
    jetStream in interface NatsInterface
    
    Returns:
    
    true if Jetstream is enabled
    see NatsConfig.JETSTREAM
  - debug
```
public boolean debug()
```
    Specified by:
    
    debug in interface NatsInterface
    
    Returns:
    
    true if "DV", "DVV" or "DEBUG" is set
    see NatsConfig.DV see NatsConfig.DVV see NatsConfig.DEBUG
  - configFile
```
public Path configFile()
```
    Specified by:
    
    configFile in interface NatsInterface
    
    Returns:
    
    custom nats config file
    see NatsConfig.CONFIG
  - configPropertyFile
```
public Path configPropertyFile()
```
    Returns:
    
    custom property config file
    see NatsConfig.NATS_PROPERTY_FILE
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - getValue
```
public String getValue(NatsConfig key)
```
    Gets resolved config value from key
    
    Parameters:
    
    key - config key
    
    Returns:
    
    config key value
  - getValue
```
public String getValue(NatsConfig key,
                       Supplier<String> or)
```
    Gets resolved config value from key
    
    Parameters:
    
    key - config key
    
    or - lazy loaded fallback value
    
    Returns:
    
    config key value
  - pid
```
public int pid()
```
    get process id
    
    Returns:
    
    process id or -1 if process is not running
  - pidFile
```
public Path pidFile()
```
    get process id file which only exists when the process is running
    
    Returns:
    
    process id file path
  - downloadUrl
```
public String downloadUrl()
```
    Nats download url which is usually a zip file
    
    Returns:
    
    nats download url
  - url
```
public String url()
```
    nats server URL from bind to host address
    
    Specified by:
    
    url in interface NatsInterface
    
    Returns:
    
    nats server url
  - config
```
public Map<NatsConfig,String> config()
```
    Returns:
    
    nats configuration
  - setConfigFromNatsOptions
```
protected void setConfigFromNatsOptions(NatsOptions natsOptions)
```
  - setConfigFromProperties
```
protected void setConfigFromProperties()
```
  - setDefaultConfig
```
protected void setDefaultConfig()
```
  - setEnvConfig
```
protected void setEnvConfig()
```
  - addConfig
```
protected void addConfig(NatsConfig key,
                         Object value)
```
  - addConfig
```
protected void addConfig(ValueSource source,
                         NatsConfig key,
                         String value)
```
  - setNextFreePort
```
protected int setNextFreePort()
```
  - downloadNats
```
protected Path downloadNats()
                     throws IOException
```
    Throws:
    
    IOException
  - prepareCommand
```
protected String prepareCommand()
```
  - shutdown
```
protected void shutdown()
```
  - sendStopSignal
```
protected void sendStopSignal()
```
  - waitForShutDown
```
protected void waitForShutDown(long timeoutMs)
```
  - deletePidFile
```
protected void deletePidFile()
```
  - startProcess
```
protected void startProcess(String command)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Nats

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

timeoutMs

configMap

terminal

NATS_PREFIX

Constructor Detail

Nats

Nats

Nats

Nats

Method Detail

start

process

customArgs

logger

loggingLevel

binary

port

jetStream

debug

configFile

configPropertyFile

close

getValue

getValue

pid

pidFile

downloadUrl

url

config

setConfigFromNatsOptions

setConfigFromProperties

setDefaultConfig

setEnvConfig

addConfig

addConfig

setNextFreePort

downloadNats

prepareCommand

shutdown

sendStopSignal

waitForShutDown

deletePidFile

startProcess

toString