com.atlassian.confluence.schedule.persistence.dao
Class CachedScheduledJobDao

java.lang.Object
  extended by com.atlassian.confluence.schedule.persistence.dao.CachedScheduledJobDao
All Implemented Interfaces:
ScheduledJobDao

public class CachedScheduledJobDao
extends Object
implements ScheduledJobDao

Provides an implementation for storing data used by the ScheduleJobManager. Runtime/transient data is stored into Cache's (either ehcache or coherence caches) for quick access. The caches do not expire, and are sufficiently large not to fill up. There is currently no checking if they are full, and this will cause issues if this occurs. Use of cache's will allow the data to be synchronised across cluster nodes by coherence. Runtime/transient data includes the scheduled job status, and the default cron expressions. Persistent data is stored into Bandana, it's not intended to be used for high-frequency updates. Persistent data includes persisted history (when enabled), and the job configuration (changed cron expression, enabled/disabled flag).


Constructor Summary
CachedScheduledJobDao(com.atlassian.cache.Cache scheduledJobStatusCache, com.atlassian.bandana.BandanaManager bandanaManager)
           
 
Method Summary
 void addHistory(ScheduledJobKey key, ScheduledJobHistory history, Date nextOccurence, boolean persistHistory)
          Adds to an event to the history, and updates the nextOccurence in the ScheduledJobStatus.
 ScheduledJobConfiguration getScheduledJobConfiguration(ScheduledJobKey key)
          Gets the job configuration for the specified job.
 String getScheduledJobDefaultCronExpression(ScheduledJobKey key)
          Gets the default cron expression for the job.
 List<ScheduledJobHistory> getScheduledJobHistory(ScheduledJobKey key)
          The the job history for a specified job.
 ScheduledJobStatus getScheduledJobStatus(ScheduledJobKey key)
          Gets the specified job's status.
 void saveScheduledJobConfiguration(ScheduledJobKey key, ScheduledJobConfiguration job)
          Stores the job configuration.
 void saveScheduledJobDefaultCronExpression(ScheduledJobKey key, String cronExpressionDefault)
          Stores the default cron expression for a job.
 void saveScheduledJobStatus(ScheduledJobKey key, ScheduledJobStatus status)
          Stores the status for the specified job.
 void updateNextOccurence(ScheduledJobKey key, Date nextOccurence)
          Updates the nextOccurence in the ScheduledJobStatus.
 void updateStatus(ScheduledJobKey key, ExecutionStatus status)
          Updates the status in the corresponding ScheduledJobStatus for the job.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CachedScheduledJobDao

public CachedScheduledJobDao(com.atlassian.cache.Cache scheduledJobStatusCache,
                             com.atlassian.bandana.BandanaManager bandanaManager)
Method Detail

getScheduledJobStatus

public ScheduledJobStatus getScheduledJobStatus(ScheduledJobKey key)
Description copied from interface: ScheduledJobDao
Gets the specified job's status.

It's recommended that ScheduleJobStatusManager be used for access to a job's status, rather than this call directly. The manager handles cache expiry automatically.

Specified by:
getScheduledJobStatus in interface ScheduledJobDao
Parameters:
key - the job key
Returns:
null if the job does not exist, or the status has expired from the cache.

saveScheduledJobStatus

public void saveScheduledJobStatus(ScheduledJobKey key,
                                   ScheduledJobStatus status)
Description copied from interface: ScheduledJobDao
Stores the status for the specified job.

Specified by:
saveScheduledJobStatus in interface ScheduledJobDao
Parameters:
key - the job key
status - stores the job status.

addHistory

public void addHistory(ScheduledJobKey key,
                       ScheduledJobHistory history,
                       Date nextOccurence,
                       boolean persistHistory)
Description copied from interface: ScheduledJobDao
Adds to an event to the history, and updates the nextOccurence in the ScheduledJobStatus.

Specified by:
addHistory in interface ScheduledJobDao
Parameters:
key - the job key
history - the event that occurred
nextOccurence - the date that the job is expected to execute next
persistHistory - true the history will be persisted

getScheduledJobHistory

public List<ScheduledJobHistory> getScheduledJobHistory(ScheduledJobKey key)
Description copied from interface: ScheduledJobDao
The the job history for a specified job.

Specified by:
getScheduledJobHistory in interface ScheduledJobDao
Parameters:
key - the job key
Returns:
a list of ScheduledJobHistory. Null if no history has been recorded or persisted.

updateStatus

public void updateStatus(ScheduledJobKey key,
                         ExecutionStatus status)
Description copied from interface: ScheduledJobDao
Updates the status in the corresponding ScheduledJobStatus for the job. {link #saveScheduledJobStatus} should be called first, otherwise the update will be ignored.

Specified by:
updateStatus in interface ScheduledJobDao

updateNextOccurence

public void updateNextOccurence(ScheduledJobKey key,
                                Date nextOccurence)
Description copied from interface: ScheduledJobDao
Updates the nextOccurence in the ScheduledJobStatus.

Specified by:
updateNextOccurence in interface ScheduledJobDao
Parameters:
key - the job key
nextOccurence - the date that the job is expected to execute next

saveScheduledJobConfiguration

public void saveScheduledJobConfiguration(ScheduledJobKey key,
                                          ScheduledJobConfiguration job)
Description copied from interface: ScheduledJobDao
Stores the job configuration.

Specified by:
saveScheduledJobConfiguration in interface ScheduledJobDao
Parameters:
key - the job key
job - the configuration

getScheduledJobConfiguration

public ScheduledJobConfiguration getScheduledJobConfiguration(ScheduledJobKey key)
Description copied from interface: ScheduledJobDao
Gets the job configuration for the specified job.

Specified by:
getScheduledJobConfiguration in interface ScheduledJobDao
Parameters:
key - the job key
Returns:
null if not found.

saveScheduledJobDefaultCronExpression

public void saveScheduledJobDefaultCronExpression(ScheduledJobKey key,
                                                  String cronExpressionDefault)
Description copied from interface: ScheduledJobDao
Stores the default cron expression for a job.

Specified by:
saveScheduledJobDefaultCronExpression in interface ScheduledJobDao
Parameters:
key - the job key

getScheduledJobDefaultCronExpression

public String getScheduledJobDefaultCronExpression(ScheduledJobKey key)
Description copied from interface: ScheduledJobDao
Gets the default cron expression for the job.

Specified by:
getScheduledJobDefaultCronExpression in interface ScheduledJobDao
Parameters:
key - the job key
Returns:
null if job not found.


Copyright © 2003-2011 Atlassian. All Rights Reserved.