Skip navigation links

com.tangosol.coherence.rest
Class EntrySetResource

java.lang.Object
com.tangosol.coherence.rest.EntrySetResource

public class EntrySetResource

extends java.lang.Object

REST resource representing a set of cache entries.

Author:

as 2011.06.28

Field Summary

protected NamedCache	m_cache Cache which stores the referenced entries.
protected java.lang.Class	m_clzValue Class of the referenced entries' values.
protected java.util.Set	m_setKeys Referenced entries' keys.

Constructor Summary

EntrySetResource(NamedCache cache, java.util.Set setKeys, java.lang.Class clzValue)
Construct an EntrySetResource.

Method Summary

javax.ws.rs.core.Response	aggregate(java.lang.String sAggr, AggregatorRegistry registry) Perform an aggregating operation against the entries.
javax.ws.rs.core.Response	delete() Remove the entries.
javax.ws.rs.core.Response	get(PropertySet propertySet) Return the entries' values or a subset of their properties.
protected java.util.Collection	getValues() Get the entries' values.
javax.ws.rs.core.Response	process(java.lang.String sProc, ProcessorRegistry registry) Invoke the specified processor against the entries.
protected void	remove() Remove the entries from the cache.

Field Detail

m_cache

protected final NamedCache m_cache

Cache which stores the referenced entries.

m_setKeys

protected final java.util.Set m_setKeys

Referenced entries' keys.

m_clzValue

protected final java.lang.Class m_clzValue

Class of the referenced entries' values.

Constructor Detail

EntrySetResource

public EntrySetResource(NamedCache cache,
                        java.util.Set setKeys,
                        java.lang.Class clzValue)

Construct an EntrySetResource.

Parameters:

cache - cache that stores the referenced entries

setKeys - keys of the referenced entries

clzValue - class of the referenced entries' values

Method Detail

get

public javax.ws.rs.core.Response get(PropertySet propertySet)

Return the entries' values or a subset of their properties.

Parameters:

propertySet - properties to return (if null, values will be returned)

Returns:

entries' values or a subset of their properties

aggregate

public javax.ws.rs.core.Response aggregate(java.lang.String sAggr,
                                           

Perform an aggregating operation against the entries.

Parameters:

sAggr - name of the aggregator

registry - aggregator registry that is used to map the given aggregator name to an EntryAggregator instance

Returns:

the result of the aggregation

process

public javax.ws.rs.core.Response process(java.lang.String sProc,
                                         

Invoke the specified processor against the entries.

Parameters:

sProc - name of the processor

registry - processor registry that is used to map the given processor name to an the EntryProcessor instance

Returns:

a Map containing the results of invoking the EntryProcessor against the entries

delete

public javax.ws.rs.core.Response delete()

Remove the entries.

Returns:

response with a status of 200 (OK)

getValues

protected java.util.Collection getValues()

Get the entries' values.

Returns:

entries' values

remove

protected void remove()

Remove the entries from the cache.