MemoryClusteredJobDao (Atlassian Scheduler - Caesium Implementation 3.0.2 API)

java.lang.Object
- com.atlassian.scheduler.caesium.impl.MemoryClusteredJobDao

All Implemented Interfaces:

ClusteredJobDao
```
public class MemoryClusteredJobDao
extends Object
implements ClusteredJobDao
```
A memory-based partial implementation of ClusteredJobDao that is not fully compliant with the SPI.
WARNING: Although otherwise perfectly functional, this implementation is purely RAM-based, so it does not persist clustered jobs across restarts. This violates the general contract of the atlassian-scheduler API. In particular, see RunMode.RUN_ONCE_PER_CLUSTER and ClusteredJobDao, which both make it clear that clustered jobs should survive an application restart. It would therefore be inappropriate to use this implementation except in very special cases, like functional testing or "dev mode". Even applications that do not support clustering should avoid using this implementation, as failing to preserve the jobs across restarts might confuse cross-product plugins.

Constructor Summary

Constructors
Constructor and Description

MemoryClusteredJobDao()

Constructors
Constructor and Description
`MemoryClusteredJobDao()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`create(ClusteredJob clusteredJob)` Called to create a new clustered job in the database.
`boolean`	`delete(com.atlassian.scheduler.config.JobId jobId)` Called to remove a scheduled cluster job by its ID.
`ClusteredJob`	`find(com.atlassian.scheduler.config.JobId jobId)` Finds and returns the persisted details for a clustered job.
`Set<com.atlassian.scheduler.config.JobRunnerKey>`	`findAllJobRunnerKeys()` Returns the set of distinct job runner keys that have at least one job schedule stored here.
`Collection<ClusteredJob>`	`findByJobRunnerKey(com.atlassian.scheduler.config.JobRunnerKey jobRunnerKey)` Returns all jobs that use the given job runner.
`Date`	`getNextRunTime(com.atlassian.scheduler.config.JobId jobId)` Returns the next run time for the given job ID, if there is one.
`Long`	`getVersion(com.atlassian.scheduler.config.JobId jobId)` Returns the current version of the persisted clustered job with this ID.
`Map<com.atlassian.scheduler.config.JobId,Date>`	`refresh()` Returns the job ID and next run time for every clustered job that should be in the queue.
`boolean`	`updateNextRunTime(com.atlassian.scheduler.config.JobId jobId, Date nextRunTime, long expectedVersion)` Updates the next run time for an existing clustered job.

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

- Constructor Detail
  - MemoryClusteredJobDao
```
public MemoryClusteredJobDao()
```
- Method Detail
  - getNextRunTime
```
@Nullable
public Date getNextRunTime(com.atlassian.scheduler.config.JobId jobId)
```
    Description copied from interface: ClusteredJobDao
    Returns the next run time for the given job ID, if there is one.
    Implementations MAY implement this with:
```
     ClusteredJob clusteredJob = find(jobId);
     return (clusteredJob != null) ? clusteredJob.getNextRunTime() : null;
 
```
    However, this would be wasteful, and implementations SHOULD use a more efficient query when possible.
    Specified by:
    
    getNextRunTime in interface ClusteredJobDao
    
    Parameters:
    
    jobId - the job ID whose existence and current version is to be checked
    
    Returns:
    
    the currently existing next run time for that jobId; null if no such job exists or if it exists but its schedule prevents it from ever running again.
  - getVersion
```
@Nullable
public Long getVersion(com.atlassian.scheduler.config.JobId jobId)
```
    Description copied from interface: ClusteredJobDao
    Returns the current version of the persisted clustered job with this ID.
    Implementations MAY implement this with:
```
     ClusteredJob clusteredJob = find(jobId);
     return (clusteredJob != null) ? clusteredJob.getVersion() : null;
 
