Package org.drasyl

Class DrasylConfig

java.lang.Object

org.drasyl.DrasylConfig

public class DrasylConfig
extends Object

This class represents the configuration for a DrasylNode. For example, it defines the identity and the Super Peer.

This is an immutable object.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DrasylConfig.Builder

Constructor Summary

Constructors

Constructor	Description
DrasylConfig()
DrasylConfig(com.typesafe.config.Config config)	Creates a new config for a drasyl node.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static byte	getByte(com.typesafe.config.Config config, String path)	Gets the byte at the given path.
static Endpoint	getEndpoint(com.typesafe.config.Config config, String path)
static List<Endpoint>	getEndpointList(com.typesafe.config.Config config, String path)
Path	getIdentityPath()
CompressedPrivateKey	getIdentityPrivateKey()
ProofOfWork	getIdentityProofOfWork()
CompressedPublicKey	getIdentityPublicKey()
static InetAddress	getInetAddress(com.typesafe.config.Config config, String path)
static InetSocketAddress	getInetSocketAddress(com.typesafe.config.Config config, String path)
String	getMonitoringHostTag()
String	getMonitoringInfluxDatabase()
String	getMonitoringInfluxPassword()
Duration	getMonitoringInfluxReportingFrequency()
URI	getMonitoringInfluxUri()
String	getMonitoringInfluxUser()
int	getNetworkId()
static Path	getPath(com.typesafe.config.Config config, String path)	Gets the Path at the given path.
Set<DrasylPlugin>	getPlugins()
static Set<DrasylPlugin>	getPlugins(com.typesafe.config.Config config, String path)
static CompressedPrivateKey	getPrivateKey(com.typesafe.config.Config config, String path)	Gets the CompressedPrivateKey at the given path.
static ProofOfWork	getProofOfWork(com.typesafe.config.Config config, String path)	Gets the ProofOfWork at the given path.
static CompressedPublicKey	getPublicKey(com.typesafe.config.Config config, String path)	Gets the CompressedPublicKey at the given path.
InetAddress	getRemoteBindHost()
int	getRemoteBindPort()
Set<Endpoint>	getRemoteEndpoints()
Duration	getRemoteLocalHostDiscoveryLeaseTime()
Path	getRemoteLocalHostDiscoveryPath()
Duration	getRemoteMessageComposedMessageTransferTimeout()
byte	getRemoteMessageHopLimit()
int	getRemoteMessageMaxContentLength()
int	getRemoteMessageMtu()
Duration	getRemotePingCommunicationTimeout()
Duration	getRemotePingInterval()
int	getRemotePingMaxPeers()
Duration	getRemotePingTimeout()
Map<CompressedPublicKey,InetSocketAddressWrapper>	getRemoteStaticRoutes()
Set<Endpoint>	getRemoteSuperPeerEndpoints()
Duration	getRemoteUniteMinInterval()
static Map<Class<?>,String>	getSerializationBindings(com.typesafe.config.Config config, String path, Collection<String> serializers)
Map<Class<?>,String>	getSerializationsBindingsInbound()
Map<Class<?>,String>	getSerializationsBindingsOutbound()
Map<String,Serializer>	getSerializationSerializers()
static Map<String,Serializer>	getSerializationSerializers(com.typesafe.config.Config config, String path)
static short	getShort(com.typesafe.config.Config config, String path)	Gets the short at the given path.
static Map<CompressedPublicKey,InetSocketAddressWrapper>	getStaticRoutes(com.typesafe.config.Config config, String path)
static URI	getURI(com.typesafe.config.Config config, String path)	Gets the URI at the given path.
int	hashCode()
boolean	isIntraVmDiscoveryEnabled()
boolean	isMonitoringEnabled()
boolean	isRemoteEnabled()
boolean	isRemoteExposeEnabled()
boolean	isRemoteLocalHostDiscoveryEnabled()
boolean	isRemoteMessageArmEnabled()
boolean	isRemoteSuperPeerEnabled()
static DrasylConfig.Builder	newBuilder()	Creates a new builder to build a custom DrasylConfig.
static DrasylConfig.Builder	newBuilder(DrasylConfig config)
static DrasylConfig	parseFile(File file)	Parses a file into a Config instance as with
static DrasylConfig	parseString(String s)	Parses a file into a Config instance as with
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DrasylConfig

