| org.sakaiproject.memory.api.MemoryService
All known Subclasses: org.sakaiproject.memory.impl.BasicMemoryService,
| MemoryService | | public interface MemoryService (Code) | |
MemoryService is the interface for the Sakai Memory service.
This tracks memory users (cachers), runs a periodic garbage collection to keep memory available, and can be asked to report memory usage.
|
| getAvailableMemory | | long getAvailableMemory()(Code) | | Report the amount of available memory.
the amount of available memory. |
| getStatus | | String getStatus()(Code) | | Get a status report of memory users.
A status report of memory users. |
| newCache | | Cache newCache(CacheRefresher refresher, String pattern)(Code) | | Construct a Cache. Attempts to keep complete on Event notification by calling the refresher.
Parameters:
refresher - The object that will handle refreshing of event notified modified or added entries.
Parameters:
pattern - The "startsWith()" string for all resources that may be in this cache - if null, don't watch events for updates. |
| newCache | | Cache newCache(CacheRefresher refresher, long sleep)(Code) | | Construct a Cache. Automatic refresh handling if refresher is not null.
Parameters:
refresher - The object that will handle refreshing of expired entries.
Parameters:
sleep - The number of seconds to sleep between expiration checks. |
| newCache | | Cache newCache()(Code) | | Construct a Cache. No automatic refresh handling.
|
| newHardCache | | Cache newHardCache(CacheRefresher refresher, String pattern)(Code) | | Construct a special Cache that uses hard references. Attempts to keep complete on Event notification by calling the refresher.
Parameters:
refresher - The object that will handle refreshing of event notified modified or added entries.
Parameters:
pattern - The "startsWith()" string for all resources that may be in this cache - if null, don't watch events for updates. |
| newHardCache | | Cache newHardCache(CacheRefresher refresher, long sleep)(Code) | | Construct a Cache. Automatic refresh handling if refresher is not null.
Parameters:
refresher - The object that will handle refreshing of expired entries.
Parameters:
sleep - The number of seconds to sleep between expiration checks. |
| newHardCache | | Cache newHardCache(long sleep, String pattern)(Code) | | Construct a Cache. No automatic refresh: expire only, from time and events.
Parameters:
sleep - The number of seconds to sleep between expiration checks.
Parameters:
pattern - The "startsWith()" string for all resources that may be in this cache - if null, don't watch events for expiration. |
| newHardCache | | Cache newHardCache()(Code) | | Construct a Cache. No automatic refresh handling.
|
| newMultiRefCache | | MultiRefCache newMultiRefCache(long sleep)(Code) | | Construct a multi-ref Cache. No automatic refresh: expire only, from time and events.
Parameters:
sleep - The number of seconds to sleep between expiration checks. |
| registerCacher | | void registerCacher(Cacher cacher)(Code) | | Register as a cache user
|
| resetCachers | | void resetCachers() throws MemoryPermissionException(Code) | | Cause less memory to be used by clearing any optional caches.
exception:
PermissionException - if the current user does not have permission to do this. |
| unregisterCacher | | void unregisterCacher(Cacher cacher)(Code) | | Unregister as a cache user
|
|
|