public final class StoreReplicatorDescriptor extends OdsObject
This class contains information used to describe a store replicator. It is intended for use by a user when creating store replicators.
| Modifier and Type | Field and Description |
|---|---|
static String |
PROP_STORE_NAME
Property used to set the store name.
|
static String |
PROP_STORE_REPLICATOR_DETACHED_DISPATCH
Property used to set whether the replicator should dispatch inbound events using a thread separate from the main IO thread
Default Value: "false"
|
static String |
PROP_STORE_REPLICATOR_DETACHED_DISPATCH_DEFAULT
Default value of the
PROP_STORE_REPLICATOR_DETACHED_DISPATCH property |
static String |
PROP_STORE_REPLICATOR_DETACHED_SEND
Property used to set whether the replicator should send outbound messages using a thread separate user thread
Default Value: "false"
|
static String |
PROP_STORE_REPLICATOR_DETACHED_SEND_DEFAULT
Default value of the
PROP_STORE_REPLICATOR_DETACHED_SEND property |
static String |
PROP_STORE_REPLICATOR_DISCOVERY_DESCRIPTOR
Property used to set the descriptor of the discovery network to use to discover store cluster
members.
|
static String |
PROP_STORE_REPLICATOR_DISPATCHER_CPUAFFINITYMASK
Property used to set the CPU affinity mask of the detached dispatcher (only applies if detached dispatch is enabled)
Default Value: The system will use the affinitize the replicator dispatcher thread using the default affinity
if no affinity is specified using this property
|
static String |
PROP_STORE_REPLICATOR_DISPATCHER_QUEUEDEPTH
Property used to set the maximum queue depth of the detached dispatcher (only applies if detached dispatch is enabled)
Default Value: "1024"
|
static String |
PROP_STORE_REPLICATOR_DISPATCHER_QUEUEDEPTH_DEFAULT
Default value of the
PROP_STORE_REPLICATOR_DISPATCHER_QUEUEDEPTH property |
static String |
PROP_STORE_REPLICATOR_DISPATCHER_QUEUEWAITSTRATEGY
Property used to set the queue wait strategy of the detached dispatcher (only applies if detached dispatch is enabled)
Default Value: The system will derive the replicator dispatcher queue wait strategy if no wait strategy is specified
via this property
|
static String |
PROP_STORE_REPLICATOR_FAILONMULTIPLEPRIMARIES
Property used to indicate whether the replicator will fail if it detects multiple primaries in the cluster
Default Value: "true"
|
static String |
PROP_STORE_REPLICATOR_FAILONMULTIPLEPRIMARIES_DEFAULT
Default value of the
PROP_STORE_REPLICATOR_FAILONMULTIPLEPRIMARIES property |
static String |
PROP_STORE_REPLICATOR_INIT_WAIT_EXTENSION_UNIT
Property used to set the time the replicator will extend the init wait if the cluster is not stable at the end of the init.
|
static String |
PROP_STORE_REPLICATOR_INIT_WAIT_EXTENSION_UNIT_DEFAULT
Default value of the
PROP_STORE_REPLICATOR_INIT_WAIT_EXTENSION_UNIT property |
static String |
PROP_STORE_REPLICATOR_INIT_WAIT_TIME
Property used to set the time the replicator will wait on open for the cluster to stabilize
Default Value: "5000"
|
static String |
PROP_STORE_REPLICATOR_INIT_WAIT_TIME_DEFAULT
Default value of the
PROP_STORE_REPLICATOR_INIT_WAIT_TIME property |
static String |
PROP_STORE_REPLICATOR_LINKPARAMS
Property used to set additional replication link parameters
|
static String |
PROP_STORE_REPLICATOR_LINKREADER_CPUAFFINITYMASK
Property used to set the CPU affinity mask of the network link reader
Default Value: "0"
|
static String |
PROP_STORE_REPLICATOR_LINKREADER_CPUAFFINITYMASK_DEFAULT
Default value of the
PROP_STORE_REPLICATOR_LINKREADER_CPUAFFINITYMASK property |
static String |
PROP_STORE_REPLICATOR_LOCALIFADDR
Property used to set the local network interface to bind to when establishing replication network connections.
|
static String |
PROP_STORE_REPLICATOR_LOCALPORT
Property used to set the local network port to bind to when listening for network connection requests from other
store members
Note: A value of 0 (the default value) is interpreted as a request to use a dynamic local port
|
static String |
PROP_STORE_REPLICATOR_LOCALPORT_DEFAULT
Default value of the
PROP_STORE_REPLICATOR_LOCALPORT property |
static String |
PROP_STORE_REPLICATOR_MEMBER_ELECTION_PRIORITY
Property used to determine which member will assume the primary role when members initially connect to one another.
|
static String |
PROP_STORE_REPLICATOR_MEMBER_ELECTION_PRIORITY_DEFAULT
Default value of the
PROP_STORE_REPLICATOR_MEMBER_ELECTION_PRIORITY property |
static String |
PROP_STORE_REPLICATOR_SENDER_CPUAFFINITYMASK
Property used to set the CPU affinity mask of the detached sender (only applies if detached send is enabled).
|
static String |
PROP_STORE_REPLICATOR_SENDER_QUEUEDEPTH
Property used to set the maximum queue depth of the detached sender (only applies if detached send is enabled)
Default Value: "1024"
|
static String |
PROP_STORE_REPLICATOR_SENDER_QUEUEDEPTH_DEFAULT
Default value of the
PROP_STORE_REPLICATOR_SENDER_QUEUEDEPTH property |
static String |
PROP_STORE_REPLICATOR_SENDER_QUEUEWAITSTRATEGY
Property used to set the queue wait strategy of the detached sender (only applies if detached send is enabled)
Default Value: The system will derive the replicator sender queue wait strategy if no wait strategy is
specified using this property
|
static String |
PROP_STORE_REPLICATOR_SUPPRESSDISCOVERYSHUTDOWNHOOK
Property used to indicate whether the replicator will suppress the shutdown hook installed by discovery
|
| Modifier and Type | Method and Description |
|---|---|
static StoreReplicatorDescriptor |
create(String name)
Create a default replicator descriptor.
|
void |
delete()
Delete a replicator descriptor from the default configuration repository.
|
void |
delete(IConfigRepository repo)
Delete a replicator descriptor from the configuration repository.
|
static boolean |
exists(IConfigRepository repo,
String name)
Checks if a replicator is configured in a configuration repository
|
static boolean |
exists(String name)
Checks if a replicator is configured in the default configuration repository
|
String |
getName()
Get the name of the replicator that this descriptor describes.
|
Properties |
getProperties()
Get the app properties
|
String |
getProperty(String name)
Get a replicator property.
|
String |
getProperty(String name,
String defVal)
Get a replicator property supplying a default value if not present.
|
static StoreReplicatorDescriptor |
load(IConfigRepository repo,
String name)
Create a replicator descriptor from a configuration respository.
|
static StoreReplicatorDescriptor |
load(String name)
Create a replicator descriptor from the default configuration respository.
|
static Set<StoreReplicatorDescriptor> |
loadAll()
Create replicator descriptors for all replicators configured in the default configuration
repository.
|
static Set<StoreReplicatorDescriptor> |
loadAll(IConfigRepository repo)
Create replicator descriptors for all replicators in a configuration repository.
|
void |
save()
Save a replicator descriptor to the default configuration repository.
|
void |
save(IConfigRepository repo)
Save a replicator descriptor to a configuration repository.
|
Properties |
save(Properties props)
Save a replicator descriptor to a property table.
|
StoreReplicatorDescriptor |
setProperties(Properties props)
Set a set of replicator properties.
|
StoreReplicatorDescriptor |
setProperty(String name,
String val)
Set a replicator property.
|
String |
toString()
Returns a string representation of this object
|
getChecked, getThreaded, getTracerpublic static final String PROP_STORE_NAME
public static final String PROP_STORE_REPLICATOR_LOCALIFADDR
public static final String PROP_STORE_REPLICATOR_LOCALPORT
Note: A value of 0 (the default value) is interpreted as a request to use a dynamic local port
public static final String PROP_STORE_REPLICATOR_LOCALPORT_DEFAULT
PROP_STORE_REPLICATOR_LOCALPORT propertypublic static final String PROP_STORE_REPLICATOR_LINKPARAMS
public static final String PROP_STORE_REPLICATOR_LINKREADER_CPUAFFINITYMASK
public static final String PROP_STORE_REPLICATOR_LINKREADER_CPUAFFINITYMASK_DEFAULT
PROP_STORE_REPLICATOR_LINKREADER_CPUAFFINITYMASK propertypublic static final String PROP_STORE_REPLICATOR_DISCOVERY_DESCRIPTOR
public static final String PROP_STORE_REPLICATOR_INIT_WAIT_TIME
public static final String PROP_STORE_REPLICATOR_INIT_WAIT_TIME_DEFAULT
PROP_STORE_REPLICATOR_INIT_WAIT_TIME propertypublic static final String PROP_STORE_REPLICATOR_INIT_WAIT_EXTENSION_UNIT
public static final String PROP_STORE_REPLICATOR_INIT_WAIT_EXTENSION_UNIT_DEFAULT
PROP_STORE_REPLICATOR_INIT_WAIT_EXTENSION_UNIT propertypublic static final String PROP_STORE_REPLICATOR_FAILONMULTIPLEPRIMARIES
public static final String PROP_STORE_REPLICATOR_FAILONMULTIPLEPRIMARIES_DEFAULT
PROP_STORE_REPLICATOR_FAILONMULTIPLEPRIMARIES propertypublic static final String PROP_STORE_REPLICATOR_SUPPRESSDISCOVERYSHUTDOWNHOOK
public static final String PROP_STORE_REPLICATOR_MEMBER_ELECTION_PRIORITY
Sets the leader election priority to determine which member will assume the primary role when members initially connect to one another, neither member is already operating in the primary role, and neither member is otherwise determined as a more suitable primary instance. The member with the lower election priority will assume the primary role. If two members have the same member election priority, then this property has no effect on determining which member will assume the primary role.
Default Value: "255"
public static final String PROP_STORE_REPLICATOR_MEMBER_ELECTION_PRIORITY_DEFAULT
PROP_STORE_REPLICATOR_MEMBER_ELECTION_PRIORITY propertypublic static final String PROP_STORE_REPLICATOR_DETACHED_SEND
public static final String PROP_STORE_REPLICATOR_DETACHED_SEND_DEFAULT
PROP_STORE_REPLICATOR_DETACHED_SEND propertypublic static final String PROP_STORE_REPLICATOR_SENDER_CPUAFFINITYMASK
public static final String PROP_STORE_REPLICATOR_SENDER_QUEUEDEPTH
public static final String PROP_STORE_REPLICATOR_SENDER_QUEUEDEPTH_DEFAULT
PROP_STORE_REPLICATOR_SENDER_QUEUEDEPTH propertypublic static final String PROP_STORE_REPLICATOR_SENDER_QUEUEWAITSTRATEGY
public static final String PROP_STORE_REPLICATOR_DETACHED_DISPATCH
public static final String PROP_STORE_REPLICATOR_DETACHED_DISPATCH_DEFAULT
PROP_STORE_REPLICATOR_DETACHED_DISPATCH propertypublic static final String PROP_STORE_REPLICATOR_DISPATCHER_CPUAFFINITYMASK
public static final String PROP_STORE_REPLICATOR_DISPATCHER_QUEUEDEPTH
public static final String PROP_STORE_REPLICATOR_DISPATCHER_QUEUEDEPTH_DEFAULT
PROP_STORE_REPLICATOR_DISPATCHER_QUEUEDEPTH propertypublic static final String PROP_STORE_REPLICATOR_DISPATCHER_QUEUEWAITSTRATEGY
public final String getName()
public final StoreReplicatorDescriptor setProperty(String name, String val)
public final String getProperty(String name)
public final String getProperty(String name, String defVal)
public final StoreReplicatorDescriptor setProperties(Properties props)
public final Properties getProperties()
public final Properties save(Properties props)
props - The property table.IllegalArgumentException - If the properties are nullpublic final void save(IConfigRepository repo) throws OdsException
repo - The root directory of the configuration respository.OdsException - Thrown in case an error in encountered during
the saving of the descriptor.This method saves a replicator descriptor to a configuration repository. The descriptor is saved in a format suitable for loading subsequently using any of the load methods offered by this class.
public final void save()
throws OdsException
OdsExceptionThis method saves a replicator descriptor to the default confiiguration respository. The descriptor is saved in a format suitable for loading subsequently using any of the load methods offered in this class.
public final void delete(IConfigRepository repo) throws OdsException
repo - The configuration respository to delete the descriptor from.OdsException - Thrown in case an error in encountered during the
deletion of the descriptor.This method deletes a replicator descriptor from a configuration repository.
public final void delete()
throws OdsException
OdsException - Thrown in case an error in encountered during the
deletion of the descriptor.This method permanently deletes a replicator descriptor from the default configuration repository.
public static StoreReplicatorDescriptor create(String name)
name - The name of the replicator whose descriptor is to be prepared.public static boolean exists(IConfigRepository repo, String name)
repo - The configuration respository to check in.name - The name of the replicator to check for.public static boolean exists(String name)
name - The name of the replicator to check for.public static StoreReplicatorDescriptor load(IConfigRepository repo, String name) throws OdsException
repo - The configuration repository from where to load the descriptor.name - The name of the replicator whose descriptor is to be prepared.OdsExceptionpublic static StoreReplicatorDescriptor load(String name) throws OdsException
name - The name of the replicator whose descriptor is to be prepared.OdsExceptionpublic static Set<StoreReplicatorDescriptor> loadAll(IConfigRepository repo) throws OdsException
repo - The configuration respository from where to create the replicators.This method creates and initializes replicator descriptors for each of the replicators configured in a configuration repository.
OdsExceptionpublic static Set<StoreReplicatorDescriptor> loadAll() throws OdsException
This method creates and initializes replicators descriptors for all the replicators configured in the default configuration repository.
OdsExceptionCopyright © 2019 N5 Technologies, Inc. All Rights Reserved.