RedisJobStoreSchema (quartz-redis-jobstore 1.1.8 API)

java.lang.Object
- net.joelinn.quartz.jobstore.RedisJobStoreSchema

public class RedisJobStoreSchema
extends Object

Joe Linn 7/14/2014

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`DEFAULT_DELIMITER`
`protected String`	`delimiter`
`protected static String`	`JOB_GROUPS_SET`
`protected static String`	`JOBS_SET`
`protected static String`	`LOCK`
`protected String`	`prefix`

Constructor Summary

Constructors
Constructor and Description

RedisJobStoreSchema()

RedisJobStoreSchema(String prefix)

RedisJobStoreSchema(String prefix, String delimiter)

Constructors
Constructor and Description
`RedisJobStoreSchema()`
`RedisJobStoreSchema(String prefix)`
`RedisJobStoreSchema(String prefix, String delimiter)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected String`	`addPrefix(String key)` Add the configured prefix string to the given key
`String`	`blockedJobsSet()`
`String`	`calendarHashKey(String calendarName)`
`String`	`calendarName(String calendarHashKey)`
`String`	`calendarsSet()`
`String`	`calendarTriggersSetKey(String calendarName)`
`String`	`jobBlockedKey(org.quartz.JobKey jobKey)`
`String`	`jobDataMapHashKey(org.quartz.JobKey jobKey)`
`String`	`jobGroup(String jobGroupSetKey)`
`String`	`jobGroupSetKey(org.quartz.JobKey jobKey)`
`String`	`jobGroupsSet()`
`String`	`jobHashKey(org.quartz.JobKey jobKey)`
`org.quartz.JobKey`	`jobKey(String jobHashKey)`
`String`	`jobsSet()`
`String`	`jobTriggersSetKey(org.quartz.JobKey jobKey)`
`String`	`lastTriggerReleaseTime()`
`String`	`lockKey()`
`String`	`pausedJobGroupsSet()`
`String`	`pausedTriggerGroupsSet()`
`protected List<String>`	`split(String string)` Split a string on the configured delimiter
`String`	`triggerDataMapHashKey(org.quartz.TriggerKey triggerKey)`
`String`	`triggerGroup(String triggerGroupSetKey)`
`String`	`triggerGroupSetKey(org.quartz.TriggerKey triggerKey)`
`String`	`triggerGroupsSet()`
`String`	`triggerHashKey(org.quartz.TriggerKey triggerKey)`
`org.quartz.TriggerKey`	`triggerKey(String triggerHashKey)`
`String`	`triggerLockKey(org.quartz.TriggerKey triggerKey)`
`String`	`triggersSet()`
`String`	`triggerStateKey(RedisTriggerState state)`

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

- Field Detail
  - DEFAULT_DELIMITER
```
protected static final String DEFAULT_DELIMITER
```
    See Also:
    
    Constant Field Values
  - JOBS_SET
```
protected static final String JOBS_SET
```
    See Also:
    
    Constant Field Values
  - JOB_GROUPS_SET
```
protected static final String JOB_GROUPS_SET
```
    See Also:
    
    Constant Field Values
  - LOCK
```
protected static final String LOCK
```
    See Also:
    
    Constant Field Values
  - prefix
```
protected final String prefix
```
  - delimiter
```
protected final String delimiter
```
- Constructor Detail
  - RedisJobStoreSchema
```
public RedisJobStoreSchema()
```
  - RedisJobStoreSchema
```
public RedisJobStoreSchema(String prefix)
```
    Parameters:
    
    prefix - the prefix to be prepended to all redis keys
  - RedisJobStoreSchema
```
public RedisJobStoreSchema(String prefix,
                           String delimiter)
```
    Parameters:
    
    prefix - the prefix to be prepended to all redis keys
    
    delimiter - the delimiter to be used to separate key segments
- Method Detail
  - lockKey
```
public String lockKey()
```
    Returns:
    
    the redis key used for locking
  - jobsSet
```
public String jobsSet()
```
    Returns:
    
    the redis key for the set containing all job keys
  - jobGroupsSet
```
public String jobGroupsSet()
```
    Returns:
    
    the redis key for the set containing all job group keys
  - jobHashKey
```
public String jobHashKey(org.quartz.JobKey jobKey)
```
    Parameters:
    
    jobKey -
    
    Returns:
    
    the redis key associated with the given JobKey
  - jobDataMapHashKey
```
public String jobDataMapHashKey(org.quartz.JobKey jobKey)
```
    Parameters:
    
    jobKey -
    
    Returns:
    
    the redis key associated with the job data for the given JobKey
  - jobGroupSetKey
```
public String jobGroupSetKey(org.quartz.JobKey jobKey)
```
    Parameters:
    
    jobKey -
    
    Returns:
    
    the key associated with the group set for the given JobKey
  - jobKey
```
public org.quartz.JobKey jobKey(String jobHashKey)
```
    Parameters:
    
    jobHashKey - the hash key for a job
    
    Returns:
    
    the JobKey object describing the job
  - jobGroup
```
public String jobGroup(String jobGroupSetKey)
```
    Parameters:
    
    jobGroupSetKey - the redis key for a job group set
    
    Returns:
    
    the name of the job group
  - jobTriggersSetKey
