ReconfigurationConfig.RC

java.lang.Object
- java.lang.Enum<ReconfigurationConfig.RC>
- - edu.umass.cs.reconfiguration.ReconfigurationConfig.RC

All Implemented Interfaces:

Config.ConfigurableEnum, Config.DefaultValueEnum, java.io.Serializable, java.lang.Comparable<ReconfigurationConfig.RC>

Enclosing class:

ReconfigurationConfig
```
public static enum ReconfigurationConfig.RC
extends java.lang.Enum<ReconfigurationConfig.RC>
implements Config.ConfigurableEnum
```
Reconfiguration config parameters.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AGGRESSIVE_DELETIONS` True if deletes are completed based on probing all actives.
`AGGRESSIVE_RECONFIGURATIONS` True if further reconfigurations can progress without waiting for the previous epoch final state to be dropped cleanly.
`ALLOW_APP_TYPES_ON_SERVER_PORT` True if app request types are allowed on the server port.
`ALLOW_CLIENT_TO_CREATE_DELETE` True means clients can create or delete names.
`APPLICATION`
`BROADCAST_NAME`
`CLIENT_PORT_OFFSET` The default offset added to the active replica or reconfigurator port number in order to get the client-facing port for client-facing request types (CREATE_SERVICE_NAME, DELETE_SERVICE_NAME, REQUEST_ACTIVE_REPLICAS at reconfigurators) and all app request types at active replicas.
`CLIENT_PORT_SSL_OFFSET`
`CLIENT_SSL_MODE` Default TLS authentication mode for client-server communication.
`CLOSEST_K` The closest K servers to a given client IP address.
`COMBINE_DEMAND_STATS` Whether most recent demand report should be combined with historic demand stats.
`COMMIT_WORKER_RESTART_PERIOD` Default retransmission timeout for coordinated requests in the reconfiguration protocol.
`COORDINATOR_WRAPPER` The name of the class used to wrap the application's default coordinator.
`DEFAULT_NAME_INITIAL_STATE` Value of initial state used by the default service name ( `ReconfigurationConfig.getDefaultServiceName()`).
`DEFAULT_NUM_REPLICAS` This parameter specifies the the number of active replicas for a name at upon creation of the name.
`DEMAND_PROFILE_TYPE` Demand profile class name.
`DISABLE_RECONFIGURATION` A flag to stop even all reporting.
`ENABLE_HTTP` Enable the HTTP server for reconfigurators.
`ENABLE_ID_TRANSFORM` True means that request IDs will be automatically transformed by `ReconfigurableAppClientAsync` if it receives two unequal requests with identical IDs.
`ENABLE_INSTRUMENTATION` True if delay profiling is enabled at various places.
`ENABLE_TRANSACTIONS` If true, transactions are enabled; else disabled.
`HTTP_PORT_OFFSET` HTTP server port offset relative to reconfigurator port.
`HTTP_PORT_SSL_OFFSET` HTTP server port offset relative to reconfigurator port.
`MAX_BATCH_SIZE`
`MAX_DEMAND_PROFILE_SIZE` Maximum string length of a demand profile message.
`ORIENT_CLIENT` If true, a client actively probes active replicas in order to determine which active replicas are closest to it.
`ORIENT_LIMIT` The maximum number of actives that will be sent to a client when it bootstraps to probe them in order to orient itself
`OUT_OF_ORDER_LIMIT` Used to set @link `PaxosManager.setOutOfOrderLimit(int)`.
`RECONFIGURATION_DB_DIR` Directory where reconfiguration DB is maintained when an embedded DB is used.
`RECONFIGURATION_DB_PREFIX` Prefix of the reconfiguration DB's name.
`RECONFIGURE_IN_PLACE` Whether reconfigurations should be performed even though AbstractDemandProfile returned a set of active replicas that are identical to the current one.
`REPLICATE_ALL` True means that a name upon creation will be replicated at all current active replicas; else it will be replicated at at most `DEFAULT_NUM_REPLICAS` randomly chosen active replicas.
`SEND_CLOSEST_TO_RECONFIGURATORS`
`SERVER_SSL_MODE` Default TLS authentication mode for server-server communication.
`SPECIAL_NAME` Requesting actives returns a random active replica for this name.
`SQL_TYPE` `SQL.SQLType` type.
`STAMP_SENDER_ADDRESS_JSON`
`STOP_TASK_RESTART_PERIOD` Default restart period for the stop epoch task.
`TEST_DEMAND_PROFILE` True means that the demand profile implementation is tested at bootstrap time to sanity check that its implementation meets the specification.
`TWO_PAXOS_RC` If true, reconfiguration consists of committing an intent and then a complete both via paxos.
`TX_GROUP_NAME`
`USE_DISK_MAP_RCDB`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getConfigFileKey()`
`java.lang.String`	`getDefaultConfigFile()`
`java.lang.Object`	`getDefaultValue()`
`static ReconfigurationConfig.RC`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static ReconfigurationConfig.RC[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - APPLICATION
```
public static final ReconfigurationConfig.RC APPLICATION
```
  - DEMAND_PROFILE_TYPE
```
public static final ReconfigurationConfig.RC DEMAND_PROFILE_TYPE
```
    Demand profile class name. iOS client requires that this name be specified as a string as opposed to using class.getName()
  - RECONFIGURATION_DB_DIR
```
public static final ReconfigurationConfig.RC RECONFIGURATION_DB_DIR
```
    Directory where reconfiguration DB is maintained when an embedded DB is used. Can not be changed via properties file.
  - RECONFIGURATION_DB_PREFIX
```
public static final ReconfigurationConfig.RC RECONFIGURATION_DB_PREFIX
```
    Prefix of the reconfiguration DB's name. The whole name is obtained as this prefix concatenated with the node ID.
  - SQL_TYPE
```
public static final ReconfigurationConfig.RC SQL_TYPE
```
    SQL.SQLType type. Currently, the only other alternative is "MYSQL". Note that this enum has the same name as PaxosConfig.PC.SQL_TYPE, so the two are currently forced to use the same DB type.
  - RECONFIGURE_IN_PLACE
```
public static final ReconfigurationConfig.RC RECONFIGURE_IN_PLACE
```
    Whether reconfigurations should be performed even though AbstractDemandProfile returned a set of active replicas that are identical to the current one. Useful for testing, but should be false in production.
  - CLIENT_SSL_MODE
```
public static final ReconfigurationConfig.RC CLIENT_SSL_MODE
```
    Default TLS authentication mode for client-server communication. Here, "client" means an end-client, not the (more general) initiator of communication. An end-client generally also is the initiator of communication, but the converse is not true. We generally want this to either be CLEAR or SERVER_AUTH, not MUTUAL_AUTH, as it is not generally meaningful for a server to authenticate an end-client for TLS purposes (as opposed to application-level authentication).
  - SERVER_SSL_MODE
```
public static final ReconfigurationConfig.RC SERVER_SSL_MODE
```
    Default TLS authentication mode for server-server communication. We generally want this to be MUTUAL_AUTH as both parties need to authenticate each other.
  - CLIENT_PORT_OFFSET
```
public static final ReconfigurationConfig.RC CLIENT_PORT_OFFSET
```
    The default offset added to the active replica or reconfigurator port number in order to get the client-facing port for client-facing request types (CREATE_SERVICE_NAME, DELETE_SERVICE_NAME, REQUEST_ACTIVE_REPLICAS at reconfigurators) and all app request types at active replicas. In general, we need the port for client-facing requests to be different because the TLS authentication mode for client-server and server-server communication may be different.
  - CLIENT_PORT_SSL_OFFSET
```
public static final ReconfigurationConfig.RC CLIENT_PORT_SSL_OFFSET
```
  - AGGRESSIVE_DELETIONS
```
public static final ReconfigurationConfig.RC AGGRESSIVE_DELETIONS
```
    True if deletes are completed based on probing all actives. Assumption for safety: Safe only if the set of actives does not change or is consistent across reconfigurators (not true by default). This option should only be false in production runs.
  - AGGRESSIVE_RECONFIGURATIONS
```
public static final ReconfigurationConfig.RC AGGRESSIVE_RECONFIGURATIONS
```
    True if further reconfigurations can progress without waiting for the previous epoch final state to be dropped cleanly.
  - COMMIT_WORKER_RESTART_PERIOD
```
public static final ReconfigurationConfig.RC COMMIT_WORKER_RESTART_PERIOD
```
    Default retransmission timeout for coordinated requests in the reconfiguration protocol.
  - STOP_TASK_RESTART_PERIOD
```
public static final ReconfigurationConfig.RC STOP_TASK_RESTART_PERIOD
```
    Default restart period for the stop epoch task. All other restart periods are multiples of this time.
  - MAX_DEMAND_PROFILE_SIZE
```
public static final ReconfigurationConfig.RC MAX_DEMAND_PROFILE_SIZE
```
    Maximum string length of a demand profile message.
  - COMBINE_DEMAND_STATS
```
public static final ReconfigurationConfig.RC COMBINE_DEMAND_STATS
```
    Whether most recent demand report should be combined with historic demand stats.
  - TWO_PAXOS_RC
```
public static final ReconfigurationConfig.RC TWO_PAXOS_RC
```
    If true, reconfiguration consists of committing an intent and then a complete both via paxos. If false, reconfiguration for non-RC-group names can proceed with just a single paxos round to commit an intent while using a simple broadcast for the complete. Avoiding the second paxos round is more efficient but has the downside that if the complete message for a name gets lost, some replicas may not be able to initiate further reconfigurations for the name. Using paxos does not guarantee liveness either, but its in-built mechanisms allowing laggard replicas to catch up combined with the CommitWorker mechanism to try to commit the complete until successful ensures that (1) the complete does indeed get eventually committed, and (2) all replicas apply *all* state changes in the same order. The latter property may not hold if TWO_PAXOS_RC is false but is not necessary for safety anyway. We don't allow RC group name or NODE_CONFIG changes to proceed with a single paxos round because reconfigurations can get stuck if a complete arrives a replica before the creation of the new paxos group. The inefficiency of two paxos rounds hardly matters given the high inherent overhead of RC group reconfigurations.
  - USE_DISK_MAP_RCDB
```
public static final ReconfigurationConfig.RC USE_DISK_MAP_RCDB
```
  - DEFAULT_NUM_REPLICAS
```
public static final ReconfigurationConfig.RC DEFAULT_NUM_REPLICAS
```
    This parameter specifies the the number of active replicas for a name at upon creation of the name. This parameter is irrelevant if REPLICATE_ALL is true and is irrelevant after name creation as the number of replicas thereafter is controlled by the reconfiguration policy.
  - REPLICATE_ALL
```
public static final ReconfigurationConfig.RC REPLICATE_ALL
```
    True means that a name upon creation will be replicated at all current active replicas; else it will be replicated at at most DEFAULT_NUM_REPLICAS randomly chosen active replicas. Note that this parameter is irrelevant after name creation as the number of replicas thereafter is controlled by the reconfiguration policy.
  - MAX_BATCH_SIZE
```
public static final ReconfigurationConfig.RC MAX_BATCH_SIZE
```
  - SPECIAL_NAME
```
public static final ReconfigurationConfig.RC SPECIAL_NAME
```
    Requesting actives returns a random active replica for this name.
  - ENABLE_INSTRUMENTATION
```
public static final ReconfigurationConfig.RC ENABLE_INSTRUMENTATION
```
    True if delay profiling is enabled at various places.
  - STAMP_SENDER_ADDRESS_JSON
```
public static final ReconfigurationConfig.RC STAMP_SENDER_ADDRESS_JSON
```
  - BROADCAST_NAME
```
public static final ReconfigurationConfig.RC BROADCAST_NAME
```
  - ORIENT_CLIENT
```
public static final ReconfigurationConfig.RC ORIENT_CLIENT
```
    If true, a client actively probes active replicas in order to determine which active replicas are closest to it.
  - ORIENT_LIMIT
```
public static final ReconfigurationConfig.RC ORIENT_LIMIT
```
    The maximum number of actives that will be sent to a client when it bootstraps to probe them in order to orient itself
  - CLOSEST_K
```
public static final ReconfigurationConfig.RC CLOSEST_K
```
    The closest K servers to a given client IP address.
  - SEND_CLOSEST_TO_RECONFIGURATORS
```
public static final ReconfigurationConfig.RC SEND_CLOSEST_TO_RECONFIGURATORS
```
  - DISABLE_RECONFIGURATION
```
public static final ReconfigurationConfig.RC DISABLE_RECONFIGURATION
```
    A flag to stop even all reporting.
  - ALLOW_CLIENT_TO_CREATE_DELETE
```
public static final ReconfigurationConfig.RC ALLOW_CLIENT_TO_CREATE_DELETE
```
    True means clients can create or delete names. False means only active replicas can create or delete names provided MUTUAL_AUTH is used between servers.
  - ALLOW_APP_TYPES_ON_SERVER_PORT
```
public static final ReconfigurationConfig.RC ALLOW_APP_TYPES_ON_SERVER_PORT
```
    True if app request types are allowed on the server port. False means that only app coordination request types will be allowed.
  - ENABLE_ID_TRANSFORM
```
public static final ReconfigurationConfig.RC ENABLE_ID_TRANSFORM
```
    True means that request IDs will be automatically transformed by ReconfigurableAppClientAsync if it receives two unequal requests with identical IDs.
  - TEST_DEMAND_PROFILE
```
public static final ReconfigurationConfig.RC TEST_DEMAND_PROFILE
```
    True means that the demand profile implementation is tested at bootstrap time to sanity check that its implementation meets the specification.
  - HTTP_PORT_OFFSET
```
public static final ReconfigurationConfig.RC HTTP_PORT_OFFSET
```
    HTTP server port offset relative to reconfigurator port.
  - HTTP_PORT_SSL_OFFSET
```
public static final ReconfigurationConfig.RC HTTP_PORT_SSL_OFFSET
```
    HTTP server port offset relative to reconfigurator port.
  - ENABLE_HTTP
```
public static final ReconfigurationConfig.RC ENABLE_HTTP
```
    Enable the HTTP server for reconfigurators.
  - ENABLE_TRANSACTIONS
```
public static final ReconfigurationConfig.RC ENABLE_TRANSACTIONS
```
    If true, transactions are enabled; else disabled.
  - COORDINATOR_WRAPPER
```
public static final ReconfigurationConfig.RC COORDINATOR_WRAPPER
```
    The name of the class used to wrap the application's default coordinator.
  - TX_GROUP_NAME
```
public static final ReconfigurationConfig.RC TX_GROUP_NAME
```
  - OUT_OF_ORDER_LIMIT
```
public static final ReconfigurationConfig.RC OUT_OF_ORDER_LIMIT
```
    Used to set @link PaxosManager.setOutOfOrderLimit(int).
  - DEFAULT_NAME_INITIAL_STATE
```
public static final ReconfigurationConfig.RC DEFAULT_NAME_INITIAL_STATE
```
    Value of initial state used by the default service name ( ReconfigurationConfig.getDefaultServiceName()).
- Method Detail
  - values
```
public static ReconfigurationConfig.RC[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ReconfigurationConfig.RC c : ReconfigurationConfig.RC.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ReconfigurationConfig.RC valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getDefaultValue
```
public java.lang.Object getDefaultValue()
```
    Specified by:
    
    getDefaultValue in interface Config.DefaultValueEnum
    
    Returns:
    
    Default value of this object.
  - getDefaultConfigFile
```
public java.lang.String getDefaultConfigFile()
```
    Specified by:
    
    getDefaultConfigFile in interface Config.ConfigurableEnum
    
    Returns:
    
    The default properties file for this enum.
  - getConfigFileKey
```
public java.lang.String getConfigFileKey()
```
    Specified by:
    
    getConfigFileKey in interface Config.ConfigurableEnum
    
    Returns:
    
    The JVM property key used to specify a non-default config file using -Dkey=/path/to/config/file.

Enum ReconfigurationConfig.RC

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

APPLICATION

DEMAND_PROFILE_TYPE

RECONFIGURATION_DB_DIR

RECONFIGURATION_DB_PREFIX

SQL_TYPE

RECONFIGURE_IN_PLACE

CLIENT_SSL_MODE

SERVER_SSL_MODE

CLIENT_PORT_OFFSET

CLIENT_PORT_SSL_OFFSET

AGGRESSIVE_DELETIONS

AGGRESSIVE_RECONFIGURATIONS

COMMIT_WORKER_RESTART_PERIOD

STOP_TASK_RESTART_PERIOD

MAX_DEMAND_PROFILE_SIZE

COMBINE_DEMAND_STATS

TWO_PAXOS_RC

USE_DISK_MAP_RCDB

DEFAULT_NUM_REPLICAS

REPLICATE_ALL

MAX_BATCH_SIZE

SPECIAL_NAME

ENABLE_INSTRUMENTATION

STAMP_SENDER_ADDRESS_JSON

BROADCAST_NAME

ORIENT_CLIENT

ORIENT_LIMIT

CLOSEST_K

SEND_CLOSEST_TO_RECONFIGURATORS

DISABLE_RECONFIGURATION

ALLOW_CLIENT_TO_CREATE_DELETE

ALLOW_APP_TYPES_ON_SERVER_PORT

ENABLE_ID_TRANSFORM

TEST_DEMAND_PROFILE

HTTP_PORT_OFFSET

HTTP_PORT_SSL_OFFSET

ENABLE_HTTP

ENABLE_TRANSACTIONS

COORDINATOR_WRAPPER

TX_GROUP_NAME

OUT_OF_ORDER_LIMIT

DEFAULT_NAME_INITIAL_STATE

Method Detail

values

valueOf

getDefaultValue

getDefaultConfigFile

getConfigFileKey