com.sssw.fw.usermgr.api
Interface EbiUserDelegate

All Superinterfaces:

EbiDelegate

public interface EbiUserDelegate

extends EbiDelegate

User Delegate that is Provided as a facade to access user personalized attributes related information either from the local user manager or through EJB api provided by the user service.

Fields inherited from interface com.sssw.fw.api.EbiDelegate

SERVICE_LOCAL, SERVICE_REMOTE

Method Summary

EbiUserInfo	createUser(EbiContext context) Creates personalize account for the authenticated user in the security context.
boolean	createUser(EbiContext ctx, EbiUserInfo userInfo) Creates user info/user profile info for a new user.
EbiUserInfo	createUserInfo() Gets a new user info object for use in user creation.
int	getTotalUsers(EbiContext context, String realmName) Returns the total number of users that are available for the specified realm.
EbiUserInfo	getUserInfoBySvrPrincipal(EbiContext context) Gets a user info reference for the authenticated principal from provided context.
EbiUserInfo	getUserInfoByUserID(EbiContext context, String userID) Gets a user profile info.
EbiUserInfo	getUserInfoByUserID(EbiContext context, String userID, String realmName) Gets a user profile info.
EbiUserInfo	getUserInfoByUserUUID(EbiContext context, String userIID) Gets a user profile info.
EbiUserInfo[]	getUserList(EbiContext context) Deprecated. EbiUserDelegate.getUserList(EbiContext, String)
EbiUserInfo[]	getUserList(EbiContext context, EbiUserQuery query) Gets a list of user info objects.
EbiUserInfo[]	getUserList(EbiContext ctx, String realmName) Gets a list of user info objects.
boolean	isBaseAttrSynched(EbiContext ctx) Determines if user base attributes are synchronized with a directory.
boolean	isValidUserID(EbiContext context, String userID) Determines if the userID is valid.
boolean	modifyUser(EbiContext context, EbiUserInfo userInfo) Modifies user info for an existing user.
boolean	removeUser(EbiContext context, String userIID) Remove a user.
boolean	removeUser(EbiContext ctx, String userID, String realmName) Remove a user.
int	synchBaseAttributes(EbiContext ctx) Synchronizes user base attributes with a directory server Base attributes include FirstName, LastName and EmailAddress.

Methods implemented from interface com.sssw.fw.api.EbiDelegate

getName

Method Detail

createUserInfo

public EbiUserInfo createUserInfo()
                           throws EboUnrecoverableSystemException,
                                  EboSecurityException

Gets a new user info object for use in user creation.

Returns:

a new EbiUserInfo object.

getUserInfoBySvrPrincipal

public EbiUserInfo getUserInfoBySvrPrincipal(EbiContext context)
                                      throws EboUnrecoverableSystemException,
                                             EboSecurityException

Gets a user info reference for the authenticated principal from provided context.

Parameters:

context - an EbiContext object.

Returns:

an EbiUserInfo object.

isValidUserID

public boolean isValidUserID(EbiContext context,
                             String userID)
                      throws EboUnrecoverableSystemException,
                             EboSecurityException

Determines if the userID is valid.

Parameters:

context - an EbiContext object.

UserID - a user ID

Returns:

true if the user specified by the user ID exists, false otherwise.

See Also:

EbiRealm.isValidUserID(String userID)

getUserInfoByUserID

public EbiUserInfo getUserInfoByUserID(EbiContext context,
                                       String userID)
                                throws EboUnrecoverableSystemException,
                                       EboSecurityException

Gets a user profile info. (only portal administrators or user him/herself can access the user profile.)

Parameters:

context - an EbiContext object.

userID - a user ID.

Returns:

an EbiUserInfo object.

getUserInfoByUserID

public EbiUserInfo getUserInfoByUserID(EbiContext context,
                                       String userID,
                                       String realmName)
                                throws EboUnrecoverableSystemException,
                                       EboSecurityException

Gets a user profile info. (only portal administrators or user him/herself can access the user profile.)

Parameters:

context - an EbiContext object.

userID - a user ID.

realmName - a realm name.

Returns:

an EbiUserInfo object for the user in the specified realm.

getUserInfoByUserUUID

public EbiUserInfo getUserInfoByUserUUID(EbiContext context,
                                         String userIID)
                                  throws EboUnrecoverableSystemException,
                                         EboSecurityException