public DrasylConfig()

DrasylConfig

public DrasylConfig(com.typesafe.config.Config config)

Creates a new config for a drasyl node.

Parameters:

config - config to be loaded

Throws:

DrasylConfigException - if config is invalid

Method Detail

getProofOfWork

public static ProofOfWork getProofOfWork(com.typesafe.config.Config config,
                                         String path)

Gets the ProofOfWork at the given path. Similar to Config, an exception is thrown for an invalid value.

Parameters:

config - the application's portion of the configuration

path - path expression

Returns:

the ProofOfWork value at the requested path

Throws:

DrasylConfigException - if value is absent or null

getPublicKey

public static CompressedPublicKey getPublicKey(com.typesafe.config.Config config,
                                               String path)

Gets the CompressedPublicKey at the given path. Similar to Config, an exception is thrown for an invalid value.

Parameters:

config - the application's portion of the configuration

path - path expression

Returns:

the CompressedPublicKey value at the requested path

Throws:

DrasylConfigException - if value is not convertible to a CompressedPublicKey

getPrivateKey

public static CompressedPrivateKey getPrivateKey(com.typesafe.config.Config config,
                                                 String path)

Gets the CompressedPrivateKey at the given path. Similar to Config, an exception is thrown for an invalid value.

Parameters:

config - the application's portion of the configuration

path - path expression

Returns:

the CompressedPrivateKey value at the requested path

Throws:

DrasylConfigException - if value is not convertible to a CompressedPrivateKey

getPath

public static Path getPath(com.typesafe.config.Config config,
                           String path)

Gets the Path at the given path.

Parameters:

config - the application's portion of the configuration

path - path expression

Returns:

the Path value at the requested path

Throws:

DrasylConfigException - if value at path is invalid

getInetAddress

public static InetAddress getInetAddress(com.typesafe.config.Config config,
                                         String path)

Throws:

DrasylConfigException - if value at path is invalid

getEndpointList

public static List<Endpoint> getEndpointList(com.typesafe.config.Config config,
                                             String path)

Throws:

DrasylConfigException - if value at path is invalid

getEndpoint

public static Endpoint getEndpoint(com.typesafe.config.Config config,
                                   String path)

Throws:

DrasylConfigException - if value at path is invalid

getShort

public static short getShort(com.typesafe.config.Config config,
                             String path)

Gets the short at the given path. Similar to Config, an exception is thrown for an out-of-range value.

Parameters:

config - the application's portion of the configuration

path - path expression

Returns:

the short value at the requested path

Throws:

DrasylConfigException - if value is not convertible to a short

getByte

public static byte getByte(com.typesafe.config.Config config,
                           String path)

Gets the byte at the given path. Similar to Config, an exception is thrown for an out-of-range value.

Parameters:

config - the application's portion of the configuration

path - path expression

Returns:

the byte value at the requested path

Throws:

DrasylConfigException - if value is not convertible to a short

getURI

public static URI getURI(com.typesafe.config.Config config,
                         String path)

Gets the URI at the given path.

Parameters:

config - the application's portion of the configuration

path - path expression

Returns:

the URI value at the requested path

Throws:

DrasylConfigException - if value at path is invalid

getPlugins

public static Set<DrasylPlugin> getPlugins(com.typesafe.config.Config config,
                                           String path)

Throws:

DrasylConfigException - if value at path is invalid

getSerializationSerializers

public static Map<String,Serializer> getSerializationSerializers(com.typesafe.config.Config config,
                                                                       String path)

getSerializationBindings

public static Map<Class<?>,String> getSerializationBindings(com.typesafe.config.Config config,
                                                                  String path,
                                                                  Collection<String> serializers)

getInetSocketAddress

public static InetSocketAddress getInetSocketAddress(com.typesafe.config.Config config,
                                                     String path)

Throws:

DrasylConfigException - if value at path is invalid

getStaticRoutes

public static Map<CompressedPublicKey,InetSocketAddressWrapper> getStaticRoutes(com.typesafe.config.Config config,
                                                                                      String path)

