com.cisco.oss.foundation.cluster.utils

Class MasterSlaveConfigurationUtil

java.lang.Object

com.cisco.oss.foundation.cluster.utils.MasterSlaveConfigurationUtil

public class MasterSlaveConfigurationUtil
extends Object

Helper method for reading properties from the config object. Created by Yair Ogen (yaogen) on 14/01/2016.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVE_DATA_CENTER
static String	COMPONENT_NAME
static String	INSTANCE_ID

Constructor Summary

Constructors

Constructor and Description
MasterSlaveConfigurationUtil()

Method Summary

Modifier and Type	Method and Description
static void	enableAuthentication(String user, String password) call this method first if you want to enable authenticated mongo db access
static String	getComponentName()
static String	getMasterSlaveImpl()
static int	getMasterSlaveLeaseTime(String name)
static MasterSlaveMultiplicity	getMasterSlaveMultiplicity(String name)
static String	getMongodbName()
static List<org.apache.commons.lang3.tuple.Pair<String,Integer>>	getMongodbServers() read pairs of host and port from configuration.
static org.apache.commons.lang3.tuple.Pair<String,String>	getMongoUserCredentials()
static String	getUniqueProcessName()
static boolean	isMongoAuthenticationEnabled()
static boolean	isSingleAcrossMDC(String name)
static boolean	isSingleAcrossVersion(String name)
static void	setMongodbServerConfigPrefix(String mongodbServerConfigPrefix) When set to read mongo servers from configuration you can override the configuration prefix using this method.
static void	setMongodbServers(List<org.apache.commons.lang3.tuple.Pair<String,Integer>> mongodbServers) Use this API if you want to external set the mongo servers list and prevent the lib from fetching the info from configuration

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE_ID

public static final String INSTANCE_ID

COMPONENT_NAME

public static final String COMPONENT_NAME

ACTIVE_DATA_CENTER

public static final String ACTIVE_DATA_CENTER

Constructor Detail

MasterSlaveConfigurationUtil

public MasterSlaveConfigurationUtil()

Method Detail

setMongodbServerConfigPrefix

public static void setMongodbServerConfigPrefix(String mongodbServerConfigPrefix)

When set to read mongo servers from configuration you can override the configuration prefix using this method. If called with emppty or null prefix, the default will be used

Parameters:

mongodbServerConfigPrefix - - the new prefix. default is: 'mongodb'.

setMongodbServers

public static void setMongodbServers(List<org.apache.commons.lang3.tuple.Pair<String,Integer>> mongodbServers)

Use this API if you want to external set the mongo servers list and prevent the lib from fetching the info from configuration

Parameters:

mongodbServers -

getMongodbServers

public static List<org.apache.commons.lang3.tuple.Pair<String,Integer>> getMongodbServers()

read pairs of host and port from configuration.

Returns:

List of Pairs. Each pair contains host and port.

enableAuthentication

public static void enableAuthentication(String user,
                                        String password)

call this method first if you want to enable authenticated mongo db access

Parameters:

user - the db user

password - teh db pasword

isMongoAuthenticationEnabled

public static boolean isMongoAuthenticationEnabled()

getMongoUserCredentials

public static org.apache.commons.lang3.tuple.Pair<String,String> getMongoUserCredentials()

getMasterSlaveImpl

public static String getMasterSlaveImpl()

getMongodbName

public static String getMongodbName()

Returns:

the mongo db name

getMasterSlaveLeaseTime

public static int getMasterSlaveLeaseTime(String name)

Parameters:

name - the logical name used in the registry class

Returns:

the lease time in seconds

getMasterSlaveMultiplicity

public static MasterSlaveMultiplicity getMasterSlaveMultiplicity(String name)

isSingleAcrossMDC

public static boolean isSingleAcrossMDC(String name)

isSingleAcrossVersion

public static boolean isSingleAcrossVersion(String name)

getUniqueProcessName

public static String getUniqueProcessName()

Returns:

the component unique name. see wiki for more info: https://github.com/foundation-runtime/cluster/wiki/Master-Slave#instance-identification

getComponentName

public static String getComponentName()

Returns:

the component name. this is not unique and is shared by all instances of the component. see reference: https://github.com/foundation-runtime/cluster/wiki/Master-Slave#instance-identification