Gets a user profile info. (only portal administrators or user him/herself can access the user profile.)

Parameters:

context - an EbiContext object.

userIID - a user UUID.

Returns:

an EbiUserInfo object.

getUserList

public EbiUserInfo[] getUserList(EbiContext context,
                                 EbiUserQuery query)
                          throws EboUnrecoverableSystemException,
                                 EboSecurityException

Gets a list of user info objects.

This method checks READ permission of PortalSystemAdmin.

Parameters:

context - an EbiContext object.

query - an EbiUserQuery object that contains the search criteria.

Returns:

a list of EbiUserInfo objects from the search result.

getUserList

public EbiUserInfo[] getUserList(EbiContext ctx,
                                 String realmName)
                          throws EboUnrecoverableSystemException,
                                 EboSecurityException

Gets a list of user info objects.

Parameters:

ctx - an EboContext object.

realmName - a realm name.

Returns:

a list EbiUserInfo objects for a specified realm. (Only gets UserID and UserIIDs)

getUserList

public EbiUserInfo[] getUserList(EbiContext context)
                          throws EboUnrecoverableSystemException,
                                 EboSecurityException

Deprecated. EbiUserDelegate.getUserList(EbiContext, String)

Gets a list of user info objects.

Parameters:

context - an EbiContext object.

Returns:

a list EbiUserInfo objects. (only gets UserID and UserIID atributes)

getTotalUsers

public int getTotalUsers(EbiContext context,
                         String realmName)
                  throws EboUnrecoverableSystemException,
                         EboSecurityException

Returns the total number of users that are available for the specified realm.

Parameters:

context - an EbiContext object.

realmName - a realm name.

Returns:

an integer representing the total number of users for the realm.

createUser

public EbiUserInfo createUser(EbiContext context)
                       throws EboUnrecoverableSystemException,
                              EboSecurityException

Creates personalize account for the authenticated user in the security context. This method adds a user info and also store it in the current session.

Parameters:

ctx - an EbiContext object

Returns:

the EbiUserInfo ojbect if the user personalize account for the authenticated user is created successfully. (creates both EboUserInfo and EboUserProfileInfo for the user)

createUser

public boolean createUser(EbiContext ctx,
                          EbiUserInfo userInfo)
                   throws EboUnrecoverableSystemException,
                          EboSecurityException

Creates user info/user profile info for a new user. This method adds a user info and also add the default user profile info.

Parameters:

ctx - an EbiContext object

usrInfo - an EbiUserInfo object for the new user.

Returns:

true if the new user is created successfully.

modifyUser

public boolean modifyUser(EbiContext context,
                          EbiUserInfo userInfo)
                   throws EboUnrecoverableSystemException,
                          EboSecurityException

Modifies user info for an existing user.

Parameters:

context - an EbiContext object.

userInfo - an EbiUserInfo object for the specified user.

Returns:

true if the specified user is modified successfully.

removeUser

public boolean removeUser(EbiContext ctx,
                          String userID,
                          String realmName)
                   throws EboUnrecoverableSystemException,
                          EboSecurityException

Remove a user.

Parameters:

ctx - an EbiContext object.

userID - a user ID.

realmName - (optional) a realm name, if not provided, it will use the primary realm.

Returns:

true if the specified user is removed successfully.

removeUser

public boolean removeUser(EbiContext context,
                          String userIID)
                   throws EboUnrecoverableSystemException,
                          EboSecurityException

Remove a user.

Parameters:

context - an EbiContext object.

userIID - a user IID.

Returns:

true if the specified user is removed successfully.

synchBaseAttributes

public int synchBaseAttributes(EbiContext ctx)
                        throws EboUnrecoverableSystemException,
                               EboSecurityException

Synchronizes user base attributes with a directory server Base attributes include FirstName, LastName and EmailAddress.

Parameters:

ctx - an EbiContext object.

Returns:

a count of how many user elements were modified

isBaseAttrSynched

public boolean isBaseAttrSynched(EbiContext ctx)
                          throws EboUnrecoverableSystemException,
                                 EboSecurityException

Determines if user base attributes are synchronized with a directory. Base attributes include FirstName, LastName and EmailAddress.

Parameters:

ctx - an EbiContext object.

Returns:

whether the user subsystem supports synchronization of base attributes with the directory.