Package edu.uiuc.ncsa.security.storage.monitored

Class MonitoredFileStore<V extends Identifiable>

java.lang.Object

edu.uiuc.ncsa.security.storage.IndexedStreamStore<V>

edu.uiuc.ncsa.security.storage.FileStore<V>

edu.uiuc.ncsa.security.storage.monitored.MonitoredFileStore<V>

All Implemented Interfaces:

Store<V>, MonitoredStoreInterface<V>, Map<Identifier,V>

public abstract class MonitoredFileStore<V extends Identifiable>
extends FileStore<V>
implements MonitoredStoreInterface<V>

Created by Jeff Gaynor
on 3/29/23 at 10:00 AM

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields inherited from class edu.uiuc.ncsa.security.storage.FileStore

indexDirectory, storageDirectory

Fields inherited from class edu.uiuc.ncsa.security.storage.IndexedStreamStore

converter, identifiableProvider, initializer

Fields inherited from interface edu.uiuc.ncsa.security.core.Store

VERSION_TAG

Constructor Summary

Constructors

Constructor	Description
MonitoredFileStore(File directory, IdentifiableProvider<V> idp, MapConverter<V> cp, boolean removeEmptyFiles, boolean removeFailedFiles)
MonitoredFileStore(File storeDirectory, File indexDirectory, IdentifiableProvider<V> identifiableProvider, MapConverter<V> converter, boolean removeEmptyFiles, boolean removeFailedFiles)

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)
V	get(Object key)	This updates the last accessed listener
List<LastAccessedEventListener>	getLastAccessedEventListeners()
List<V>	getMostRecent(int n, List<String> attributes)
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)

Methods inherited from class edu.uiuc.ncsa.security.storage.FileStore

checkPermissions, clear, containsKey, containsValue, create, createIndexEntry, delete, doSetup, entrySet, getAll, getIndexDirectory, getIndexEntry, getItemFile, getItemFile, getMapConverter, getStorageDirectory, getXMLConverter, keySet, loadByIdentifier, loadFile, loadFromIndex, putAll, realRemove, realSave, register, remove, remove, removeByID, removeIndexEntry, save, search, search, search, search, setIndexDirectory, setStorageDirectory, size, size, toString, update, update, values

Methods inherited from class edu.uiuc.ncsa.security.storage.IndexedStreamStore

createIndexEntry, getCreatedItems, hashString, isEmpty, loadStream, put, put

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

MonitoredFileStore

public MonitoredFileStore(File storeDirectory,
                          File indexDirectory,
                          IdentifiableProvider<V> identifiableProvider,
                          MapConverter<V> converter,
                          boolean removeEmptyFiles,
                          boolean removeFailedFiles)

MonitoredFileStore

public MonitoredFileStore(File directory,
                          IdentifiableProvider<V> idp,
                          MapConverter<V> cp,
                          boolean removeEmptyFiles,
                          boolean removeFailedFiles)

Method Detail

getMostRecent

public List<V> getMostRecent(int n,
                             List<String> attributes)

Specified by:

getMostRecent in interface Store<V extends Identifiable>

getLastAccessedEventListeners

public List<LastAccessedEventListener> getLastAccessedEventListeners()

Specified by:

getLastAccessedEventListeners in interface MonitoredStoreInterface<V extends Identifiable>

getUuid

public UUID getUuid()

Specified by:

getUuid in interface MonitoredStoreInterface<V extends Identifiable>

addLastAccessedEventListener

public void addLastAccessedEventListener(LastAccessedEventListener lastAccessedEventListener)

Specified by:

addLastAccessedEventListener in interface MonitoredStoreInterface<V extends Identifiable>

fireLastAccessedEvent

public void fireLastAccessedEvent(MonitoredStoreInterface store,
                                  Identifier identifier)

Specified by:

fireLastAccessedEvent in interface MonitoredStoreInterface<V extends Identifiable>

isMonitorEnabled

public boolean isMonitorEnabled()

Description copied from interface: MonitoredStoreInterface

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

Specified by:

isMonitorEnabled in interface MonitoredStoreInterface<V extends Identifiable>

Returns:

setMonitorEnabled

public void setMonitorEnabled(boolean x)

Specified by:

setMonitorEnabled in interface MonitoredStoreInterface<V extends Identifiable>

lastAccessUpdate

public void lastAccessUpdate(IDMap idMap)

Specified by:

lastAccessUpdate in interface MonitoredStoreInterface<V extends Identifiable>

get

public V get(Object key)

Description copied from class: FileStore

This updates the last accessed listener

Specified by:

get in interface Map<Identifier,V extends Identifiable>

Overrides:

get in class FileStore<V extends Identifiable>

setUpkeepConfiguration

public void setUpkeepConfiguration(UpkeepConfiguration upkeepConfiguration)

Specified by:

setUpkeepConfiguration in interface MonitoredStoreInterface<V extends Identifiable>

getUpkeepConfiguration

public UpkeepConfiguration getUpkeepConfiguration()

Specified by:

getUpkeepConfiguration in interface MonitoredStoreInterface<V extends Identifiable>

doUpkeep

public UpkeepResponse doUpkeep(AbstractEnvironment environment)

Description copied from interface: MonitoredStoreInterface

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.

Specified by:

doUpkeep in interface MonitoredStoreInterface<V extends Identifiable>

Returns:

doUpkeep

public UpkeepResponse doUpkeep(UpkeepConfiguration upkeepConfiguration,
                               AbstractEnvironment environment)

Specified by:

doUpkeep in interface MonitoredStoreInterface<V extends Identifiable>

updateHook

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

Specified by:

updateHook in interface MonitoredStoreInterface<V extends Identifiable>

hasUpkeepConfiguration

public boolean hasUpkeepConfiguration()

Specified by:

hasUpkeepConfiguration in interface MonitoredStoreInterface<V extends Identifiable>