```
    However, this would be wasteful, and implementations SHOULD use a more efficient query when possible.
    Specified by:
    
    getVersion in interface ClusteredJobDao
    
    Parameters:
    
    jobId - the job ID whose existence and current version is to be checked
    
    Returns:
    
    the currently existing version for that jobId, or null if no such job exists
  - find
```
@Nullable
public ClusteredJob find(com.atlassian.scheduler.config.JobId jobId)
```
    Description copied from interface: ClusteredJobDao
    
    Finds and returns the persisted details for a clustered job.
    
    Specified by:
    
    find in interface ClusteredJobDao
    
    Parameters:
    
    jobId - the job ID for the job details to be loaded
    
    Returns:
    
    the existing job details, or null if the job does not exist
  - findByJobRunnerKey
```
@Nonnull
public Collection<ClusteredJob> findByJobRunnerKey(com.atlassian.scheduler.config.JobRunnerKey jobRunnerKey)
```
    Description copied from interface: ClusteredJobDao
    Returns all jobs that use the given job runner.
    Implementations:
    - SHOULD issue a query of the form SELECT * FROM jobs WHERE jobRunnerKey = ? to retrieve all job details that match the given jobRunnerKey.
    - MUST return a ClusteredJob for each clustered job that has been persisted with the specified jobRunnerKey.
    Specified by:
    
    findByJobRunnerKey in interface ClusteredJobDao
    
    Parameters:
    
    jobRunnerKey - the job runner key for which to search
    
    Returns:
    
    the set of clustered jobs with the given job runner, in no particular order
  - refresh
```
@Nonnull
public Map<com.atlassian.scheduler.config.JobId,Date> refresh()
```
    Description copied from interface: ClusteredJobDao
    Returns the job ID and next run time for every clustered job that should be in the queue.
    Implementations:
    - SHOULD issue a query of the form SELECT jobId, nextRunTime FROM jobs WHERE nextRunTime IS NOT NULL to retrieve all existing job IDs that have scheduled next time to run.
    - MUST return a mapping of all job IDs to the next run time for that job ID. The keys and values MUST NOT be null for any entry in the returned map.
    Specified by:
    
    refresh in interface ClusteredJobDao
  - findAllJobRunnerKeys
```
@Nonnull
public Set<com.atlassian.scheduler.config.JobRunnerKey> findAllJobRunnerKeys()
```
    Description copied from interface: ClusteredJobDao
    Returns the set of distinct job runner keys that have at least one job schedule stored here.
    Implementations:
    - SHOULD issue a query of the form SELECT DISTINCT jobRunnerKey FROM jobs to retrieve all unique job runner keys.
    - MUST return the canonical set of job runner keys, regardless of whether or not they have any jobs that will ever run again — that is, it does not matter whether the nextRunTime is null or not.
    Specified by:
    
    findAllJobRunnerKeys in interface ClusteredJobDao
    
    Returns:
    
    the canonical set of all job runner keys that have at least one scheduled job, whether it will ever run again or not
  - create
```
public boolean create(ClusteredJob clusteredJob)
```
    Description copied from interface: ClusteredJobDao
    Called to create a new clustered job in the database.
    Implementations:
    - SHOULD issue a statement of the form INSERT INTO jobs ... VALUES ... to create a representation of this job.
    - MUST return false rather than throw an exception if the request fails due to a UNIQUE constraint
    - MAY attempt to determine such failures with a SELECT for a conflicting entry if the persistence layer does not make it possible to distinguish UNIQUE constraint failures reliably.
    Specified by:
    
    create in interface ClusteredJobDao
    
    Parameters:
    
    clusteredJob - the job details to be created
  - updateNextRunTime
```
public boolean updateNextRunTime(com.atlassian.scheduler.config.JobId jobId,
                                 @Nullable
                                 Date nextRunTime,
                                 long expectedVersion)
```
    Description copied from interface: ClusteredJobDao
    Updates the next run time for an existing clustered job.
    Implementations:
    - SHOULD issue a statement of the form UPDATE jobs SET nextRunTime = ?, version = ? WHERE jobId = ? AND version = ?
    - MUST ensure that the update occurs if and only if the job is already persisted with the expected version.
    - MUST change the version as part of the update
    - MUST return false if no rows are updated, whether because the job does not exist or because the specified version is incorrect.
    Specified by:
    
    updateNextRunTime in interface ClusteredJobDao
    
    Parameters:
    
    jobId - the job ID for which to update the next run time
    
    nextRunTime - the new next run time, or null if it will never run again
    
    expectedVersion - the version of the job details that are expected to be found
    
    Returns:
    
    true if the update is successful; false otherwise
  - delete
```
public boolean delete(com.atlassian.scheduler.config.JobId jobId)
```
    Description copied from interface: ClusteredJobDao
    Called to remove a scheduled cluster job by its ID.
    Implementations:
    - SHOULD issue a statement of the form DELETE FROM jobs WHERE jobId = ?
    - MUST return false if there is no matching row to delete; note that this is not an error and the implementation MUST NOT throw an exception for it
    Specified by:
    
    delete in interface ClusteredJobDao
    
    Parameters:
    
    jobId - the job to be unscheduled
    
    Returns:
    
    true if the job is successfully removed; false, otherwise

Class MemoryClusteredJobDao

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MemoryClusteredJobDao

Method Detail

getNextRunTime

getVersion

find

findByJobRunnerKey

refresh

findAllJobRunnerKeys

create

updateNextRunTime

delete