org.jasig.portal
Interface IUserIdentityStore

All Known Implementing Classes:

RDBMUserIdentityStore

public interface IUserIdentityStore

Interface for managing creation and removal of User Portal Data

Version:

$Revision: 19776 $ $Date: 2010-01-14 16:17:21 -0600 (Thu, 14 Jan 2010) $

Author:

Susan Bramhall

Method Summary

int	getPortalUID(IPerson person) Returns a unique uPortal key for a user.
int	getPortalUID(IPerson person, boolean createPortalData) Returns a unique uPortal key for a user.
String	getPortalUserName(int uPortalUID) Gets a portal user name that is associated with the specified portal ID.
String	getUsername(IPerson person) Return the username to be used for authorization (exit hook)
void	removePortalUID(int uPortalUID)

Method Detail

getPortalUID

int getPortalUID(IPerson person)
                 throws Exception

Returns a unique uPortal key for a user.

Parameters:

person - the person object

Returns:

uPortalUID number

Throws:

Exception - exception if an error occurs.

getPortalUID

int getPortalUID(IPerson person,
                 boolean createPortalData)
                 throws AuthorizationException

Returns a unique uPortal key for a user. A boolean flag determines whether or not to auto-create data for a new user.

Parameters:

person - person whose portalUID will be returned

createPortalData - indicates whether to try to create all uPortal data for a new user.

Returns:

uPortalUID number or -1 if no user found and unable to create user.

Throws:

AuthorizationException - if createPortalData is false and no user is found or if a sql error is encountered

removePortalUID

void removePortalUID(int uPortalUID)
                     throws Exception

Throws:

Exception

getUsername

String getUsername(IPerson person)

Return the username to be used for authorization (exit hook)

Parameters:

person -

Returns:

usernmae

getPortalUserName

String getPortalUserName(int uPortalUID)

Gets a portal user name that is associated with the specified portal ID.

Parameters:

uPortalUID - The portal ID to find a user name for.

Returns:

The user name associated with the specified portal id, null if one isn't found.

Throws:

Exception - If there are any problems retrieving the user name.