com.atlassian.crowd.manager.backup

Interface BackupScheduler

All Known Implementing Classes:

AtlassianSchedulerBackupScheduler

public interface BackupScheduler

Service to handle the scheduling of automated backup.

Since:

v2.7

Method Summary

Modifier and Type	Method and Description
void	disable() Disable automated backups.
void	enable() Enable automated backups.
int	getHourToRun() Return the time of day at which the automated backups are run
boolean	isEnabled() Return whether automated backup is enabled
void	setHourToRun(int hourToRun) Set the time of day at which the automated backups are run.

Method Detail

isEnabled

boolean isEnabled()

Return whether automated backup is enabled

Returns:

true if automated backup is enabled

enable

void enable()
     throws ScheduledBackupException

Enable automated backups.

Throws:

ScheduledBackupException - if there was a problem scheduling the automated backup job

disable

void disable()
      throws ScheduledBackupException

Disable automated backups.

Throws:

ScheduledBackupException - if there was a problem scheduling the automated backup job

setHourToRun

void setHourToRun(int hourToRun)
           throws ScheduledBackupException

Set the time of day at which the automated backups are run.

Parameters:

hourToRun - a valid time (must be between 0 and 23)

Throws:

ScheduledBackupException - if there was a problem re-scheduling the automated backup job

getHourToRun

int getHourToRun()

Return the time of day at which the automated backups are run

Returns:

a number between 0 and 23