Package org.cilogon.oauth2.servlet.storage.user

Class UserFileStore

java.lang.Object

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

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

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

org.cilogon.oauth2.servlet.storage.user.UserFileStore

All Implemented Interfaces:

edu.uiuc.ncsa.security.core.Store<User>, edu.uiuc.ncsa.security.storage.MonitoredStoreInterface<User>, Map<edu.uiuc.ncsa.security.core.Identifier,User>, UserStore

public class UserFileStore
extends edu.uiuc.ncsa.security.storage.monitored.MonitoredFileStore<User>
implements UserStore

Created by Jeff Gaynor
on 3/2/12 at 12:52 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 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
UserFileStore(File storeDirectory, File indexDirectory, edu.uiuc.ncsa.security.core.util.IdentifiableProviderImpl<User> up, edu.uiuc.ncsa.security.storage.data.MapConverter converter, boolean removeEmptyFiles, Incrementable incrementable, boolean removeFailedFiles)
UserFileStore(File file, UserProvider up, edu.uiuc.ncsa.security.storage.data.MapConverter converter, boolean removeEmptyFiles, boolean removeFailedFiles)

Method Summary

Modifier and Type	Method	Description
User	create()
User	create(boolean newIdentifier)	Create a user, optionally with a new serial string.
User	createAndRegisterUser(UserMultiID userMultiKey, String idP, String idPDisplayName, String firstName, String lastName, String email, String affiliation, String displayName, String organizationalUnit)	Create a user from all the given possible information.
User	get(Object key)
Collection<User>	get(UserMultiID userMultiKey, String idP)	The remote user and idp together form a composite key for access.
Incrementable	getIncrementable()
edu.uiuc.ncsa.security.storage.data.MapConverter	getMapConverter()
List<User>	getMostRecent(int n, List<String> attributes)
protected UserProvider	getUP()
edu.uiuc.ncsa.security.core.Identifier	getUserID(UserMultiID userMultiKey, String idP)	Resolves the user id given the remoteUser and IdP.
void	realSave(boolean checkExists, User t)
void	save(User t)
protected String	toIdentifier(String remoteUser, String idp)
protected String	toIdentifier(EduPersonPrincipleName eppn, String idp)
protected String	toIdentifier(EduPersonTargetedID eptid, String idp)
protected String	toIdentifier(OpenIDConnect openIDConnect, String idp)
protected String	toIdentifier(OpenID openID, String idp)
protected String	toIdentifier(PairwiseID pairwiseID, String idp)
protected String	toIdentifier(PersonName remoteUser, String idp)
protected String	toIdentifier(RemoteUserName remoteUser, String idp)
protected String	toIdentifier(SubjectID subjectID, String idp)
void	update(User t)
void	updateCheckSerialString(User user, boolean noNewSerialID)	Save the current user but do not change the serial identifier.

Methods inherited from class edu.uiuc.ncsa.security.storage.monitored.MonitoredFileStore

addLastAccessedEventListener, doUpkeep, doUpkeep, fireLastAccessedEvent, getLastAccessedEventListeners, getUpkeepConfiguration, getUuid, hasUpkeepConfiguration, isMonitorEnabled, lastAccessUpdate, setMonitorEnabled, setUpkeepConfiguration, updateHook

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

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

getAll, getXMLConverter, register, remove, search, search, search, size

Constructor Detail

UserFileStore

public UserFileStore(File file,
                     UserProvider up,
                     edu.uiuc.ncsa.security.storage.data.MapConverter converter,
                     boolean removeEmptyFiles,
                     boolean removeFailedFiles)

UserFileStore

public UserFileStore(File storeDirectory,
                     File indexDirectory,
                     edu.uiuc.ncsa.security.core.util.IdentifiableProviderImpl<User> up,
                     edu.uiuc.ncsa.security.storage.data.MapConverter converter,
                     boolean removeEmptyFiles,
                     Incrementable incrementable,
                     boolean removeFailedFiles)

Method Detail

getIncrementable

public Incrementable getIncrementable()

Specified by:

getIncrementable in interface UserStore

getUP

protected UserProvider getUP()

save

public void save(User t)

Specified by:

save in interface edu.uiuc.ncsa.security.core.Store<User>

