|
Oracle® Coherence Java API Reference Release 12.1.2.0.3 E26043-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.tangosol.coherence.rest.CacheResource
public class CacheResource
RESTful wrapper around a Coherence NamedCache
.
Field Summary | |
---|---|
protected NamedCache |
m_cache NamedCache wrapped by this resource. |
protected java.lang.Class |
m_clzKey Key class for the entries stored in the wrapped cache. |
protected java.lang.Class |
m_clzValue Value class for the entries stored in the wrapped cache. |
protected int |
m_cMaxResults Size of the result set this resource is allowed to return. |
protected KeyConverter |
m_keyConverter Key converter. |
protected MarshallerRegistry |
m_marshallerRegistry Marshaller registry to obtain marshallers from. |
protected QueryConfig |
m_queryConfig Query configuration for this resource. |
protected QueryEngineRegistry |
m_queryEngineRegistry Query engine registry to obtain query engines from. |
Constructor Summary | |
---|---|
CacheResource(NamedCache cache, java.lang.Class clzKey, java.lang.Class clzValue, KeyConverter keyConverter, QueryConfig queryConfig, int cMaxResults, MarshallerRegistry marshallerRegistry, QueryEngineRegistry queryEngineRegistry) Construct a new CacheResource. |
|
CacheResource(NamedCache cache, java.lang.Class clzKey, java.lang.Class clzValue, QueryConfig queryConfig, int cMaxResults, MarshallerRegistry marshallerRegistry, QueryEngineRegistry queryEngineRegistry) Construct a new CacheResource. |
Method Summary | |
---|---|
javax.ws.rs.core.Response |
aggregate(java.lang.String sAggr, java.lang.String sQuery, AggregatorRegistry registry) Perform an aggregating operation against the entries that satisfy the specified criteria. |
javax.ws.rs.core.Response |
getCacheEntries(int nStart, int cResults, java.lang.String sSort, PropertySet propertySet, java.lang.String sQuery) Return the cache entries values (or a subset of their properties) that satisfies the specified criteria. |
java.lang.Object |
getEntryOrQueryResource(java.lang.String sKey) Return a REST sub-resource representing either a configured named query or a single cache entry. |
EntrySetResource |
getEntrySetResource(java.lang.String sKeys) Return a REST sub-resource representing a set of cache entries. |
javax.ws.rs.core.Response |
getKeys(java.lang.String sQuery) Return the keys of cache entries that satisfy the given query criteria. |
protected java.util.Set |
keys(java.lang.String sQuery) Returns a set of keys that satisfy the criteria expressed by the query. |
javax.ws.rs.core.Response |
process(java.lang.String sProc, java.lang.String sQuery, ProcessorRegistry registry) Invoke the specified processor against the entries that satisfy the specified criteria. |
Field Detail |
---|
protected final NamedCache m_cache
protected final java.lang.Class m_clzKey
protected final java.lang.Class m_clzValue
protected final KeyConverter m_keyConverter
protected final int m_cMaxResults
protected final MarshallerRegistry m_marshallerRegistry
protected final QueryConfig m_queryConfig
protected final QueryEngineRegistry m_queryEngineRegistry
Constructor Detail |
---|
public CacheResource(NamedCache cache, java.lang.Class clzKey, java.lang.Class clzValue, QueryConfig queryConfig, int cMaxResults, MarshallerRegistry marshallerRegistry, QueryEngineRegistry queryEngineRegistry)
cache
- cache to create a resource forclzKey
- key class of the cached entriesclzValue
- value class of the cached entriesqueryConfig
- query configuration for this resourcecMaxResults
- max size of result set for this resourcemarshallerRegistry
- marshaller registry to usequeryEngineRegistry
- query engine registry to usepublic CacheResource(NamedCache cache, java.lang.Class clzKey, java.lang.Class clzValue, KeyConverter keyConverter, QueryConfig queryConfig, int cMaxResults, MarshallerRegistry marshallerRegistry, QueryEngineRegistry queryEngineRegistry)
cache
- cache to create a resource forclzKey
- key class of the cached entriesclzValue
- value class of the cached entrieskeyConverter
- key converter to usecMaxResults
- max ize of result set for this resourcequeryConfig
- queries configured for this resourcemarshallerRegistry
- marshaller registry to usequeryEngineRegistry
- query engine registry to useMethod Detail |
---|
public javax.ws.rs.core.Response getCacheEntries(int nStart, int cResults, java.lang.String sSort, PropertySet propertySet, java.lang.String sQuery)
nStart
- starting index of result set to be returnedcResults
- size of result set to be returned (page size)sSort
- a string expression that represents orderingpropertySet
- properties to return (if null, values will be returned)sQuery
- where predicate of Coherence Query Language to filter cache entries. If null, all cache values will be returnedpublic javax.ws.rs.core.Response aggregate(java.lang.String sAggr, java.lang.String sQuery,
sAggr
- name of the aggregatorsQuery
- where predicate of Coherence Query Language to filter cache entries (optional)registry
- aggregator registry that is used to map the given aggregator name to an EntryAggregator instancepublic javax.ws.rs.core.Response process(java.lang.String sProc, java.lang.String sQuery,
sProc
- the name of the processorsQuery
- where predicate of Coherence Query Language to filter cache entries (optional)registry
- processor registry that is used to map the given processor name to an the EntryProcessor instancepublic javax.ws.rs.core.Response getKeys(java.lang.String sQuery)
sQuery
- query expressionpublic java.lang.Object getEntryOrQueryResource(java.lang.String sKey)
sKey
- name of the configured query or referenced entry's keypublic EntrySetResource getEntrySetResource(java.lang.String sKeys)
sKeys
- keys of the referenced entriesprotected java.util.Set keys(java.lang.String sQuery)
sQuery
- query used to filter cache entries
|
Oracle® Coherence Java API Reference Release 12.1.2.0.3 E26043-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |