com.atlassian.crowd.manager.backup

Class AtlassianSchedulerBackupScheduler

java.lang.Object

com.atlassian.crowd.manager.backup.AtlassianSchedulerBackupScheduler

All Implemented Interfaces:

BackupScheduler

public class AtlassianSchedulerBackupScheduler
extends Object
implements BackupScheduler

Atlassian Scheduler specific implementation of BackupScheduler

Since:

v2.8

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENABLED_PROPERTY
static String	HOUR_PROPERTY
static com.atlassian.scheduler.config.JobId	JOB_ID
static com.atlassian.scheduler.config.JobRunnerKey	JOB_RUNNER_KEY

Constructor Summary

Constructors

Constructor and Description
AtlassianSchedulerBackupScheduler(com.atlassian.scheduler.SchedulerService schedulerService, PropertyManager propertyManager, BackupManager backupManager, com.atlassian.event.api.EventPublisher eventPublisher, BackupFileStore backupFileStore)

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	onApplicationReady(ApplicationReadyEvent applicationReadyEvent)
void	onXMLRestore(XMLRestoreFinishedEvent restoreFinishedEvent)
void	registerListener()
protected void	scheduleJob(int timeOfDay)
void	setHourToRun(int timeOfDay) Set the time of day at which the automated backups are run.
void	unregisterListener()

Methods inherited from class java.lang.Object

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

Field Detail

ENABLED_PROPERTY

public static final String ENABLED_PROPERTY

See Also:

Constant Field Values

HOUR_PROPERTY

public static final String HOUR_PROPERTY

See Also:

Constant Field Values

JOB_ID

public static final com.atlassian.scheduler.config.JobId JOB_ID

JOB_RUNNER_KEY

public static final com.atlassian.scheduler.config.JobRunnerKey JOB_RUNNER_KEY

Constructor Detail

AtlassianSchedulerBackupScheduler

public AtlassianSchedulerBackupScheduler(com.atlassian.scheduler.SchedulerService schedulerService,
                                         PropertyManager propertyManager,
                                         BackupManager backupManager,
                                         com.atlassian.event.api.EventPublisher eventPublisher,
                                         BackupFileStore backupFileStore)

Method Detail

registerListener

@PostConstruct
public void registerListener()

unregisterListener

@PreDestroy
public void unregisterListener()

onApplicationReady

@EventListener
public void onApplicationReady(ApplicationReadyEvent applicationReadyEvent)

onXMLRestore

@EventListener
public void onXMLRestore(XMLRestoreFinishedEvent restoreFinishedEvent)

isEnabled

public boolean isEnabled()

Description copied from interface: BackupScheduler

Return whether automated backup is enabled

Specified by:

isEnabled in interface BackupScheduler

Returns:

true if automated backup is enabled

enable

public void enable()
            throws ScheduledBackupException

Description copied from interface: BackupScheduler

Enable automated backups.

Specified by:

enable in interface BackupScheduler

Throws:

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

disable

public void disable()
             throws ScheduledBackupException

Description copied from interface: BackupScheduler

Disable automated backups.

Specified by:

disable in interface BackupScheduler

Throws:

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

getHourToRun

public int getHourToRun()

Description copied from interface: BackupScheduler

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

Specified by:

getHourToRun in interface BackupScheduler

Returns:

a number between 0 and 23

setHourToRun

public void setHourToRun(int timeOfDay)
                  throws ScheduledBackupException

Description copied from interface: BackupScheduler

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

Specified by:

setHourToRun in interface BackupScheduler

Parameters:

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

Throws:

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

scheduleJob

protected void scheduleJob(int timeOfDay)
                    throws ParseException,
                           com.atlassian.scheduler.SchedulerServiceException

Throws:

ParseException

com.atlassian.scheduler.SchedulerServiceException