```
public String jobTriggersSetKey(org.quartz.JobKey jobKey)
```
    Parameters:
    
    jobKey - the job key for which to get a trigger set key
    
    Returns:
    
    the key associated with the set of triggers for the given JobKey
  - blockedJobsSet
```
public String blockedJobsSet()
```
    Returns:
    
    the key associated with the set of blocked jobs
  - triggerHashKey
```
public String triggerHashKey(org.quartz.TriggerKey triggerKey)
```
    Parameters:
    
    triggerKey - a trigger key
    
    Returns:
    
    the redis key associated with the given TriggerKey
  - triggerDataMapHashKey
```
public String triggerDataMapHashKey(org.quartz.TriggerKey triggerKey)
```
    Parameters:
    
    triggerKey -
    
    Returns:
    
    the redis key associated with the trigger data for the given TriggerKey
  - triggerKey
```
public org.quartz.TriggerKey triggerKey(String triggerHashKey)
```
    Parameters:
    
    triggerHashKey - the hash key for a trigger
    
    Returns:
    
    the TriggerKey object describing the desired trigger
  - triggerGroup
```
public String triggerGroup(String triggerGroupSetKey)
```
    Parameters:
    
    triggerGroupSetKey - the redis key for a trigger group set
    
    Returns:
    
    the name of the trigger group represented by the given redis key
  - triggerGroupSetKey
```
public String triggerGroupSetKey(org.quartz.TriggerKey triggerKey)
```
    Parameters:
    
    triggerKey - a trigger key
    
    Returns:
    
    the redis key associated with the group of the given TriggerKey
  - triggersSet
```
public String triggersSet()
```
    Returns:
    
    the key of the set containing all trigger keys
  - triggerGroupsSet
```
public String triggerGroupsSet()
```
    Returns:
    
    the key of the set containing all trigger group keys
  - pausedTriggerGroupsSet
```
public String pausedTriggerGroupsSet()
```
    Returns:
    
    the key of the set containing paused trigger group keys
  - triggerStateKey
```
public String triggerStateKey(RedisTriggerState state)
```
    Parameters:
    
    state - a RedisTriggerState
    
    Returns:
    
    the key of a set containing the keys of triggers which are in the given state
  - triggerLockKey
```
public String triggerLockKey(org.quartz.TriggerKey triggerKey)
```
    Parameters:
    
    triggerKey - the key of the trigger for which to retrieve a lock key
    
    Returns:
    
    the redis key for the lock state of the given trigger
  - jobBlockedKey
```
public String jobBlockedKey(org.quartz.JobKey jobKey)
```
    Parameters:
    
    jobKey - the key of the job for which to retrieve a block key
    
    Returns:
    
    the redis key for the blocked state of the given job
  - lastTriggerReleaseTime
```
public String lastTriggerReleaseTime()
```
    Returns:
    
    the key which holds the time at which triggers were last released
  - pausedJobGroupsSet
```
public String pausedJobGroupsSet()
```
    Returns:
    
    the key of the set containing paused job groups
  - calendarTriggersSetKey
```
public String calendarTriggersSetKey(String calendarName)
```
    Parameters:
    
    calendarName - the name of the calendar for which to retrieve a key
    
    Returns:
    
    the redis key for the set containing trigger keys for the given calendar name
  - calendarHashKey
```
public String calendarHashKey(String calendarName)
```
    Parameters:
    
    calendarName - the name of the calendar for which to retrieve a key
    
    Returns:
    
    the redis key for the calendar with the given name
  - calendarName
```
public String calendarName(String calendarHashKey)
```
    Parameters:
    
    calendarHashKey - the redis key for a calendar
    
    Returns:
    
    the name of the calendar represented by the given key
  - calendarsSet
```
public String calendarsSet()
```
    Returns:
    
    the key of the set containing all calendar keys
  - addPrefix
```
protected String addPrefix(String key)
```
    Add the configured prefix string to the given key
    
    Parameters:
    
    key - the key to which the prefix should be prepended
    
    Returns:
    
    a prefixed key
  - split
```
protected List<String> split(String string)
```
    Split a string on the configured delimiter
    
    Parameters:
    
    string - the string to split
    
    Returns:
    
    a list comprised of the split parts of the given string

Class RedisJobStoreSchema

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_DELIMITER

JOBS_SET

JOB_GROUPS_SET

LOCK

prefix

delimiter

Constructor Detail

RedisJobStoreSchema

RedisJobStoreSchema

RedisJobStoreSchema

Method Detail

lockKey

jobsSet

jobGroupsSet

jobHashKey

jobDataMapHashKey

jobGroupSetKey

jobKey

jobGroup

jobTriggersSetKey

blockedJobsSet

triggerHashKey

triggerDataMapHashKey

triggerKey

triggerGroup

triggerGroupSetKey

triggersSet

triggerGroupsSet

pausedTriggerGroupsSet

triggerStateKey

triggerLockKey

jobBlockedKey

lastTriggerReleaseTime

pausedJobGroupsSet

calendarTriggersSetKey

calendarHashKey

calendarName

calendarsSet

addPrefix

split