io.micronaut.nats.connect

Class NatsConnectionFactoryConfig

java.lang.Object

io.micronaut.nats.connect.NatsConnectionFactoryConfig

Direct Known Subclasses:

ClusterNatsConnectionFactoryConfig, SingleNatsConnectionFactoryConfig

public abstract class NatsConnectionFactoryConfig
extends java.lang.Object

Base class for nats to be configured.

Since:

1.0.0

Author:

jgrimm

Constructor Summary

Constructors

Constructor and Description
NatsConnectionFactoryConfig(java.lang.String name) Default constructor.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.util.List<java.lang.String>>	getAddresses()
java.time.Duration	getConnectionTimeout()
java.lang.String	getCredentials()
java.lang.String	getInboxPrefix()
char[]	getKeyStorePassword()
java.lang.String	getKeyStorePath()
java.lang.String	getKeyStoreType()
int	getMaxReconnect()
java.lang.String	getName()
java.util.Optional<java.lang.String>	getPassword()
java.time.Duration	getPingInterval()
long	getReconnectBufferSize()
java.time.Duration	getReconnectWait()
java.util.Optional<java.lang.String>	getToken()
char[]	getTrustStorePassword()
java.lang.String	getTrustStorePath()
java.lang.String	getTrustStoreType()
java.util.Optional<java.lang.String>	getUsername()
boolean	isNoEcho()
boolean	isUtf8Support()
void	setAddresses(java.util.List<java.lang.String> addresses)
void	setConnectionTimeout(java.time.Duration connectionTimeout)
void	setCredentials(java.lang.String credentials)
void	setInboxPrefix(java.lang.String inboxPrefix)
void	setKeyStorePassword(char[] keyStorePassword)
void	setKeyStorePath(java.lang.String keyStorePath)
void	setKeyStoreType(java.lang.String keyStoreType)
void	setMaxReconnect(int maxReconnect)
void	setNoEcho(boolean noEcho)
void	setPassword(java.lang.String password)
void	setPingInterval(java.time.Duration pingInterval)
void	setReconnectBufferSize(long reconnectBufferSize)
void	setReconnectWait(java.time.Duration reconnectWait)
void	setToken(java.lang.String token)
void	setTrustStorePassword(char[] trustStorePassword)
void	setTrustStorePath(java.lang.String trustStorePath)
void	setTrustStoreType(java.lang.String trustStoreType)
void	setUsername(java.lang.String username)
void	setUtf8Support(boolean utf8Support)
io.nats.client.Options	toOptions()
io.nats.client.Options.Builder	toOptionsBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

NatsConnectionFactoryConfig

public NatsConnectionFactoryConfig(@Parameter
                                   java.lang.String name)

Default constructor.

Parameters:

name - The name of the configuration

Method Detail

getName

public java.lang.String getName()

Returns:

The name qualifier

getAddresses

public java.util.Optional<java.util.List<java.lang.String>> getAddresses()

Returns:

An optional list of addresses

setAddresses

public void setAddresses(@Nullable
                         java.util.List<java.lang.String> addresses)

Parameters:

addresses - The list of addresses

getUsername

public java.util.Optional<java.lang.String> getUsername()

Returns:

the username for the connection

setUsername

public void setUsername(@Nullable
                        java.lang.String username)

Parameters:

username - the username

getPassword

public java.util.Optional<java.lang.String> getPassword()

Returns:

the password for the connection

setPassword

public void setPassword(@Nullable
                        java.lang.String password)

Parameters:

password - the password

getToken

public java.util.Optional<java.lang.String> getToken()

Returns:

the token for the connection

setToken

public void setToken(java.lang.String token)

Parameters:

token - the token

getMaxReconnect

public int getMaxReconnect()

Returns:

the max reconnection tries

setMaxReconnect

public void setMaxReconnect(int maxReconnect)

Parameters:

maxReconnect - times to try reconnect

getReconnectWait

public java.time.Duration getReconnectWait()

Returns:

time to wait between reconnect attempts

setReconnectWait

public void setReconnectWait(java.time.Duration reconnectWait)

Parameters:

reconnectWait - time to wait

getConnectionTimeout