Overrides:

save in class edu.uiuc.ncsa.security.storage.FileStore<User>

realSave

public void realSave(boolean checkExists,
                     User t)

Overrides:

realSave in class edu.uiuc.ncsa.security.storage.FileStore<User>

createAndRegisterUser

public User createAndRegisterUser(UserMultiID userMultiKey,
                                  String idP,
                                  String idPDisplayName,
                                  String firstName,
                                  String lastName,
                                  String email,
                                  String affiliation,
                                  String displayName,
                                  String organizationalUnit)

Description copied from interface: UserStore

Create a user from all the given possible information. Some of this might be missing, but the minimal set is the remoteUser and idp. Note that this creates the user uid too AND it registers the user.

Specified by:

createAndRegisterUser in interface UserStore

Returns:

toIdentifier

protected String toIdentifier(EduPersonPrincipleName eppn,
                              String idp)

toIdentifier

protected String toIdentifier(RemoteUserName remoteUser,
                              String idp)

toIdentifier

protected String toIdentifier(PersonName remoteUser,
                              String idp)

toIdentifier

protected String toIdentifier(EduPersonTargetedID eptid,
                              String idp)

toIdentifier

protected String toIdentifier(OpenID openID,
                              String idp)

toIdentifier

protected String toIdentifier(OpenIDConnect openIDConnect,
                              String idp)

toIdentifier

protected String toIdentifier(SubjectID subjectID,
                              String idp)

toIdentifier

protected String toIdentifier(PairwiseID pairwiseID,
                              String idp)

toIdentifier

protected String toIdentifier(String remoteUser,
                              String idp)

get

public Collection<User> get(UserMultiID userMultiKey,
                            String idP)

Description copied from interface: UserStore

The remote user and idp together form a composite key for access. (Our URIs are internally generated unique identifiers and are not used outside of the store).

Specified by:

get in interface UserStore

Returns:

get

public User get(Object key)

Specified by:

get in interface Map<edu.uiuc.ncsa.security.core.Identifier,User>

Overrides:

get in class edu.uiuc.ncsa.security.storage.monitored.MonitoredFileStore<User>

create

public User create(boolean newIdentifier)

Description copied from interface: UserStore

Create a user, optionally with a new serial string. The default behavior for this store is that new users are not created with a new serial identifier (or various operations such as listing users can run through a great many unused identifiers and if they are expensive to create, such as from an SQL database, this might slow down the application noticeably.)

Specified by:

create in interface UserStore

Returns:

create

public User create()

Specified by:

create in interface edu.uiuc.ncsa.security.core.Store<User>

Overrides:

create in class edu.uiuc.ncsa.security.storage.FileStore<User>

getUserID

public edu.uiuc.ncsa.security.core.Identifier getUserID(UserMultiID userMultiKey,
                                                        String idP)

Description copied from interface: UserStore

Resolves the user id given the remoteUser and IdP.

Specified by:

getUserID in interface UserStore

Returns:

updateCheckSerialString

public void updateCheckSerialString(User user,
                                    boolean noNewSerialID)

Description copied from interface: UserStore

Save the current user but do not change the serial identifier. Note that this circumvents the contract for Store.update(edu.uiuc.ncsa.security.core.Identifiable) for this interface, which, because of issue CIL-69 requires it in most cases. This is in effect an internal call that allows for administrative updates. If noNewSerialID = false, then the effect is the same as calling Store.update(Identifiable) and a new serial id is created.

Specified by:

updateCheckSerialString in interface UserStore

update

public void update(User t)

Specified by:

update in interface edu.uiuc.ncsa.security.core.Store<User>

Overrides:

update in class edu.uiuc.ncsa.security.storage.FileStore<User>

getMapConverter

public edu.uiuc.ncsa.security.storage.data.MapConverter getMapConverter()

Specified by:

getMapConverter in interface UserStore

Overrides:

getMapConverter in class edu.uiuc.ncsa.security.storage.FileStore<User>

getMostRecent

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

Specified by:

getMostRecent in interface edu.uiuc.ncsa.security.core.Store<User>

Overrides:

getMostRecent in class edu.uiuc.ncsa.security.storage.monitored.MonitoredFileStore<User>