ServerContext (corfu 0.2.3-11006 API)

java.lang.Object
- org.corfudb.infrastructure.ServerContext

All Implemented Interfaces:

AutoCloseable
```
public class ServerContext
extends Object
implements AutoCloseable
```
Server Context:
- Contains the common node level DataStore
- Responsible for Server level EPOCH
- Should contain common services/utilities that the different Servers in a node require.
Note: It is created in CorfuServer and then passed to all the servers including NettyServerRouter.
Created by mdhawan on 8/5/16.

Field Summary

Fields
Modifier and Type Field and Description

static Duration SHUTDOWN_TIMER

static Duration SMALL_INTERVAL
various duration constants.

Fields
Modifier and Type	Field and Description
`static Duration`	`SHUTDOWN_TIMER`
`static Duration`	`SMALL_INTERVAL` various duration constants.

Constructor Summary

Constructors
Constructor and Description

ServerContext(Map<String,Object> serverConfig)
Returns a new ServerContext.

Constructors
Constructor and Description
`ServerContext(Map<String,Object> serverConfig)` Returns a new ServerContext.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`Layout`	`copyManagementLayout()` Fetches and creates a copy of the Management Layout from the local datastore.
`Layout`	`getCurrentLayout()` Get the current `Layout` stored in the `DataStore`.
`CorfuRuntime.CorfuRuntimeParameters`	`getDefaultRuntimeParameters()` Get an instance of `CorfuRuntime.CorfuRuntimeParameters` representing the default Corfu Runtime's parameters.
`FailureDetectorMetrics`	`getFailureDetectorMetrics()` Get latest change in a cluster state saved in data store.
`long`	`getLogUnitEpochWaterMark()` Fetches the epoch at which the last epochWaterMark operation was received.
`Layout`	`getManagementLayout()` Fetches the management layout from the persistent datastore.
`Layout`	`getNewSingleNodeLayout()` Get a new single node layout used for self-bootstrapping a server started with the -s flag.
`UUID`	`getNodeId()` Get the node id as an UUID.
`String`	`getNodeIdBase64()` Get the node id as a base64 string.
`Rank`	`getPhase1Rank()`
`org.corfudb.infrastructure.Phase2Data`	`getPhase2Data()`
`long`	`getSequencerEpoch()` Fetch the persisted sequencer epoch.
`<T> T`	`getServerConfig(Class<T> type, String optionName)` Get a field from the server configuration map.
`long`	`getServerEpoch()` The epoch of this router.
`List<AbstractServer>`	`getServers()` Get the list of servers registered in serverRouter
`String`	`getThreadPrefix()` Get the prefix for threads this server creates.
`boolean`	`installSingleNodeLayoutIfAbsent()` Install a single node layout if and only if no layout is currently installed.
`void`	`saveFailureDetectorMetrics(FailureDetectorMetrics detector)` Save detected failure in a history.
`void`	`saveManagementLayout(Layout layout)` Sets the management layout in the persistent datastore.
`void`	`setCurrentLayout(Layout layout)` Set the current `Layout` stored in the `DataStore`.
`void`	`setLayoutInHistory(Layout layout)`
`void`	`setLogUnitEpochWaterMark(long resetEpoch)` Sets the log unit epoch water mark.
`void`	`setPhase1Rank(Rank rank)`
`void`	`setPhase2Data(org.corfudb.infrastructure.Phase2Data phase2Data)`
`void`	`setSequencerEpoch(long sequencerEpoch)` Persists the sequencer epoch.
`void`	`setServerEpoch(long serverEpoch, IServerRouter r)` Set the serverRouter epoch.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SMALL_INTERVAL
```
public static final Duration SMALL_INTERVAL
```
    various duration constants.
  - SHUTDOWN_TIMER
```
public static final Duration SHUTDOWN_TIMER
```
- Constructor Detail
  - ServerContext
```
public ServerContext(Map<String,Object> serverConfig)
```
    Returns a new ServerContext.
    
    Parameters:
    
    serverConfig - map of configuration strings to objects
- Method Detail
  - getDefaultRuntimeParameters
```
public CorfuRuntime.CorfuRuntimeParameters getDefaultRuntimeParameters()
```
    Get an instance of CorfuRuntime.CorfuRuntimeParameters representing the default Corfu Runtime's parameters.
    
    Returns:
    
    an instance of CorfuRuntime.CorfuRuntimeParameters
  - getNodeId
```
public UUID getNodeId()
```
    Get the node id as an UUID.
    
    Returns:
    
    A UUID for this node.
  - getNodeIdBase64
```
public String getNodeIdBase64()
```
    Get the node id as a base64 string.
    
    Returns:
    
    A node ID for this node, as a base64 string.
  - getServerConfig
```
public <T> T getServerConfig(Class<T> type,
                             String optionName)
```
    Get a field from the server configuration map.
    
    Type Parameters:
    
    T - The type of the field to return.
    
    Parameters:
    
    type - The type of the field.
    
    optionName - The name of the option to retrieve.
    
    Returns:
    
    The field with the give option name.
  - installSingleNodeLayoutIfAbsent
