KEStore (OA4MP Parent Project 6.3.3 API)

All Superinterfaces:

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

All Known Implementing Classes:

KEFileStore, KEMemoryStore, KESQLStore
```
public interface KEStore<V extends KERecord>
extends edu.uiuc.ncsa.security.core.Store<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 interface edu.uiuc.ncsa.security.core.Store
  VERSION_TAG

Method Summary

All Methods Instance Methods Abstract Methods
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.

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, getMostRecent, getXMLConverter, keySet, register, register, remove, removeByID, save, save, search, search, search, search, size, update, update, update, updateRS

- Method Detail
  - getByKID
```
KERecord getByKID(String kid)
```
    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.
    
    Parameters:
    
    kid -
    
    Returns:
  - getKIDs
```
HashSet<String> getKIDs()
```
    Get all of the key ids used in this store.
    
    Returns:
  - getCurrentKeys
```
edu.uiuc.ncsa.security.util.jwk.JSONWebKeys getCurrentKeys(VirtualIssuer vi)
```
    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.
    
    Parameters:
    
    vi -
    
    Returns:
  - getCurrentKeys
```
edu.uiuc.ncsa.security.util.jwk.JSONWebKeys getCurrentKeys()
```
    Get all currently active keys.
    
    Returns:
  - getByVI
```
edu.uiuc.ncsa.security.core.util.IdentifiableMap<KERecord> getByVI(VirtualIssuer vi)
```
    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.
    
    Parameters:
    
    vi -
    
    Returns:
  - getByVI
```
edu.uiuc.ncsa.security.core.util.IdentifiableMap<KERecord> getByVI(VirtualIssuer vi,
                                                                   boolean validKeysOnly)
```