# quartz-redis-jobstore

**Repository Path**: matthewgao/quartz-redis-jobstore

## Basic Information

- **Project Name**: quartz-redis-jobstore
- **Description**: A Quartz Scheduler JobStore using Redis.
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-31
- **Last Updated**: 2021-12-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

quartz-redis-jobstore
=====================

[![Build Status](https://secure.travis-ci.org/jlinn/quartz-redis-jobstore.png?branch=master)](http://travis-ci.org/jlinn/quartz-redis-jobstore)

A [Quartz Scheduler](http://quartz-scheduler.org/) JobStore using [Redis](http://redis.io).

This project was inspired by [redis-quartz](https://github.com/RedisLabs/redis-quartz), and provides similar functionality with some key differences:

* Redis database and key prefix are configurable.
* Redis' [recommended distributed locking method](http://redis.io/topics/distlock) is used.
* All of the functionality of this library is covered by a [test suite](https://github.com/jlinn/quartz-redis-jobstore/tree/master/src/test/java/net/joelinn/quartz).

## Requirements
* Java 7 or higher
* Redis 2.6.12 or higher (3.0 or higher for Redis cluster)

## Installation
Maven dependency:
```xml
<dependency>
    <groupId>net.joelinn</groupId>
    <artifactId>quartz-redis-jobstore</artifactId>
    <version>1.2.0</version>
</dependency>
```

## Configuration
The following properties may be set in your `quartz.properties` file:
```
# set the scheduler's JobStore class (required)
org.quartz.jobStore.class = net.joelinn.quartz.jobstore.RedisJobStore

# set the Redis host (required)
org.quartz.jobStore.host = <your redis host or a comma-delimited list of host:port if clustered use is desired>

# set the scheduler's trigger misfire threshold in milliseconds (optional, defaults to 60000)
org.quartz.jobStore.misfireThreshold = 60000

# set the redis password (optional, defaults null)
org.quartz.jobStore.password = <your redis password>

# set the redis port (optional, defaults to 6379)
org.quartz.jobStore.port = <your redis port>

# enable Redis clustering (optional, defaults to false)
org.quartz.jobStore.redisCluster = <true or false> 

# enable Redis sentinel (optional, defaults to false)
org.quartz.jobStore.redisSentinel = <true or false>

# set the sentinel master group name (required if redisSentinel = true)
org.quartz.jobStore.masterGroupName = <your master group name>

# set the redis database (optional, defaults to 0)
org.quartz.jobStore.database: <your redis db>

# set the Redis key prefix for all JobStore Redis keys (optional, defaults to none)
org.quartz.jobStore.keyPrefix = a_prefix_

# set the Redis lock timeout in milliseconds (optional, defaults to 30000)
org.quartz.jobStore.lockTimeout = 30000

# enable SSL (defaults to false)
org.quartz.jobStore.ssl = <true or false>
```

## Limitations
All GroupMatcher comparators have been implemented. 
Aside from that, the same limitations outlined in [redis-quartz's readme](https://github.com/RedisLabs/redis-quartz#limitations) apply.