Package edu.uiuc.ncsa.security.storage

Interface MonitoredStoreInterface<V extends Identifiable>

All Known Implementing Classes:

MonitoredFileStore, MonitoredMemoryStore, MonitoredSQLStore, MonitoredStoreDelegate

public interface MonitoredStoreInterface<V extends Identifiable>

Part of the event mechanism for tracking the last access time of store objects. This is used in OA4MP but has to be here for Java package visibility.

Created by Jeff Gaynor
on 3/29/23 at 7:19 AM

Method Summary

Modifier and Type	Method	Description
void	addLastAccessedEventListener(LastAccessedEventListener lastAccessedEventListener)
UpkeepResponse	doUpkeep(AbstractEnvironment environment)	Do the upkeep.
UpkeepResponse	doUpkeep(UpkeepConfiguration upkeepConfiguration, AbstractEnvironment environment)
void	fireLastAccessedEvent(MonitoredStoreInterface store, Identifier identifier)
List<LastAccessedEventListener>	getLastAccessedEventListeners()
UpkeepConfiguration	getUpkeepConfiguration()
UUID	getUuid()
boolean	hasUpkeepConfiguration()
boolean	isMonitorEnabled()	Generally this is enabled, except in things like the CLI where you do not want to monitor access to clients or whatever.
void	lastAccessUpdate(IDMap idMap)
void	setMonitorEnabled(boolean x)
void	setUpkeepConfiguration(UpkeepConfiguration upkeepConfiguration)
long	updateHook(String action, AbstractEnvironment environment, List<Identifier> identifiers)

Method Detail

getLastAccessedEventListeners

List<LastAccessedEventListener> getLastAccessedEventListeners()

getUuid

UUID getUuid()

addLastAccessedEventListener

void addLastAccessedEventListener(LastAccessedEventListener lastAccessedEventListener)

fireLastAccessedEvent

void fireLastAccessedEvent(MonitoredStoreInterface store,
                           Identifier identifier)

lastAccessUpdate

void lastAccessUpdate(IDMap idMap)

isMonitorEnabled

boolean isMonitorEnabled()

Generally this is enabled, except in things like the CLI where you do not want to monitor access to clients or whatever.

Returns:

setMonitorEnabled

void setMonitorEnabled(boolean x)

setUpkeepConfiguration

void setUpkeepConfiguration(UpkeepConfiguration upkeepConfiguration)

getUpkeepConfiguration

UpkeepConfiguration getUpkeepConfiguration()

hasUpkeepConfiguration

boolean hasUpkeepConfiguration()

doUpkeep

UpkeepResponse doUpkeep(AbstractEnvironment environment)

Do the upkeep. Note that some stores may have to update other stores. The environment allows for this. E.g. Deleting a client should delete its approval record and remove any permissions associated with it.

Parameters:

environment -

Returns:

doUpkeep

UpkeepResponse doUpkeep(UpkeepConfiguration upkeepConfiguration,
                        AbstractEnvironment environment)

updateHook

long updateHook(String action,
                AbstractEnvironment environment,
                List<Identifier> identifiers)