de.ipcon.tools

Class ExpiringTokenStore

java.lang.Object

de.ipcon.tools.ExpiringTokenStore

Direct Known Subclasses:

DBMan.DefaultExpiringTokenStore

public class ExpiringTokenStore
extends java.lang.Object

Simple implementation of a forgetting Map-alike. Provides put with an expiry, so values are removed once they are expired. Intentionally *not* implementing Map for simplicity.

Constructor Summary

Constructors

Constructor and Description
ExpiringTokenStore()

Method Summary

Modifier and Type	Method and Description
java.lang.String	createKeyAndPut(java.lang.String keyPrefix, java.lang.Object value, long expiryms) Creates a mapping to the given value by creating a key with the given keyPrefix without colliding any existing keys.
java.lang.Object	get(java.lang.Object key) Returns the value to which the specified key is mapped, or null if this store contains no association for the key.
java.lang.Object	put(java.lang.Object key, java.lang.Object value, long expiryms) Associates the specified value with the specified key in this store.
java.lang.Object	put(java.lang.Object key, java.lang.Object value, long expiry, java.util.concurrent.TimeUnit unit) Associates the specified value with the specified key in this store.
java.lang.Object	remove(java.lang.Object key) Removes the association for the specified key from this store if present.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExpiringTokenStore

public ExpiringTokenStore()

Method Detail

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value,
                            long expiryms)

Associates the specified value with the specified key in this store.

Parameters:

key - key with which the specified value is to be mapped

value - value to be mapped with the specified key

expiryms - the duration in ms the association is valid. After that time, it's removed

Returns:

the previous value mapped with key, or null if there was none for that key. (A null return can also indicate that the key was mapped with a null value.)

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value,
                            long expiry,
                            java.util.concurrent.TimeUnit unit)

Associates the specified value with the specified key in this store.

Parameters:

key - key with which the specified value is to be mapped

value - value to be mapped with the specified key

expiry - the duration in [unit] the association is valid. After that time, it's removed

unit - unit for the expiry parameter

Returns:

the previous value mapped with key, or null if there was none for that key. (A null return can also indicate that the key was mapped with a null value.)

createKeyAndPut

public java.lang.String createKeyAndPut(java.lang.String keyPrefix,
                                        java.lang.Object value,
                                        long expiryms)

Creates a mapping to the given value by creating a key with the given keyPrefix without colliding any existing keys.

Parameters:

keyPrefix - the prefix the generated key should start with

value - value to be mapped with the specified key

expiryms - the duration in ms the association is valid. After that time, it's removed

Returns:

the string key under which the value was mapped, which is generally url compatible (only using a-z, A-Z, 0-9, '-' and '_'.

get

public java.lang.Object get(java.lang.Object key)

Returns the value to which the specified key is mapped, or null if this store contains no association for the key.

Parameters:

key - the key whose mapped value is to be returned

Returns:

the value to which the specified key is mapped, or null if this store contains no association for the key

remove

public java.lang.Object remove(java.lang.Object key)

Removes the association for the specified key from this store if present.

Parameters:

key - the key whose mapped value is to be removed

Returns:

the value mapped with key, or null if there was none for that key. (A null return can also indicate that the key was mapped with a null value.)