uPortal 2.4.1
API Documentation

org.jasig.portal
Class RDBMUserIdentityStore

java.lang.Object
  extended byorg.jasig.portal.RDBMUserIdentityStore
All Implemented Interfaces:
IUserIdentityStore

public class RDBMUserIdentityStore
extends java.lang.Object
implements IUserIdentityStore

SQL implementation for managing creation and removal of User Portal Data

Author:
Susan Bramhall, Yale University (modify by Julien Marchal, University Nancy 2; Eric Dalquist - edalquist@unicon.net)

Constructor Summary
RDBMUserIdentityStore()
           
 
Method Summary
 int getPortalUID(IPerson person)
          getuPortalUID - return a unique uPortal key for a user.
 int getPortalUID(IPerson person, boolean createPortalData)
          Get the portal user ID for this person object.
 void removePortalUID(int uPortalUID)
          removeuPortalUID
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RDBMUserIdentityStore

public RDBMUserIdentityStore()
Method Detail

getPortalUID

public int getPortalUID(IPerson person)
                 throws java.lang.Exception
getuPortalUID - return a unique uPortal key for a user. calls alternate signature with createPortalData set to false.

Specified by:
getPortalUID in interface IUserIdentityStore
Parameters:
person - the person object
Returns:
uPortalUID number
Throws:
java.lang.Exception - if no user is found.

removePortalUID

public void removePortalUID(int uPortalUID)
                     throws java.lang.Exception
removeuPortalUID

Specified by:
removePortalUID in interface IUserIdentityStore
Parameters:
uPortalUID - integer key to uPortal data for a user
Throws:
java.sql.SQLException - exception if a sql error is encountered
java.lang.Exception

getPortalUID

public int getPortalUID(IPerson person,
                        boolean createPortalData)
                 throws AuthorizationException
Get the portal user ID for this person object.

Specified by:
getPortalUID in interface IUserIdentityStore
Parameters:
person -
createPortalData - indicating whether to try to create all uPortal data for this user from template prototype
Returns:
uPortalUID number or -1 if unable to create user.
Throws:
AuthorizationException - if createPortalData is false and no user is found or if a sql error is encountered

uPortal 2.4.1
API Documentation