```
public boolean installSingleNodeLayoutIfAbsent()
```
    Install a single node layout if and only if no layout is currently installed. Synchronized, so this method is thread-safe.
    
    Returns:
    
    True, if a new layout was installed, false otherwise.
  - getNewSingleNodeLayout
```
public Layout getNewSingleNodeLayout()
```
    Get a new single node layout used for self-bootstrapping a server started with the -s flag.
    
    Throws:
    
    IllegalArgumentException - If the cluster id was not auto, base64 or a UUID string
  - getCurrentLayout
```
public Layout getCurrentLayout()
```
    Get the current Layout stored in the DataStore.
    
    Returns:
    
    The current stored Layout
  - setCurrentLayout
```
public void setCurrentLayout(Layout layout)
```
    Set the current Layout stored in the DataStore.
    
    Parameters:
    
    layout - The Layout to set in the DataStore.
  - getServers
```
public List<AbstractServer> getServers()
```
    Get the list of servers registered in serverRouter
    
    Returns:
    
    A list of servers registered in serverRouter
  - getServerEpoch
```
public long getServerEpoch()
```
    The epoch of this router. This is managed by the base server implementation.
  - setServerEpoch
```
public void setServerEpoch(long serverEpoch,
                           IServerRouter r)
```
    Set the serverRouter epoch.
    
    Parameters:
    
    serverEpoch - the epoch to set
  - getPhase1Rank
```
public Rank getPhase1Rank()
```
  - setPhase1Rank
```
public void setPhase1Rank(Rank rank)
```
  - getPhase2Data
```
public org.corfudb.infrastructure.Phase2Data getPhase2Data()
```
  - setPhase2Data
```
public void setPhase2Data(org.corfudb.infrastructure.Phase2Data phase2Data)
```
  - setLayoutInHistory
```
public void setLayoutInHistory(Layout layout)
```
  - setSequencerEpoch
```
public void setSequencerEpoch(long sequencerEpoch)
```
    Persists the sequencer epoch. This is set only by the SequencerServer in the resetServer. No lock required as it relies on the resetServer lock.
    
    Parameters:
    
    sequencerEpoch - Epoch to persist.
  - getSequencerEpoch
```
public long getSequencerEpoch()
```
    Fetch the persisted sequencer epoch.
    
    Returns:
    
    Sequencer epoch.
  - saveManagementLayout
```
public void saveManagementLayout(Layout layout)
```
    Sets the management layout in the persistent datastore.
    
    Parameters:
    
    layout - Layout to be persisted
  - saveFailureDetectorMetrics
```
public void saveFailureDetectorMetrics(FailureDetectorMetrics detector)
```
    Save detected failure in a history. History represents all cluster state changes. Disabled by default.
    
    Parameters:
    
    detector - failure detector state
  - getFailureDetectorMetrics
```
public FailureDetectorMetrics getFailureDetectorMetrics()
```
    Get latest change in a cluster state saved in data store. Or provide default value if history is disabled.
    
    Returns:
    
    latest failure saved in the history
  - getManagementLayout
```
public Layout getManagementLayout()
```
    Fetches the management layout from the persistent datastore.
    
    Returns:
    
    The last persisted layout
  - setLogUnitEpochWaterMark
```
public void setLogUnitEpochWaterMark(long resetEpoch)
```
    Sets the log unit epoch water mark.
    
    Parameters:
    
    resetEpoch - Epoch at which the reset command was received.
  - getLogUnitEpochWaterMark
```
public long getLogUnitEpochWaterMark()
```
    Fetches the epoch at which the last epochWaterMark operation was received.
    
    Returns:
    
    Reset epoch.
  - copyManagementLayout
```
public Layout copyManagementLayout()
```
    Fetches and creates a copy of the Management Layout from the local datastore.
    
    Returns:
    
    Copy of the management layout from the datastore.
  - getThreadPrefix
```
@Nonnull
public String getThreadPrefix()
```
    Get the prefix for threads this server creates.
    
    Returns:
    
    A string that should be prepended to threads this server creates.
  - close
```
public void close()
```
    Cleans up and releases all resources (such as thread pools and files) opened by this ServerContext.
    
    Specified by:
    
    close in interface AutoCloseable

Class ServerContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SMALL_INTERVAL

SHUTDOWN_TIMER

Constructor Detail

ServerContext

Method Detail

getDefaultRuntimeParameters

getNodeId

getNodeIdBase64

getServerConfig

installSingleNodeLayoutIfAbsent

getNewSingleNodeLayout

getCurrentLayout

setCurrentLayout

getServers

getServerEpoch

setServerEpoch

getPhase1Rank

setPhase1Rank

getPhase2Data

setPhase2Data

setLayoutInHistory

setSequencerEpoch

getSequencerEpoch

saveManagementLayout

saveFailureDetectorMetrics

getFailureDetectorMetrics

getManagementLayout

setLogUnitEpochWaterMark

getLogUnitEpochWaterMark

copyManagementLayout

getThreadPrefix

close