org.mapfish.print.servlet.registry

Interface Registry

All Known Implementing Classes:

BasicRegistry

public interface Registry

A variable store for sharing common values across all nodes in a cluster.

For example the PDF key and URI might be put in this registry. Also queue length perhaps.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(java.lang.String key) Check if something is registered for the key.
void	delete(java.lang.String key) Delete the given key.
org.json.JSONObject	getJSON(java.lang.String key) Get a json object from the registry.
java.lang.Number	getNumber(java.lang.String key) Get a number from the registry.
java.lang.String	getString(java.lang.String key) Get string from the registry.
long	getTimeToKeepAfterAccessInMillis() Return the amount of time the registry will keep an entry before purging the record.
java.net.URI	getURI(java.lang.String key) Get a URI from the registry.
int	incrementInt(java.lang.String key, int amount) Increment the value currently stored in the registry by the amount.
long	incrementLong(java.lang.String key, long amount) Increment the value currently stored in the registry by the amount.
<T> T	opt(java.lang.String key, T defaultValue) Get a value from the registry or return the default if the value is not in the registry.
void	put(java.lang.String key, org.json.JSONObject value) Put a json object in the registry.
void	put(java.lang.String key, java.lang.Number value) Put a number in the registry.
void	put(java.lang.String key, java.lang.String value) Put a string in the registry.
void	put(java.lang.String key, java.net.URI value) Put a URI in the registry.

Method Detail

containsKey

boolean containsKey(java.lang.String key)

Check if something is registered for the key.

Parameters:

key - key to check for

put

void put(java.lang.String key,
         java.net.URI value)

Put a URI in the registry.

Parameters:

key - the key of the entry

value - the value

getURI

java.net.URI getURI(java.lang.String key)

Get a URI from the registry.

Parameters:

key - the key to use for lookup.

put

void put(java.lang.String key,
         java.lang.String value)

Put a string in the registry.

Parameters:

key - the key of the entry

value - the value

getString

java.lang.String getString(java.lang.String key)

Get string from the registry.

Parameters:

key - the key to use for lookup.

put

void put(java.lang.String key,
         java.lang.Number value)

Put a number in the registry.

Parameters:

key - the key of the entry

value - the value

getNumber

java.lang.Number getNumber(java.lang.String key)

Get a number from the registry.

Parameters:

key - the number

opt

<T> T opt(java.lang.String key,
          T defaultValue)

Get a value from the registry or return the default if the value is not in the registry.

Type Parameters:

T - the type of the returned object

Parameters:

key - the key of the element to the key to use for lookup.

defaultValue - the value to return if a value with the key is not in the registry

put

void put(java.lang.String key,
         org.json.JSONObject value)

Put a json object in the registry.

Parameters:

key - the key of the entry

value - the value

getJSON

org.json.JSONObject getJSON(java.lang.String key)

Get a json object from the registry.

Parameters:

key - the key use for lookup

incrementInt

int incrementInt(java.lang.String key,
                 int amount)

Increment the value currently stored in the registry by the amount. This assumes it is an integer.

If there is not value present in registry then a value will be registered as amount.

Parameters:

key - the key of the element to increment

amount - th amount to increment

Returns:

the new value

incrementLong

long incrementLong(java.lang.String key,
                   long amount)

Increment the value currently stored in the registry by the amount. This assumes it is an long.

If there is not value present in registry then a value will be registered as amount.

Parameters:

key - the key of the element to increment

amount - the amount to increment

Returns:

the new value

getTimeToKeepAfterAccessInMillis

long getTimeToKeepAfterAccessInMillis()

Return the amount of time the registry will keep an entry before purging the record. This ability to purge old records prevents the registry from growing in size indefinitely.

Returns:

the number of milliseconds between the last access of a record and the time when a record can be purged from the registry.

delete

void delete(java.lang.String key)

Delete the given key.

Parameters:

key - the key to delete.