ArchivedUserStore (Cilogon parent module 5.6 API)

All Superinterfaces:

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

All Known Implementing Classes:

CILFSArchivedUserStore, CILSQLArchivedUserStore, MemoryArchivedUserStore
```
public interface ArchivedUserStore
extends edu.uiuc.ncsa.security.core.Store<ArchivedUser>
```
Created by Jeff Gaynor
on Jun 22, 2010 at 8:23:03 PM

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
`edu.uiuc.ncsa.security.core.Identifier`	`archiveUser(edu.uiuc.ncsa.security.core.Identifier userId)`	Add a User to the archive.
`List<ArchivedUser>`	`getAllByUserId(edu.uiuc.ncsa.security.core.Identifier userId)`	Get the list of all archived users for a given user (as opposed to archive) id.
`ArchivedUser`	`getLastArchivedUser(edu.uiuc.ncsa.security.core.Identifier userid)`	Convenience method.

Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, 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, register, remove, save, search, search, search, size, update

- Method Detail
  - getAllByUserId
```
List<ArchivedUser> getAllByUserId(edu.uiuc.ncsa.security.core.Identifier userId)
```
    Get the list of all archived users for a given user (as opposed to archive) id. This always returns a list sorted by archive date.
    
    Parameters:
    
    userId -
    
    Returns:
  - archiveUser
```
edu.uiuc.ncsa.security.core.Identifier archiveUser(edu.uiuc.ncsa.security.core.Identifier userId)
```
    Add a User to the archive. This takes the current user as stored (so save any updates before invoking). Returns the id of the archived user entry.
    
    Parameters:
    
    userId -
  - getLastArchivedUser
```
ArchivedUser getLastArchivedUser(edu.uiuc.ncsa.security.core.Identifier userid)
```
    Convenience method. Return the most recently archived user for this id or a null if there is no such user.
    
    Parameters:
    
    userid -
    
    Returns: