Package org.oa4mp.server.loader.oauth2.storage.keys

Class KEFileStore<V extends KERecord>

java.lang.Object

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

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

org.oa4mp.server.loader.oauth2.storage.keys.KEFileStore<V>

All Implemented Interfaces:

edu.uiuc.ncsa.security.core.Store<V>, Map<edu.uiuc.ncsa.security.core.Identifier,V>, KEStore<V>

public class KEFileStore<V extends KERecord>
extends edu.uiuc.ncsa.security.storage.FileStore<V>
implements KEStore<V>

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
KEFileStore(File directory, edu.uiuc.ncsa.security.core.IdentifiableProvider<V> idp, edu.uiuc.ncsa.security.storage.data.MapConverter<V> cp, boolean removeEmptyFiles, boolean removeFailedFiles)
KEFileStore(File storeDirectory, File indexDirectory, edu.uiuc.ncsa.security.core.IdentifiableProvider<V> identifiableProvider, edu.uiuc.ncsa.security.storage.data.MapConverter<V> converter, boolean removeEmptyFiles, boolean removeFailedFiles)

Method Summary

Modifier and Type	Method	Description
KERecord	getByKID(String kid)	For a given key id (kid) find an return.
edu.uiuc.ncsa.security.core.util.IdentifiableMap<KERecord>	getByVI(VirtualIssuer vi)	Return valid Key Records for a given virtual issuer.
edu.uiuc.ncsa.security.core.util.IdentifiableMap<KERecord>	getByVI(VirtualIssuer vi, boolean validKeysOnly)
edu.uiuc.ncsa.security.util.jwk.JSONWebKeys	getCurrentKeys()	Get all currently active keys.
edu.uiuc.ncsa.security.util.jwk.JSONWebKeys	getCurrentKeys(VirtualIssuer vi)	Gets the currently active keys for a given virtual issuer.
HashSet<String>	getKIDs()	Get all of the key ids used in this store.
List<V>	getMostRecent(int n, List<String> attributes)
KEConverter<V>	getXMLConverter()

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

checkPermissions, clear, containsKey, containsValue, create, createIndexEntry, delete, doSetup, entrySet, get, getAll, getIndexDirectory, getIndexEntry, getItemFile, getItemFile, getMapConverter, getStorageDirectory, keySet, loadByIdentifier, loadFile, loadFromIndex, putAll, realRemove, realSave, register, register, remove, remove, removeByID, removeIndexEntry, save, save, search, search, search, search, setIndexDirectory, setStorageDirectory, size, size, toString, update, update, update, updateRS, 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

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

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

create, getAll, keySet, register, register, remove, removeByID, save, save, search, search, search, search, size, update, update, update, updateRS

Constructor Detail

KEFileStore

public KEFileStore(File storeDirectory,
                   File indexDirectory,
                   edu.uiuc.ncsa.security.core.IdentifiableProvider<V> identifiableProvider,
                   edu.uiuc.ncsa.security.storage.data.MapConverter<V> converter,
                   boolean removeEmptyFiles,
                   boolean removeFailedFiles)

KEFileStore

public KEFileStore(File directory,
                   edu.uiuc.ncsa.security.core.IdentifiableProvider<V> idp,
                   edu.uiuc.ncsa.security.storage.data.MapConverter<V> cp,
                   boolean removeEmptyFiles,
                   boolean removeFailedFiles)

Method Detail

getXMLConverter

public KEConverter<V> getXMLConverter()

Specified by:

getXMLConverter in interface edu.uiuc.ncsa.security.core.Store<V extends KERecord>

Overrides:

getXMLConverter in class edu.uiuc.ncsa.security.storage.FileStore<V extends KERecord>

getMostRecent

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

Specified by:

getMostRecent in interface edu.uiuc.ncsa.security.core.Store<V extends KERecord>

getByKID

public KERecord getByKID(String kid)

Description copied from interface: KEStore

For a given key id (kid) find an return. Key ids are unique in the database. This may be null if there is no such KERecord.

Specified by:

getByKID in interface KEStore<V extends KERecord>

Returns:

getKIDs

public HashSet<String> getKIDs()

Description copied from interface: KEStore

Get all of the key ids used in this store.

Specified by:

getKIDs in interface KEStore<V extends KERecord>

Returns:

getCurrentKeys

public edu.uiuc.ncsa.security.util.jwk.JSONWebKeys getCurrentKeys(VirtualIssuer vi)

Description copied from interface: KEStore

Gets the currently active keys for a given virtual issuer. Note that the virtual issuer for the server is OA2SE#SERVER_VI_ID. A current key is defined as having not expired and being valid.

Specified by:

getCurrentKeys in interface KEStore<V extends KERecord>

Returns:

getCurrentKeys

public edu.uiuc.ncsa.security.util.jwk.JSONWebKeys getCurrentKeys()

Description copied from interface: KEStore

Get all currently active keys.

Specified by:

getCurrentKeys in interface KEStore<V extends KERecord>

Returns:

getByVI

public edu.uiuc.ncsa.security.core.util.IdentifiableMap<KERecord> getByVI(VirtualIssuer vi)

Description copied from interface: KEStore

Return valid Key Records for a given virtual issuer. This means that they have no expired and are valid. The identifier is the ID of the KERecord.

Specified by:

getByVI in interface KEStore<V extends KERecord>

Returns:

getByVI

public edu.uiuc.ncsa.security.core.util.IdentifiableMap<KERecord> getByVI(VirtualIssuer vi,
                                                                          boolean validKeysOnly)

Specified by:

getByVI in interface KEStore<V extends KERecord>