org.kuali.rice.core.api.cache
Interface CacheAdminService

All Known Implementing Classes:

CacheAdminServiceImpl

public interface CacheAdminService

A service which facilitates remote operations against a cache which is deployed using Kuali Rice's core caching infrastructure. The only operation currently supported by this service allows for flushing of cache entries based on a specified collection of CacheTarget objects. These cache targets specify information about which cache entries should be flushed.

This service exists primarily to support client-side caching of data provided by remote services. It allows the host of the service to notify the client application about flush events, which typically result whenever changes have been made to data such that it would be stale if cached within the client.

Since:

2.0

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

void	flush(Collection<CacheTarget> cacheTargets) Flushes an object or group of objects from the cache based on a cache target.

Method Detail

flush

void flush(Collection<CacheTarget> cacheTargets)
           throws RiceIllegalArgumentException

Flushes an object or group of objects from the cache based on a cache target. If the given collection of cache targets is empty or null, this method will do nothing.

Parameters:

cacheTargets - a collection of targets to flush

Throws:

RiceIllegalArgumentException - if cacheTargets contains any null items.