io.sarl.sre.janus.network.boot.configs
Class SreNetworkConfig
class SreNetworkConfig
extends java.lang.Object
Configuration for the networking features of the SRE.
Maven Group Identifier:
io.sarl.sre.janus
Maven Artifact Identifier:
janus.network
Since:
0.12
Property Summary
Modifier and type Property and description
java.lang.String clusterMemberIPs
Replies the list of IP addresses of Hazelcast Cluster members as Strings.
java.lang.String clusterMemberIPsArray
Replies the list of IP addresses of Hazelcast Cluster members as Strings.
java.lang.String clusterName
Replies the name of the Hazelcast cluster name that is explicitly provided into the configuration.
boolean enable
Replies the flag that enable or disable the networking features.
JoinMethod joinMethod
Replies the method for cluster joining.
boolean localHazelcastInstance
Replies the property that enable or disable the special configuration for a local instance of Hazelcast.
int minClusterSize
Field Summary
Modifier and type Field and description
public static val java.lang.String CLUSTER_NAME_NAME
Name of the property that contains the name of the Hazelcast cluster.
public static val java.lang.String CLUSTER_NAME_PREFIX
Prefix for the default cluster name.
public static val java.lang.String DEFAULT_CLUSTER_NAME_VALUE
Default value for the explicit cluster name.
public static val boolean DEFAULT_ENABLE_VALUE
Default value for the enabling state of the networking feature outside the Eclipse environment.
public static val java.lang.String DEFAULT_IP_LIST_CLUSTER
Default value for the eArray of Cluster members IP addresses represented as Strings.
public static val boolean DEFAULT_LOCAL_HAZELCAST_INSTANCE_VALUE
Default value of the property that enable or disable the special configuration for a local instance of Hazelcast.
public static val int DEFAULT_MIN_CLUSTER_SIZE_VALUE
Default value for the minimal number of hazelcast nodes before starting.
public static val boolean DEFAULT_PORT_AUTO_INCREMENT_VALUE
Default flag for the auto-increment of the port numbers.
public static val java.lang.String DEFAULT_PROGRAM_NAME
Default name of the program.
public static val java.lang.String ENABLE_NAME
Name of the property that enable or disable the networking features.
public static val java.lang.String IP_LIST_CLUSTER
public static val java.lang.String JOIN_METHOD_NAME
Name of the property that indicates the method for cluster joins.
public static val java.lang.String LOCAL_HAZELCAST_INSTANCE_NAME
Name of the property that enable or disable the special configuration for a local instance of Hazelcast.
public static val java.lang.String MIN_CLUSTER_SIZE_NAME
Name of the property that contains the minimal number of hazelcast nodes before starting.
public static val java.lang.String PORT_AUTO_INCREMENT_NAME
Name of the property that enable or disable the auto-increment of the port numbers.
public static val java.lang.String PREFIX
Prefix for the configuration entries of the modules.
Constructor Summary
Constructor and description
new(SreConfig)
Action Summary
Modifier and type Action and description
static java.lang.String createStandardClusterName(String)
Replies a cluster name following the standard naming convention.
static java.lang.String createStandardClusterName(UUID)
Replies a cluster name following the standard naming convention.
java.lang.String getClusterMemberIPs
Replies the list of IP addresses of Hazelcast Cluster members as Strings.
java.lang.String getClusterMemberIPsArray
Replies the list of IP addresses of Hazelcast Cluster members as Strings.
java.lang.String getClusterName
Replies the name of the Hazelcast cluster name that is explicitly provided into the configuration.
static SreNetworkConfig getConfiguration(ConfigurationFactory)
Replies the configuration for the networking features of the SRE.
boolean getEnable
Replies the flag that enable or disable the networking features.
JoinMethod getJoinMethod
Replies the method for cluster joining.
boolean getLocalHazelcastInstance
Replies the property that enable or disable the special configuration for a local instance of Hazelcast.
int getMinClusterSize
boolean isPortAutoIncrement
java.lang.String setClusterMemberIPs(String)
Set the list of IP addresses of Hazelcast Cluster members as Strings.
java.lang.String setClusterMemberIPsArray(String*)
Set the list of IP addresses of Hazelcast Cluster members as Strings.
void setClusterName(String)
Change the name of the Hazelcast cluster name.
void setEnable(boolean)
Change the flag that enable or disable the networking features.
void setJoinMethod(JoinMethod)
Set the method for cluster joining.
void setLocalHazelcastInstance(boolean)
Change the property that enable or disable the special configuration for a local instance of Hazelcast.
int setMinClusterSize(int)
Set the minimum number of nodes into the cluster before starting the SRE.
void setPortAutoIncrement(boolean)
Change the flag that enable or disable the auto-increment of the port numbers.
static boolean validateClusterMemberIPsArray(String)
Validate the given string of character for being a list of IP addresses.
Property Details
clusterMemberIPs 
val clusterMemberIPs : java.lang.String
Replies the list of IP addresses of Hazelcast Cluster members as Strings.

This property is an alias for the action: getClusterMemberIPs

Returns:
the list of IP addresses of Hazelcast Cluster members.
See:
setClusterMemberIPs(String) , setClusterMemberIPsArray(String*) , getClusterMemberIPsArray
clusterMemberIPsArray 
val clusterMemberIPsArray : java.lang.String
Replies the list of IP addresses of Hazelcast Cluster members as Strings.

This property is an alias for the action: getClusterMemberIPsArray

Returns:
the list of IP addresses of Hazelcast Cluster members.
See:
getClusterMemberIPs , setClusterMemberIPs(String) , setClusterMemberIPsArray(String*)
clusterName 
var clusterName : java.lang.String
Replies the name of the Hazelcast cluster name that is explicitly provided into the configuration.

This property is an alias for the action: getClusterName

Returns:
the cluster name.
enable 
var enable : boolean
Replies the flag that enable or disable the networking features.

This property is an alias for the action: getEnable

Returns:
the enabling state of the enabling state of the networking extension.
joinMethod 
var joinMethod : JoinMethod
Replies the method for cluster joining.

This property is an alias for the action: getJoinMethod

Returns:
the join method.
localHazelcastInstance 
var localHazelcastInstance : boolean
Replies the property that enable or disable the special configuration for a local instance of Hazelcast. If this property is evaluated to true, it overrides all the other hazelcast configuration.

This property is an alias for the action: getLocalHazelcastInstance

Returns:
the enabling state for local Hazelcast instance.
minClusterSize 
val minClusterSize : int

This property is an alias for the action: getMinClusterSize

