ClusterBackup.Context (Aeron Message Transport)

java.lang.Object
- io.aeron.cluster.ClusterBackup.Context

All Implemented Interfaces:

Cloneable

Enclosing class:

ClusterBackup
```
public static class ClusterBackup.Context
extends Object
implements Cloneable
```
Context for overriding default configuration for ClusterBackup.

Constructor Summary

Constructors
Constructor and Description

Context()

Constructors
Constructor and Description
`Context()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Aeron`	`aeron()` `Aeron` client for communicating with the local Media Driver.
`ClusterBackup.Context`	`aeron(Aeron aeron)` `Aeron` client for communicating with the local Media Driver.
`String`	`aeronDirectoryName()` Get the top level Aeron directory used for communication between the Aeron client and Media Driver.
`ClusterBackup.Context`	`aeronDirectoryName(String aeronDirectoryName)` Set the top level Aeron directory used for communication between the Aeron client and Media Driver.
`AeronArchive.Context`	`archiveContext()` Get the `AeronArchive.Context` used for communicating with the local Archive.
`ClusterBackup.Context`	`archiveContext(AeronArchive.Context archiveContext)` Set the `AeronArchive.Context` used for communicating with the local Archive.
`String`	`catchupChannel()` Get the catchup channel template to use for log and snapshot retrieval.
`ClusterBackup.Context`	`catchupChannel(String catchupChannel)` Set the catchup channel template to use for log and snapshot retrieval.
`String`	`catchupEndpoint()` Get the catchup endpoint to use for log retrieval.
`ClusterBackup.Context`	`catchupEndpoint(String catchupEndpoint)` Set the endpoint that will be subscribed to in order to receive logs and snapshots.
`ClusterBackup.Context`	`clone()` Perform a shallow copy of the object.
`void`	`close()` Close the context and free applicable resources.
`AeronArchive.Context`	`clusterArchiveContext()` Get the `AeronArchive.Context` used for communicating with the remote Archive in the cluster being backed up.
`ClusterBackup.Context`	`clusterArchiveContext(AeronArchive.Context archiveContext)` Set the `AeronArchive.Context` used for communicating with the remote Archive in the cluster being backed up.
`long`	`clusterBackupCoolDownIntervalNs()` Interval at which the cluster backup is re-initialised after an exception has been thrown.
`ClusterBackup.Context`	`clusterBackupCoolDownIntervalNs(long clusterBackupCoolDownIntervalNs)` Interval at which the cluster backup is re-initialised after an exception has been thrown.
`long`	`clusterBackupIntervalNs()` Interval at which a cluster backup will send backup queries.
`ClusterBackup.Context`	`clusterBackupIntervalNs(long clusterBackupIntervalNs)` Interval at which a cluster backup will send backup queries.
`long`	`clusterBackupProgressTimeoutNs()` Timeout within which a cluster backup will expect progress.
`ClusterBackup.Context`	`clusterBackupProgressTimeoutNs(long clusterBackupProgressTimeoutNs)` Timeout within which a cluster backup will expect progress.
`long`	`clusterBackupResponseTimeoutNs()` Timeout within which a cluster backup will expect a response from a backup query.
`ClusterBackup.Context`	`clusterBackupResponseTimeoutNs(long clusterBackupResponseTimeoutNs)` Timeout within which a cluster backup will expect a response from a backup query.
`String`	`clusterConsensusEndpoints()` The endpoints representing cluster members of the cluster to attempt to a backup from.
`ClusterBackup.Context`	`clusterConsensusEndpoints(String endpoints)` String representing the cluster members consensus endpoints.
`File`	`clusterDir()` The directory used for the cluster directory.
`ClusterBackup.Context`	`clusterDir(File clusterDir)` Set the directory to use for the cluster directory.
`String`	`clusterDirectoryName()` The directory name to use for the cluster directory.
`ClusterBackup.Context`	`clusterDirectoryName(String clusterDirectoryName)` Set the directory name to use for the cluster directory.
`int`	`clusterId()` Get the id for this cluster instance.
`ClusterBackup.Context`	`clusterId(int clusterId)` Set the id for this cluster instance.
`ClusterMarkFile`	`clusterMarkFile()` The `ClusterMarkFile` in use.
`ClusterBackup.Context`	`clusterMarkFile(ClusterMarkFile markFile)` Set the `ClusterMarkFile` in use.
`void`	`conclude()` Conclude configuration by setting up defaults when specifics are not provided.
`String`	`consensusChannel()` Get the channel parameter for the consensus communication channel.
`ClusterBackup.Context`	`consensusChannel(String channel)` Set the channel parameter for the consensus communication channel.
`int`	`consensusModuleSnapshotStreamId()` Get the stream id for the consensus module snapshot replay channel.
`ClusterBackup.Context`	`consensusModuleSnapshotStreamId(int streamId)` Set the stream id for the consensus module snapshot replay.
`int`	`consensusStreamId()` Get the stream id for the consensus channel.
`ClusterBackup.Context`	`consensusStreamId(int streamId)` Set the stream id for the consensus channel.
`CountedErrorHandler`	`countedErrorHandler()` The `errorHandler()` that will increment `errorCounter()` by default.
`ClusterBackup.Context`	`countedErrorHandler(CountedErrorHandler countedErrorHandler)` Non-default for context.
`CredentialsSupplier`	`credentialsSupplier()` Get the `CredentialsSupplier` to be used for authentication with the cluster.
`ClusterBackup.Context`	`credentialsSupplier(CredentialsSupplier credentialsSupplier)` Set the `CredentialsSupplier` to be used for authentication with the cluster.
`void`	`deleteDirectory()` Delete the cluster directory.
`boolean`	`deleteDirOnStart()` Will the consensus module attempt to immediately delete `clusterDir()` on startup.
`ClusterBackup.Context`	`deleteDirOnStart(boolean deleteDirOnStart)` Should the consensus module attempt to immediately delete `clusterDir()` on startup.
`EpochClock`	`epochClock()` Get the `EpochClock` to used for tracking wall clock time.
`ClusterBackup.Context`	`epochClock(EpochClock clock)` Set the `EpochClock` to be used for tracking wall clock time.
`int`	`errorBufferLength()` The error buffer length in bytes.
`ClusterBackup.Context`	`errorBufferLength(int errorBufferLength)` Set the error buffer length in bytes to use.
`AtomicCounter`	`errorCounter()` Get the error counter that will record the number of errors observed.
`ClusterBackup.Context`	`errorCounter(AtomicCounter errorCounter)` Set the error counter that will record the number of errors observed.
`ErrorHandler`	`errorHandler()` Get the `ErrorHandler` to be used by the Consensus Module.
`ClusterBackup.Context`	`errorHandler(ErrorHandler errorHandler)` Set the `ErrorHandler` to be used by the Cluster Backup.
`DistinctErrorLog`	`errorLog()` The `DistinctErrorLog` in use.
`ClusterBackup.Context`	`errorLog(DistinctErrorLog errorLog)` Set the `DistinctErrorLog` in use.
`ClusterBackupEventsListener`	`eventsListener()` Get the `ClusterBackupEventsListener` in use for the backup agent.
`ClusterBackup.Context`	`eventsListener(ClusterBackupEventsListener eventsListener)` Set the `ClusterBackupEventsListener` to use for the backup agent.
`IdleStrategy`	`idleStrategy()` Get a new `IdleStrategy` based on configured supplier.
`ClusterBackup.Context`	`idleStrategySupplier(Supplier<IdleStrategy> idleStrategySupplier)` Provides an `IdleStrategy` supplier for the idle strategy for the agent duty cycle.
`Counter`	`liveLogPositionCounter()` Get the counter for the current position of the live log.
`ClusterBackup.Context`	`liveLogPositionCounter(Counter liveLogPositionCounter)` Set the counter for the current position of the live log.
`int`	`logStreamId()` Get the stream id for the cluster log channel.
`ClusterBackup.Context`	`logStreamId(int streamId)` Set the stream id for the cluster log channel.
`File`	`markFileDir()` Get the directory in which the ClusterBackup will store mark file (i.e.
`ClusterBackup.Context`	`markFileDir(File markFileDir)` Set the directory in which the ClusterBackup will store mark file (i.e.
`Counter`	`nextQueryDeadlineMsCounter()` Get the counter for the next query deadline ms.
`ClusterBackup.Context`	`nextQueryDeadlineMsCounter(Counter nextQueryDeadlineMsCounter)` Set the counter for the next query deadline ms.
`boolean`	`ownsAeronClient()` Does this context own the `aeron()` client and this takes responsibility for closing it?
`ClusterBackup.Context`	`ownsAeronClient(boolean ownsAeronClient)` Does this context own the `aeron()` client and this takes responsibility for closing it?
`long`	`replicationProgressIntervalNs()` Interval between checks for replication progress.
`ClusterBackup.Context`	`replicationProgressIntervalNs(long intervalNs)` Interval between checks for replication progress.
`long`	`replicationProgressTimeoutNs()` Timeout when no progress it detected when performing an archive replication (typically for snapshots).
`ClusterBackup.Context`	`replicationProgressTimeoutNs(long timeoutNs)` Timeout when no progress it detected when performing an archive replication (typically for snapshots).
`int`	`serviceSnapshotStreamId()` Get the stream id for the clustered service snapshot replay channel.
`ClusterBackup.Context`	`serviceSnapshotStreamId(int streamId)` Set the stream id for the clustered service snapshot replay.
`ShutdownSignalBarrier`	`shutdownSignalBarrier()` Get the `ShutdownSignalBarrier` that can be used to shut down.
`ClusterBackup.Context`	`shutdownSignalBarrier(ShutdownSignalBarrier barrier)` Set the `ShutdownSignalBarrier` that can be used to shut down a consensus module.
`ClusterBackup.SourceType`	`sourceType()` Get the currently configured source type
`ClusterBackup.Context`	`sourceType(ClusterBackup.SourceType sourceType)` Set the `ClusterBackup.SourceType` to be used for this backup instance.
`Counter`	`stateCounter()` Get the counter for the current state of the cluster backup.
`ClusterBackup.Context`	`stateCounter(Counter stateCounter)` Set the counter for the current state of the cluster backup.
`Runnable`	`terminationHook()` Get the `Runnable` that is called when the `ClusterBackup` processes a termination action.
`ClusterBackup.Context`	`terminationHook(Runnable terminationHook)` Set the `Runnable` that is called when the `ClusterBackup` processes a termination action.
`ThreadFactory`	`threadFactory()` Get the thread factory used for creating threads.
`ClusterBackup.Context`	`threadFactory(ThreadFactory threadFactory)` Set the thread factory used for creating threads.
`String`	`toString()`
`boolean`	`useAgentInvoker()` Should an `AgentInvoker` be used for running the `ClusterBackup` rather than run it on a thread with a `AgentRunner`.
`ClusterBackup.Context`	`useAgentInvoker(boolean useAgentInvoker)` Should an `AgentInvoker` be used for running the `ClusterBackup` rather than run it on a thread with a `AgentRunner`.

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

- Constructor Detail
  - Context
```
public Context()
```
- Method Detail
  - clone
```
public ClusterBackup.Context clone()
```
    Perform a shallow copy of the object.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a shallow copy of the object.
  - conclude
```
public void conclude()
```
    Conclude configuration by setting up defaults when specifics are not provided.
  - aeron
```
public ClusterBackup.Context aeron(Aeron aeron)
```
    Aeron client for communicating with the local Media Driver.
    This client will be closed when the ClusterBackup.close() or close() methods are called if ownsAeronClient() is true.
    
    Parameters:
    
    aeron - client for communicating with the local Media Driver.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    Aeron.connect()
  - aeron
```
public Aeron aeron()
```
    Aeron client for communicating with the local Media Driver.
    If not provided then a default will be established during conclude() by calling Aeron.connect().
    
    Returns:
    
    client for communicating with the local Media Driver.
  - aeronDirectoryName
```
public ClusterBackup.Context aeronDirectoryName(String aeronDirectoryName)
```
    Set the top level Aeron directory used for communication between the Aeron client and Media Driver.
    
    Parameters:
    
    aeronDirectoryName - the top level Aeron directory.
    
    Returns:
    
    this for a fluent API.
  - aeronDirectoryName
```
public String aeronDirectoryName()
```
    Get the top level Aeron directory used for communication between the Aeron client and Media Driver.
    
    Returns:
    
    The top level Aeron directory.
  - ownsAeronClient
```
public ClusterBackup.Context ownsAeronClient(boolean ownsAeronClient)
```
    Does this context own the aeron() client and this takes responsibility for closing it?
    
    Parameters:
    
    ownsAeronClient - does this context own the aeron() client.
    
    Returns:
    
    this for a fluent API.
  - ownsAeronClient
```
public boolean ownsAeronClient()
```
    Does this context own the aeron() client and this takes responsibility for closing it?
    
    Returns:
    
    does this context own the aeron() client and this takes responsibility for closing it?
  - deleteDirOnStart
```
public ClusterBackup.Context deleteDirOnStart(boolean deleteDirOnStart)
```
    Should the consensus module attempt to immediately delete clusterDir() on startup.
    
    Parameters:
    
    deleteDirOnStart - Attempt deletion.
    
    Returns:
    
    this for a fluent API.
  - deleteDirOnStart
```
public boolean deleteDirOnStart()
```
    Will the consensus module attempt to immediately delete clusterDir() on startup.
    
    Returns:
    
    true when directory will be deleted, otherwise false.
  - clusterId
```
public ClusterBackup.Context clusterId(int clusterId)
```
    Set the id for this cluster instance.
    
    Parameters:
    
    clusterId - for this clustered instance.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CLUSTER_ID_PROP_NAME
  - clusterId
```
public int clusterId()
```
    Get the id for this cluster instance.
    
    Returns:
    
    the id for this cluster instance.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CLUSTER_ID_PROP_NAME
  - clusterDirectoryName
```
public ClusterBackup.Context clusterDirectoryName(String clusterDirectoryName)
```
    Set the directory name to use for the cluster directory.
    
    Parameters:
    
    clusterDirectoryName - to use.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CLUSTER_DIR_PROP_NAME
  - clusterDirectoryName
```
public String clusterDirectoryName()
```
    The directory name to use for the cluster directory.
    
    Returns:
    
    directory name for the cluster directory.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CLUSTER_DIR_PROP_NAME
  - clusterDir
```
public ClusterBackup.Context clusterDir(File clusterDir)
```
    Set the directory to use for the cluster directory.
    
    Parameters:
    
    clusterDir - to use.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CLUSTER_DIR_PROP_NAME
  - clusterDir
```
public File clusterDir()
```
    The directory used for the cluster directory.
    
    Returns:
    
    directory for the cluster directory.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CLUSTER_DIR_PROP_NAME
  - markFileDir
```
public File markFileDir()
```
    Get the directory in which the ClusterBackup will store mark file (i.e. cluster-mark.dat). It defaults to clusterDir() if it is not set explicitly via the ClusteredServiceContainer.Configuration.MARK_FILE_DIR_PROP_NAME.
    
    Returns:
    
    the directory in which the ClusterBackup will store mark file (i.e. cluster-mark.dat).
    
    See Also:
    
    ClusteredServiceContainer.Configuration.MARK_FILE_DIR_PROP_NAME, clusterDir()
  - markFileDir
```
public ClusterBackup.Context markFileDir(File markFileDir)
```
    Set the directory in which the ClusterBackup will store mark file (i.e. cluster-mark.dat).
    
    Parameters:
    
    markFileDir - the directory in which the ClusterBackup will store mark file (i.e. cluster-mark.dat).
    
    Returns:
    
    this for a fluent API.
  - archiveContext
```
public ClusterBackup.Context archiveContext(AeronArchive.Context archiveContext)
```
    Set the AeronArchive.Context used for communicating with the local Archive.
    
    Parameters:
    
    archiveContext - used for communicating with the local Archive.
    
    Returns:
    
    this for a fluent API.
  - archiveContext
```
public AeronArchive.Context archiveContext()
```
    Get the AeronArchive.Context used for communicating with the local Archive.
    
    Returns:
    
    the AeronArchive.Context used for communicating with the local Archive.
  - clusterArchiveContext
```
public ClusterBackup.Context clusterArchiveContext(AeronArchive.Context archiveContext)
```
    Set the AeronArchive.Context used for communicating with the remote Archive in the cluster being backed up.
    
    Parameters:
    
    archiveContext - used for communicating with the remote Archive in the cluster being backed up.
    
    Returns:
    
    this for a fluent API.
  - clusterArchiveContext
```
public AeronArchive.Context clusterArchiveContext()
```
    Get the AeronArchive.Context used for communicating with the remote Archive in the cluster being backed up.
    
    Returns:
    
    the AeronArchive.Context used for communicating the remote Archive in the cluster being backed up.
  - threadFactory
```
public ThreadFactory threadFactory()
```
    Get the thread factory used for creating threads.
    
    Returns:
    
    thread factory used for creating threads.
  - threadFactory
```
public ClusterBackup.Context threadFactory(ThreadFactory threadFactory)
```
    Set the thread factory used for creating threads.
    
    Parameters:
    
    threadFactory - used for creating threads
    
    Returns:
    
    this for a fluent API.
  - idleStrategySupplier
```
public ClusterBackup.Context idleStrategySupplier(Supplier<IdleStrategy> idleStrategySupplier)
```
    Provides an IdleStrategy supplier for the idle strategy for the agent duty cycle.
    
    Parameters:
    
    idleStrategySupplier - supplier for the idle strategy for the agent duty cycle.
    
    Returns:
    
    this for a fluent API.
  - idleStrategy
```
public IdleStrategy idleStrategy()
```
    Get a new IdleStrategy based on configured supplier.
    
    Returns:
    
    a new IdleStrategy based on configured supplier.
  - epochClock
```
public ClusterBackup.Context epochClock(EpochClock clock)
```
    Set the EpochClock to be used for tracking wall clock time.
    
    Parameters:
    
    clock - EpochClock to be used for tracking wall clock time.
    
    Returns:
    
    this for a fluent API.
  - epochClock
```
public EpochClock epochClock()
```
    Get the EpochClock to used for tracking wall clock time.
    
    Returns:
    
    the EpochClock to used for tracking wall clock time.
  - errorHandler
```
public ErrorHandler errorHandler()
```
    Get the ErrorHandler to be used by the Consensus Module.
    
    Returns:
    
    the ErrorHandler to be used by the Consensus Module.
  - errorHandler
```
public ClusterBackup.Context errorHandler(ErrorHandler errorHandler)
```
    Set the ErrorHandler to be used by the Cluster Backup.
    
    Parameters:
    
    errorHandler - the error handler to be used by the Cluster Backup.
    
    Returns:
    
    this for a fluent API
  - errorCounter
```
public AtomicCounter errorCounter()
```
    Get the error counter that will record the number of errors observed.
    
    Returns:
    
    the error counter that will record the number of errors observed.
  - errorCounter
```
public ClusterBackup.Context errorCounter(AtomicCounter errorCounter)
```
    Set the error counter that will record the number of errors observed.
    
    Parameters:
    
    errorCounter - the error counter that will record the number of errors observed.
    
    Returns:
    
    this for a fluent API.
  - countedErrorHandler
```
public ClusterBackup.Context countedErrorHandler(CountedErrorHandler countedErrorHandler)
```
    Non-default for context.
    
    Parameters:
    
    countedErrorHandler - to override the default.
    
    Returns:
    
    this for a fluent API.
  - countedErrorHandler
```
public CountedErrorHandler countedErrorHandler()
```
    The errorHandler() that will increment errorCounter() by default.
    
    Returns:
    
    errorHandler() that will increment errorCounter() by default.
  - consensusChannel
```
public ClusterBackup.Context consensusChannel(String channel)
```
    Set the channel parameter for the consensus communication channel.
    
    Parameters:
    
    channel - parameter for the consensus communication channel.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.CONSENSUS_CHANNEL_PROP_NAME
  - consensusChannel
```
public String consensusChannel()
```
    Get the channel parameter for the consensus communication channel.
    
    Returns:
    
    the channel parameter for the consensus communication channel.
    
    See Also:
    
    ConsensusModule.Configuration.CONSENSUS_CHANNEL_PROP_NAME
  - consensusStreamId
```
public ClusterBackup.Context consensusStreamId(int streamId)
```
    Set the stream id for the consensus channel.
    
    Parameters:
    
    streamId - for the consensus channel.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ConsensusModule.Configuration.CONSENSUS_STREAM_ID_PROP_NAME
  - consensusStreamId
```
public int consensusStreamId()
```
    Get the stream id for the consensus channel.
    
    Returns:
    
    the stream id for the consensus channel.
    
    See Also:
    
    ConsensusModule.Configuration.CONSENSUS_STREAM_ID_PROP_NAME
  - consensusModuleSnapshotStreamId
```
public ClusterBackup.Context consensusModuleSnapshotStreamId(int streamId)
```
    Set the stream id for the consensus module snapshot replay.
    
    Parameters:
    
    streamId - for the consensus module snapshot replay channel.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ConsensusModule.Context.snapshotStreamId()
  - consensusModuleSnapshotStreamId
```
public int consensusModuleSnapshotStreamId()
```
    Get the stream id for the consensus module snapshot replay channel.
    
    Returns:
    
    the stream id for the consensus module snapshot replay channel.
    
    See Also:
    
    ConsensusModule.Context.snapshotStreamId()
  - serviceSnapshotStreamId
```
public ClusterBackup.Context serviceSnapshotStreamId(int streamId)
```
    Set the stream id for the clustered service snapshot replay.
    
    Parameters:
    
    streamId - for the clustered service snapshot replay channel.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ClusteredServiceContainer.Context.snapshotStreamId()
  - serviceSnapshotStreamId
```
public int serviceSnapshotStreamId()
```
    Get the stream id for the clustered service snapshot replay channel.
    
    Returns:
    
    the stream id for the clustered service snapshot replay channel.
    
    See Also:
    
    ClusteredServiceContainer.Context.snapshotStreamId()
  - logStreamId
```
public ClusterBackup.Context logStreamId(int streamId)
```
    Set the stream id for the cluster log channel.
    
    Parameters:
    
    streamId - for the cluster log channel.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ConsensusModule.Configuration.LOG_STREAM_ID_PROP_NAME
  - logStreamId
```
public int logStreamId()
```
    Get the stream id for the cluster log channel.
    
    Returns:
    
    the stream id for the cluster log channel.
    
    See Also:
    
    ConsensusModule.Configuration.LOG_STREAM_ID_PROP_NAME
  - catchupEndpoint
```
public ClusterBackup.Context catchupEndpoint(String catchupEndpoint)
```
    Set the endpoint that will be subscribed to in order to receive logs and snapshots.
    
    Parameters:
    
    catchupEndpoint - to use for the log retrieval.
    
    Returns:
    
    catchup endpoint to use for the log retrieval.
    
    See Also:
    
    ClusterBackup.Configuration.catchupEndpoint()
  - catchupEndpoint
```
public String catchupEndpoint()
```
    Get the catchup endpoint to use for log retrieval.
    
    Returns:
    
    catchup endpoint to use for the log retrieval.
    
    See Also:
    
    ClusterBackup.Configuration.catchupEndpoint()
  - catchupChannel
```
public ClusterBackup.Context catchupChannel(String catchupChannel)
```
    Set the catchup channel template to use for log and snapshot retrieval.
    
    Parameters:
    
    catchupChannel - to use for the log and snapshot retrieval.
    
    Returns:
    
    catchup endpoint to use for the log and snapshot retrieval.
    
    See Also:
    
    ClusterBackup.Configuration.CLUSTER_BACKUP_CATCHUP_CHANNEL_PROP_NAME
  - catchupChannel
```
public String catchupChannel()
```
    Get the catchup channel template to use for log and snapshot retrieval.
    
    Returns:
    
    catchup endpoint to use for the log and snapshot retrieval.
    
    See Also:
    
    ClusterBackup.Configuration.CLUSTER_BACKUP_CATCHUP_CHANNEL_PROP_NAME
  - clusterBackupIntervalNs
```
public ClusterBackup.Context clusterBackupIntervalNs(long clusterBackupIntervalNs)
```
    Interval at which a cluster backup will send backup queries.
    
    Parameters:
    
    clusterBackupIntervalNs - between add cluster members and snapshot recording queries.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ClusterBackup.Configuration.CLUSTER_BACKUP_INTERVAL_PROP_NAME, ClusterBackup.Configuration.CLUSTER_BACKUP_INTERVAL_DEFAULT_NS
  - clusterBackupIntervalNs
```
public long clusterBackupIntervalNs()
```
    Interval at which a cluster backup will send backup queries.
    
    Returns:
    
    the interval at which a cluster backup will send backup queries.
    
    See Also:
    
    ClusterBackup.Configuration.CLUSTER_BACKUP_INTERVAL_PROP_NAME, ClusterBackup.Configuration.CLUSTER_BACKUP_INTERVAL_DEFAULT_NS
  - clusterBackupResponseTimeoutNs
```
public ClusterBackup.Context clusterBackupResponseTimeoutNs(long clusterBackupResponseTimeoutNs)
```
    Timeout within which a cluster backup will expect a response from a backup query.
    
    Parameters:
    
    clusterBackupResponseTimeoutNs - within which a cluster backup will expect a response.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ClusterBackup.Configuration.CLUSTER_BACKUP_RESPONSE_TIMEOUT_PROP_NAME, ClusterBackup.Configuration.CLUSTER_BACKUP_RESPONSE_TIMEOUT_DEFAULT_NS
  - clusterBackupResponseTimeoutNs
```
public long clusterBackupResponseTimeoutNs()
```
    Timeout within which a cluster backup will expect a response from a backup query.
    
    Returns:
    
    timeout within which a cluster backup will expect a response from a backup query.
    
    See Also:
    
    ClusterBackup.Configuration.CLUSTER_BACKUP_RESPONSE_TIMEOUT_PROP_NAME, ClusterBackup.Configuration.CLUSTER_BACKUP_RESPONSE_TIMEOUT_DEFAULT_NS
  - clusterBackupProgressTimeoutNs
```
public ClusterBackup.Context clusterBackupProgressTimeoutNs(long clusterBackupProgressTimeoutNs)
```
    Timeout within which a cluster backup will expect progress.
    
    Parameters:
    
    clusterBackupProgressTimeoutNs - within which a cluster backup will expect a response.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ClusterBackup.Configuration.CLUSTER_BACKUP_PROGRESS_TIMEOUT_PROP_NAME, ClusterBackup.Configuration.CLUSTER_BACKUP_PROGRESS_TIMEOUT_DEFAULT_NS
  - clusterBackupProgressTimeoutNs
```
public long clusterBackupProgressTimeoutNs()
```
    Timeout within which a cluster backup will expect progress.
    
    Returns:
    
    timeout within which a cluster backup will expect progress.
    
    See Also:
    
    ClusterBackup.Configuration.CLUSTER_BACKUP_PROGRESS_TIMEOUT_PROP_NAME, ClusterBackup.Configuration.CLUSTER_BACKUP_PROGRESS_TIMEOUT_DEFAULT_NS
  - clusterBackupCoolDownIntervalNs
```
public ClusterBackup.Context clusterBackupCoolDownIntervalNs(long clusterBackupCoolDownIntervalNs)
```
    Interval at which the cluster backup is re-initialised after an exception has been thrown.
    
    Parameters:
    
    clusterBackupCoolDownIntervalNs - time before the cluster backup is re-initialised.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ClusterBackup.Configuration.CLUSTER_BACKUP_COOL_DOWN_INTERVAL_PROP_NAME, ClusterBackup.Configuration.CLUSTER_BACKUP_COOL_DOWN_INTERVAL_DEFAULT_NS
  - clusterBackupCoolDownIntervalNs
```
public long clusterBackupCoolDownIntervalNs()
```
    Interval at which the cluster backup is re-initialised after an exception has been thrown.
    
    Returns:
    
    interval at which the cluster backup is re-initialised after an exception has been thrown.
    
    See Also:
    
    ClusterBackup.Configuration.CLUSTER_BACKUP_COOL_DOWN_INTERVAL_PROP_NAME, ClusterBackup.Configuration.CLUSTER_BACKUP_COOL_DOWN_INTERVAL_DEFAULT_NS
  - clusterConsensusEndpoints
```
public ClusterBackup.Context clusterConsensusEndpoints(String endpoints)
```
    String representing the cluster members consensus endpoints.
    "endpoint,endpoint,endpoint"
    
    Parameters:
    
    endpoints - which are to be contacted for joining the cluster.
    
    Returns:
    
    this for a fluent API.
  - clusterConsensusEndpoints
```
public String clusterConsensusEndpoints()
```
    The endpoints representing cluster members of the cluster to attempt to a backup from.
    
    Returns:
    
    members of the cluster to attempt to request a backup from.
  - shutdownSignalBarrier
```
public ClusterBackup.Context shutdownSignalBarrier(ShutdownSignalBarrier barrier)
```
    Set the ShutdownSignalBarrier that can be used to shut down a consensus module.
    
    Parameters:
    
    barrier - that can be used to shut down a consensus module.
    
    Returns:
    
    this for a fluent API.
  - shutdownSignalBarrier
```
public ShutdownSignalBarrier shutdownSignalBarrier()
```
    Get the ShutdownSignalBarrier that can be used to shut down.
    
    Returns:
    
    the ShutdownSignalBarrier that can be used to shut down.
  - terminationHook
```
public ClusterBackup.Context terminationHook(Runnable terminationHook)
```
    Set the Runnable that is called when the ClusterBackup processes a termination action.
    
    Parameters:
    
    terminationHook - that can be used to terminate.
    
    Returns:
    
    this for a fluent API.
  - terminationHook
```
public Runnable terminationHook()
```
    Get the Runnable that is called when the ClusterBackup processes a termination action.
    The default action is to call signal on the shutdownSignalBarrier().
    
    Returns:
    
    the Runnable that can be used to terminate.
  - clusterMarkFile
```
public ClusterBackup.Context clusterMarkFile(ClusterMarkFile markFile)
```
    Set the ClusterMarkFile in use.
    
    Parameters:
    
    markFile - to use.
    
    Returns:
    
    this for a fluent API.
  - clusterMarkFile
```
public ClusterMarkFile clusterMarkFile()
```
    The ClusterMarkFile in use.
    
    Returns:
    
    ClusterMarkFile in use.
  - errorBufferLength
```
public ClusterBackup.Context errorBufferLength(int errorBufferLength)
```
    Set the error buffer length in bytes to use.
    
    Parameters:
    
    errorBufferLength - in bytes to use.
    
    Returns:
    
    this for a fluent API.
  - errorBufferLength
```
public int errorBufferLength()
```
    The error buffer length in bytes.
    
    Returns:
    
    error buffer length in bytes.
  - errorLog
```
public ClusterBackup.Context errorLog(DistinctErrorLog errorLog)
```
    Set the DistinctErrorLog in use.
    
    Parameters:
    
    errorLog - to use.
    
    Returns:
    
    this for a fluent API.
  - errorLog
```
public DistinctErrorLog errorLog()
```
    The DistinctErrorLog in use.
    
    Returns:
    
    DistinctErrorLog in use.
  - stateCounter
```
public Counter stateCounter()
```
    Get the counter for the current state of the cluster backup.
    
    Returns:
    
    the counter for the current state of the cluster backup.
    
    See Also:
    
    ClusterBackup.State
  - stateCounter
```
public ClusterBackup.Context stateCounter(Counter stateCounter)
```
    Set the counter for the current state of the cluster backup.
    
    Parameters:
    
    stateCounter - the counter for the current state of the cluster backup.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ClusterBackup.State
  - liveLogPositionCounter
```
public Counter liveLogPositionCounter()
```
    Get the counter for the current position of the live log.
    
    Returns:
    
    the counter for the current position of the live log.
  - liveLogPositionCounter
```
public ClusterBackup.Context liveLogPositionCounter(Counter liveLogPositionCounter)
```
    Set the counter for the current position of the live log.
    
    Parameters:
    
    liveLogPositionCounter - the counter for the current position of the live log.
    
    Returns:
    
    this for a fluent API.
  - nextQueryDeadlineMsCounter
```
public Counter nextQueryDeadlineMsCounter()
```
    Get the counter for the next query deadline ms.
    
    Returns:
    
    the counter for the next query deadline ms.
  - nextQueryDeadlineMsCounter
```
public ClusterBackup.Context nextQueryDeadlineMsCounter(Counter nextQueryDeadlineMsCounter)
```
    Set the counter for the next query deadline ms.
    
    Parameters:
    
    nextQueryDeadlineMsCounter - the counter for the next query deadline ms.
    
    Returns:
    
    this for a fluent API.
  - eventsListener
```
public ClusterBackupEventsListener eventsListener()
```
    Get the ClusterBackupEventsListener in use for the backup agent.
    
    Returns:
    
    ClusterBackupEventsListener in use for the backup agent.
    
    See Also:
    
    ClusterBackupEventsListener
  - eventsListener
```
public ClusterBackup.Context eventsListener(ClusterBackupEventsListener eventsListener)
```
    Set the ClusterBackupEventsListener to use for the backup agent.
    
    Parameters:
    
    eventsListener - to use for the backup agent.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ClusterBackupEventsListener
  - useAgentInvoker
```
public ClusterBackup.Context useAgentInvoker(boolean useAgentInvoker)
```
    Should an AgentInvoker be used for running the ClusterBackup rather than run it on a thread with a AgentRunner.
    
    Parameters:
    
    useAgentInvoker - use AgentInvoker be used for running the ClusterBackup?
    
    Returns:
    
    this for a fluent API.
  - useAgentInvoker
```
public boolean useAgentInvoker()
```
    Should an AgentInvoker be used for running the ClusterBackup rather than run it on a thread with a AgentRunner.
    
    Returns:
    
    true if the ClusterBackup will be run with an AgentInvoker otherwise false.
  - credentialsSupplier
```
public ClusterBackup.Context credentialsSupplier(CredentialsSupplier credentialsSupplier)
```
    Set the CredentialsSupplier to be used for authentication with the cluster.
    
    Parameters:
    
    credentialsSupplier - to be used for authentication with the cluster.
    
    Returns:
    
    this for fluent API.
  - credentialsSupplier
```
public CredentialsSupplier credentialsSupplier()
```
    Get the CredentialsSupplier to be used for authentication with the cluster.
    
    Returns:
    
    the CredentialsSupplier to be used for authentication with the cluster.
  - sourceType
```
public ClusterBackup.Context sourceType(ClusterBackup.SourceType sourceType)
```
    Set the ClusterBackup.SourceType to be used for this backup instance.
    
    Parameters:
    
    sourceType - type of sources to receive log traffic from.
    
    Returns:
    
    this for a fluent API
  - sourceType
```
public ClusterBackup.SourceType sourceType()
```
    Get the currently configured source type
    
    Returns:
    
    source type for this backup instance.
    
    Throws:
    
    IllegalArgumentException - if the configured source type is not one of ClusterBackup.SourceType
  - replicationProgressTimeoutNs
```
public ClusterBackup.Context replicationProgressTimeoutNs(long timeoutNs)
```
    Timeout when no progress it detected when performing an archive replication (typically for snapshots).
    
    Parameters:
    
    timeoutNs - timeout in nanoseconds
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.replicationProgressTimeoutNs()
  - replicationProgressTimeoutNs
```
public long replicationProgressTimeoutNs()
```
    Timeout when no progress it detected when performing an archive replication (typically for snapshots).
    
    Returns:
    
    timeout in nanoseconds.
    
    See Also:
    
    ConsensusModule.Configuration.replicationProgressTimeoutNs()
  - replicationProgressIntervalNs
```
public ClusterBackup.Context replicationProgressIntervalNs(long intervalNs)
```
    Interval between checks for replication progress. Defaults to replicationProgressTimeoutNs() divided by 10.
    
    Parameters:
    
    intervalNs - timeout in nanoseconds
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.replicationProgressIntervalNs()
  - replicationProgressIntervalNs
```
public long replicationProgressIntervalNs()
```
    Interval between checks for replication progress.
    
    Returns:
    
    timeout in nanoseconds.
    
    See Also:
    
    ConsensusModule.Configuration.replicationProgressIntervalNs()
  - deleteDirectory
```
public void deleteDirectory()
```
    Delete the cluster directory.
  - close
```
public void close()
```
    Close the context and free applicable resources.
    If ownsAeronClient() is true then the aeron() client will be closed.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ClusterBackup.Context

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Context

Method Detail

clone

conclude

aeron

aeron

aeronDirectoryName

aeronDirectoryName

ownsAeronClient

ownsAeronClient

deleteDirOnStart

deleteDirOnStart

clusterId

clusterId

clusterDirectoryName

clusterDirectoryName

clusterDir

clusterDir

markFileDir

markFileDir

archiveContext

archiveContext

clusterArchiveContext

clusterArchiveContext

threadFactory

threadFactory

idleStrategySupplier

idleStrategy

epochClock

epochClock

errorHandler

errorHandler

errorCounter

errorCounter

countedErrorHandler

countedErrorHandler

consensusChannel

consensusChannel

consensusStreamId

consensusStreamId

consensusModuleSnapshotStreamId

consensusModuleSnapshotStreamId

serviceSnapshotStreamId

serviceSnapshotStreamId

logStreamId

logStreamId

catchupEndpoint

catchupEndpoint

catchupChannel

catchupChannel

clusterBackupIntervalNs

clusterBackupIntervalNs

clusterBackupResponseTimeoutNs

clusterBackupResponseTimeoutNs

clusterBackupProgressTimeoutNs

clusterBackupProgressTimeoutNs

clusterBackupCoolDownIntervalNs

clusterBackupCoolDownIntervalNs

clusterConsensusEndpoints

clusterConsensusEndpoints

shutdownSignalBarrier

shutdownSignalBarrier

terminationHook

terminationHook

clusterMarkFile

clusterMarkFile

errorBufferLength

errorBufferLength

errorLog

errorLog

stateCounter

stateCounter

liveLogPositionCounter

liveLogPositionCounter

nextQueryDeadlineMsCounter