alluxio.master.backup

Class BackupLeaderRole

java.lang.Object

alluxio.master.backup.AbstractBackupRole

alluxio.master.backup.BackupLeaderRole

All Implemented Interfaces:

BackupOps, BackupRole, Closeable, AutoCloseable

public class BackupLeaderRole
extends AbstractBackupRole

Implementation of BackupRole for primary mode.

Field Summary

Fields inherited from class alluxio.master.backup.AbstractBackupRole

mBackupManager, mBackupTracker, mCatalystContext, mCatalystRequestTimeout, mExecutorService, mJournalSystem, mRoleClosed, mServerUserState, mTaskScheduler, mUfsManager

Constructor Summary

Constructors

Constructor and Description
BackupLeaderRole(CoreMasterContext masterContext) Creates a new backup leader.

Method Summary

Modifier and Type	Method and Description
BackupStatus	backup(BackupPRequest request, StateLockOptions stateLockOptions) Takes a backup.
void	close()
BackupStatus	getBackupStatus(BackupStatusPRequest statusPRequest) Used to query the status of a backup.
Map<ServiceType,GrpcService>	getRoleServices()

Methods inherited from class alluxio.master.backup.AbstractBackupRole

sendMessageBlocking, takeBackup

Methods inherited from class java.lang.Object

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

Constructor Detail

BackupLeaderRole

public BackupLeaderRole(CoreMasterContext masterContext)

Creates a new backup leader.

Parameters:

masterContext - the master context

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractBackupRole

Throws:

IOException

getRoleServices

public Map<ServiceType,GrpcService> getRoleServices()

Returns:

services for the role

backup

public BackupStatus backup(BackupPRequest request,
                           StateLockOptions stateLockOptions)
                    throws AlluxioException

Description copied from interface: BackupOps

Takes a backup. Note: If backup request ask for async execution, it will return after initiating the backup. Status for the in-progress backup will be returned. BackupOps.getBackupStatus(alluxio.grpc.BackupStatusPRequest) should be called for querying the status of the on-going backup. Note: When leader has no secondary in an HA cluster, it will reject backup. This could be allowed by passing "AllowLeader" option in the request.

Parameters:

request - the backup request

stateLockOptions - the state lock options during the backup

Returns:

the backup status response

Throws:

AlluxioException

getBackupStatus

public BackupStatus getBackupStatus(BackupStatusPRequest statusPRequest)
                             throws AlluxioException

Description copied from interface: BackupOps

Used to query the status of a backup.

Parameters:

statusPRequest - status request

Returns:

the status of the latest backup

Throws:

AlluxioException