Field Details
CLUSTER_NAME_NAME 
public static val CLUSTER_NAME_NAME : java.lang.String = "srenetwork.clusterName"
Name of the property that contains the name of the Hazelcast cluster.
CLUSTER_NAME_PREFIX 
public static val CLUSTER_NAME_PREFIX : java.lang.String = "io.sarl.sre-hazelcast-"
Prefix for the default cluster name.
DEFAULT_CLUSTER_NAME_VALUE 
public static val DEFAULT_CLUSTER_NAME_VALUE : java.lang.String = ""
Default value for the explicit cluster name.
DEFAULT_ENABLE_VALUE 
public static val DEFAULT_ENABLE_VALUE : boolean = false
Default value for the enabling state of the networking feature outside the Eclipse environment.
DEFAULT_IP_LIST_CLUSTER 
public static val DEFAULT_IP_LIST_CLUSTER : java.lang.String = "127.0.0.1"
Default value for the eArray of Cluster members IP addresses represented as Strings.
DEFAULT_LOCAL_HAZELCAST_INSTANCE_VALUE 
public static val DEFAULT_LOCAL_HAZELCAST_INSTANCE_VALUE : boolean = false
Default value of the property that enable or disable the special configuration for a local instance of Hazelcast. If this property is evaluated to true, it overrides all the other hazelcast configuration.
DEFAULT_MIN_CLUSTER_SIZE_VALUE 
public static val DEFAULT_MIN_CLUSTER_SIZE_VALUE : int = 1
Default value for the minimal number of hazelcast nodes before starting.
DEFAULT_PORT_AUTO_INCREMENT_VALUE 
public static val DEFAULT_PORT_AUTO_INCREMENT_VALUE : boolean = true
Default flag for the auto-increment of the port numbers.
DEFAULT_PROGRAM_NAME 
public static val DEFAULT_PROGRAM_NAME : java.lang.String = "janusnode"
Default name of the program.
ENABLE_NAME 
public static val ENABLE_NAME : java.lang.String = "srenetwork.enable"
Name of the property that enable or disable the networking features.
IP_LIST_CLUSTER 
public static val IP_LIST_CLUSTER : java.lang.String = "srenetwork.clusterMemberIPs"
JOIN_METHOD_NAME 
public static val JOIN_METHOD_NAME : java.lang.String = "srenetwork.joinMethod"
Name of the property that indicates the method for cluster joins.
LOCAL_HAZELCAST_INSTANCE_NAME 
public static val LOCAL_HAZELCAST_INSTANCE_NAME : java.lang.String = "srenetwork.localHazelcastInstance"
Name of the property that enable or disable the special configuration for a local instance of Hazelcast. If this property is evaluated to true, it overrides all the other hazelcast configuration.
MIN_CLUSTER_SIZE_NAME 
public static val MIN_CLUSTER_SIZE_NAME : java.lang.String = "srenetwork.minClusterSize"
Name of the property that contains the minimal number of hazelcast nodes before starting.
PORT_AUTO_INCREMENT_NAME 
public static val PORT_AUTO_INCREMENT_NAME : java.lang.String = "srenetwork.portAutoIncrement"
Name of the property that enable or disable the auto-increment of the port numbers.
PREFIX 
public static val PREFIX : java.lang.String = "srenetwork"
Prefix for the configuration entries of the modules.
Constructor Details
new(SreConfig) 
new(SreConfig)
Action Details
createStandardClusterName(String) 
def createStandardClusterName(String) : java.lang.String
Replies a cluster name following the standard naming convention.
Parameters:
rootContextId - is the identifier of the root context of the SRE.
Returns:
the cluster name.
createStandardClusterName(UUID) 
def createStandardClusterName(UUID) : java.lang.String
Replies a cluster name following the standard naming convention.
Parameters:
rootContextId - is the identifier of the root context of the SRE.
Returns:
the cluster name.
getClusterMemberIPs 
def getClusterMemberIPs : java.lang.String
Replies the list of IP addresses of Hazelcast Cluster members as Strings.
Returns:
the list of IP addresses of Hazelcast Cluster members.
See:
setClusterMemberIPs(String) , setClusterMemberIPsArray(String*) , getClusterMemberIPsArray
getClusterMemberIPsArray 
def getClusterMemberIPsArray : java.lang.String
Replies the list of IP addresses of Hazelcast Cluster members as Strings.
Returns:
the list of IP addresses of Hazelcast Cluster members.
See:
getClusterMemberIPs , setClusterMemberIPs(String) , setClusterMemberIPsArray(String*)
getClusterName 
def getClusterName : java.lang.String
Replies the name of the Hazelcast cluster name that is explicitly provided into the configuration.
Returns:
the cluster name.
getConfiguration(ConfigurationFactory) 
def getConfiguration(ConfigurationFactory) : SreNetworkConfig
Replies the configuration for the networking features of the SRE.
Parameters:
configFactory - the general configuration factory.
Returns:
the configuration.
getEnable 
def getEnable : boolean
Replies the flag that enable or disable the networking features.
Returns:
the enabling state of the enabling state of the networking extension.
getJoinMethod 
def getJoinMethod : JoinMethod
Replies the method for cluster joining.
Returns:
the join method.
getLocalHazelcastInstance 
def getLocalHazelcastInstance : boolean
Replies the property that enable or disable the special configuration for a local instance of Hazelcast. If this property is evaluated to true, it overrides all the other hazelcast configuration.
Returns:
the enabling state for local Hazelcast instance.
getMinClusterSize 
def getMinClusterSize : int
isPortAutoIncrement 
def isPortAutoIncrement : boolean
setClusterMemberIPs(String) 
def setClusterMemberIPs(String) : java.lang.String
Set the list of IP addresses of Hazelcast Cluster members as Strings.
Parameters:
ips - the list of IP addresses of Hazelcast Cluster members as Strings.
See:
getClusterMemberIPs , getClusterMemberIPsArray , setClusterMemberIPsArray(String*)
setClusterMemberIPsArray(String*) 
def setClusterMemberIPsArray(String*) : java.lang.String
Set the list of IP addresses of Hazelcast Cluster members as Strings.
Parameters:
ips - the list of IP addresses of Hazelcast Cluster members as Strings.
See:
getClusterMemberIPs , setClusterMemberIPs(String) , getClusterMemberIPsArray
setClusterName(String) 
def setClusterName(String)
Change the name of the Hazelcast cluster name.
Parameters:
name - the new cluster name.
See:
getClusterName
setEnable(boolean) 
def setEnable(boolean)
Change the flag that enable or disable the networking features.
Parameters:
enable - the flag value.
setJoinMethod(JoinMethod) 
def setJoinMethod(JoinMethod)
Set the method for cluster joining.
Parameters:
type - the type of join method.
setLocalHazelcastInstance(boolean) 
def setLocalHazelcastInstance(boolean)
Change the property that enable or disable the special configuration for a local instance of Hazelcast. If this property is evaluated to true, it overrides all the other hazelcast configuration.
Parameters:
enable - the enabling state.
setMinClusterSize(int) 
def setMinClusterSize(int) : int
Set the minimum number of nodes into the cluster before starting the SRE.
Parameters:
clusterSize - the minimum number of nodes into the cluster.
setPortAutoIncrement(boolean) 
def setPortAutoIncrement(boolean)
Change the flag that enable or disable the auto-increment of the port numbers.
Parameters:
enable - the flag value.
validateClusterMemberIPsArray(String) 
def validateClusterMemberIPsArray(String) : boolean
Validate the given string of character for being a list of IP addresses.
Parameters:
ips - is the list of IPs to check.
Returns:
true if the given ips is valid.