public java.time.Duration getConnectionTimeout()

Returns:

maximum time for initial connection

setConnectionTimeout

public void setConnectionTimeout(java.time.Duration connectionTimeout)

Parameters:

connectionTimeout - maximumTime for inital connection

getPingInterval

public java.time.Duration getPingInterval()

Returns:

time between ping intervals

setPingInterval

public void setPingInterval(java.time.Duration pingInterval)

Parameters:

pingInterval - time between server pings

getReconnectBufferSize

public long getReconnectBufferSize()

Returns:

size of the buffer, in bytes, used to store publish messages during reconnect

setReconnectBufferSize

public void setReconnectBufferSize(long reconnectBufferSize)

Parameters:

reconnectBufferSize - size of the buffer, in bytes, used to store publish messages during reconnect

getInboxPrefix

public java.lang.String getInboxPrefix()

Returns:

prefix to use for request/reply inboxes

setInboxPrefix

public void setInboxPrefix(java.lang.String inboxPrefix)

Parameters:

inboxPrefix - custom prefix for request/reply inboxes

isNoEcho

public boolean isNoEcho()

Returns:

whether or not to block echo messages, messages that were sent by this connection

setNoEcho

public void setNoEcho(boolean noEcho)

Parameters:

noEcho - enable or disable echo messages, messages that are sent by this connection back to this connection

isUtf8Support

public boolean isUtf8Support()

Returns:

whether or not the client should support for UTF8 subject names

setUtf8Support

public void setUtf8Support(boolean utf8Support)

Parameters:

utf8Support - whether or not the client should support for UTF8 subject names

getCredentials

public java.lang.String getCredentials()

Returns:

path to the credentials file to use for authentication with an account enabled server

setCredentials

public void setCredentials(java.lang.String credentials)

Parameters:

credentials - path to the credentials file to use for authentication with an account enabled server

getKeyStorePath

public java.lang.String getKeyStorePath()

Returns:

path to the SSL Keystore

setKeyStorePath

public void setKeyStorePath(java.lang.String keyStorePath)

Parameters:

keyStorePath - file path for the SSL Keystore

getKeyStorePassword

public char[] getKeyStorePassword()

Returns:

password used to unlock the keystore

setKeyStorePassword

public void setKeyStorePassword(char[] keyStorePassword)

Parameters:

keyStorePassword - used to unlock the keystore

getKeyStoreType

public java.lang.String getKeyStoreType()

Returns:

type of keystore to use for SSL connections

setKeyStoreType

public void setKeyStoreType(java.lang.String keyStoreType)

Parameters:

keyStoreType - generally the default, but available for special keystore formats/types

getTrustStorePath

public java.lang.String getTrustStorePath()

Returns:

file path for the SSL trust store

setTrustStorePath

public void setTrustStorePath(java.lang.String trustStorePath)

Parameters:

trustStorePath - file path for the SSL trust store

getTrustStorePassword

public char[] getTrustStorePassword()

Returns:

password used to unlock the trust store

setTrustStorePassword

public void setTrustStorePassword(char[] trustStorePassword)

Parameters:

trustStorePassword - used to unlock the trust store

getTrustStoreType

public java.lang.String getTrustStoreType()

Returns:

type of keystore to use for SSL connections

setTrustStoreType

public void setTrustStoreType(java.lang.String trustStoreType)

Parameters:

trustStoreType - generally the default, but available for special trust store formats/types

toOptions

public io.nats.client.Options toOptions()
                                 throws java.io.IOException,
                                        java.security.GeneralSecurityException

Returns:

NATS options based on this set of properties

Throws:

java.io.IOException - if there is a problem reading a file or setting up the SSL context

java.security.GeneralSecurityException - if there is a problem setting up the SSL context

toOptionsBuilder

public io.nats.client.Options.Builder toOptionsBuilder()
                                                throws java.io.IOException,
                                                       java.security.GeneralSecurityException

Returns:

NATS options builder based on this set of properties, useful if other settings are required before connect is called

Throws:

java.io.IOException - if there is a problem reading a file or setting up the SSL context

java.security.GeneralSecurityException - if there is a problem setting up the SSL context