Throws:

DrasylConfigException - if value at path is invalid

parseFile

public static DrasylConfig parseFile(File file)

Parses a file into a Config instance as with

Parameters:

file - the file to parse

Returns:

the parsed configuration

Throws:

DrasylConfigException - on IO or parse errors

parseString

public static DrasylConfig parseString(String s)

Parses a file into a Config instance as with

Parameters:

s - string to parse

Returns:

the parsed configuration

Throws:

DrasylConfigException - on IO or parse errors

newBuilder

public static DrasylConfig.Builder newBuilder()

Creates a new builder to build a custom DrasylConfig. The built configuration is derived from the default configuration. The builder must be finalized by calling DrasylConfig.Builder.build() to create the resulting DrasylConfig.

Returns:

the new builder

newBuilder

public static DrasylConfig.Builder newBuilder(DrasylConfig config)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getRemotePingTimeout

public Duration getRemotePingTimeout()

getRemotePingCommunicationTimeout

public Duration getRemotePingCommunicationTimeout()

getRemoteUniteMinInterval

public Duration getRemoteUniteMinInterval()

getRemotePingMaxPeers

public int getRemotePingMaxPeers()

getNetworkId

public int getNetworkId()

isMonitoringEnabled

public boolean isMonitoringEnabled()

getMonitoringHostTag

public String getMonitoringHostTag()

getMonitoringInfluxUri

public URI getMonitoringInfluxUri()

getMonitoringInfluxUser

public String getMonitoringInfluxUser()

getMonitoringInfluxPassword

public String getMonitoringInfluxPassword()

getMonitoringInfluxDatabase

public String getMonitoringInfluxDatabase()

getMonitoringInfluxReportingFrequency

public Duration getMonitoringInfluxReportingFrequency()

isRemoteEnabled

public boolean isRemoteEnabled()

getRemoteBindHost

public InetAddress getRemoteBindHost()

getRemoteBindPort

public int getRemoteBindPort()

getRemoteEndpoints

public Set<Endpoint> getRemoteEndpoints()

isRemoteExposeEnabled

public boolean isRemoteExposeEnabled()

getRemotePingInterval

public Duration getRemotePingInterval()

isRemoteSuperPeerEnabled

public boolean isRemoteSuperPeerEnabled()

getRemoteSuperPeerEndpoints

public Set<Endpoint> getRemoteSuperPeerEndpoints()

getIdentityProofOfWork

public ProofOfWork getIdentityProofOfWork()

getIdentityPublicKey

public CompressedPublicKey getIdentityPublicKey()

getIdentityPrivateKey

public CompressedPrivateKey getIdentityPrivateKey()

getIdentityPath

public Path getIdentityPath()

getRemoteMessageMtu

public int getRemoteMessageMtu()

getRemoteMessageMaxContentLength

public int getRemoteMessageMaxContentLength()

getRemoteMessageComposedMessageTransferTimeout

public Duration getRemoteMessageComposedMessageTransferTimeout()

getRemoteMessageHopLimit

public byte getRemoteMessageHopLimit()

isRemoteMessageArmEnabled

public boolean isRemoteMessageArmEnabled()

getRemoteStaticRoutes

public Map<CompressedPublicKey,InetSocketAddressWrapper> getRemoteStaticRoutes()

isIntraVmDiscoveryEnabled

public boolean isIntraVmDiscoveryEnabled()

isRemoteLocalHostDiscoveryEnabled

public boolean isRemoteLocalHostDiscoveryEnabled()

getRemoteLocalHostDiscoveryPath

public Path getRemoteLocalHostDiscoveryPath()

getRemoteLocalHostDiscoveryLeaseTime

public Duration getRemoteLocalHostDiscoveryLeaseTime()

getPlugins

public Set<DrasylPlugin> getPlugins()

getSerializationSerializers

public Map<String,Serializer> getSerializationSerializers()

getSerializationsBindingsInbound

public Map<Class<?>,String> getSerializationsBindingsInbound()

getSerializationsBindingsOutbound

public Map<Class<?>,String> getSerializationsBindingsOutbound()