Package org.deltafi.common.queue.jedis

Class JedisKeyedBlockingQueue

java.lang.Object

org.deltafi.common.queue.jedis.JedisKeyedBlockingQueue

public class JedisKeyedBlockingQueue
extends Object

A keyed blocking queue based on the Jedis client library for Redis.

Constructor Summary

Constructors

Constructor	Description
JedisKeyedBlockingQueue(String url, String password, int maxIdle, int maxTotal)	Constructs a JedisKeyedBlockingQueue.

Method Summary

Modifier and Type	Method	Description
void	drop(List<String> keys)	Drop all queues in key list.
boolean	exists(String key, String search)	Check if an object exists in the queue based on the search pattern
void	put(String key, String value)	Puts an object into the queue.
void	put(List<org.apache.commons.lang3.tuple.Pair<String,String>> items)	Puts multiple objects into the queue.
void	setHeartbeat(String key)	Publish a heartbeat in the form of a timestamp
String	take(String key)	Takes an object out of the queue.

Methods inherited from class java.lang.Object

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

Constructor Details

JedisKeyedBlockingQueue

public JedisKeyedBlockingQueue(String url,
 String password,
 int maxIdle,
 int maxTotal)
                        throws URISyntaxException

Constructs a JedisKeyedBlockingQueue.

Parameters:

url - the url of the redis server

password - the password for the redis server

maxIdle - the maximum number of idle pooled connections to the redis server

maxTotal - the maximum number of pooled connections to the redis server. This should be set higher than the expected number of keys in the queue.

Throws:

URISyntaxException - if the provided url is not valid

Method Details

put

public void put(String key,
 String value)

Puts an object into the queue.

Parameters:

key - the key for the queue

value - the object

exists

public boolean exists(String key,
 String search)

Check if an object exists in the queue based on the search pattern

Parameters:

key - the key for the object

search - the search pattern

Returns:

true if the pattern exists

drop

public void drop(List<String> keys)

Drop all queues in key list.

Parameters:

keys - list of keys

put

public void put(List<org.apache.commons.lang3.tuple.Pair<String,String>> items)

Puts multiple objects into the queue.

Parameters:

items - a list of key/object pairss to put into the queue

setHeartbeat

public void setHeartbeat(String key)

Publish a heartbeat in the form of a timestamp

Parameters:

key - the name of the component publishing the heartbeat

take

public String take(String key)

Takes an object out of the queue.

This method will block until an object for the provided key is available. When multiple objects are available for the provided key, the earliest one put into the queue is retrieved.

Parameters:

key - the key for the object

Returns:

the object value type