com.bea.portal.admin.ejb
Interface VisitorUserManager

public interface VisitorUserManager

extends javax.ejb.EJBObject

Handles all visitor-user admin functionality.

Method Summary

void	addUserToGroup(ProfileIdentity user, GroupPortal groupPortal) Admin adds an end user to a user group
boolean	canAdminManageUser(ProfileIdentity user, ProfileIdentity admin, PortalIdentifier portalId, java.util.List groupPortals) Checks if an admin can manage a particular visitor user - returns true if admin is a System Admin or - if admin is a PA or GA - they have exclusive rights to manage that user
ProfileWrapper	createUser(ProfileIdentity user, java.lang.String password, GroupPortal groupPortal) Create a visitor user and add to the given group portal's user group
ProfileWrapper	createUser(ProfileIdentity user, java.lang.String password, java.lang.String profileType, GroupPortal groupPortal) Create a visitor user and add to the given group portal's user group
java.util.List	getAllVisitorUserGroups() Retrieve all visitor user groups Filters out existing group portal users.
java.util.List	getGroupPortalEligibleVisitorUsers(GroupPortal groupPortal, java.lang.String searchExpression, int limit) Retrieve all visitor users with the intention of adding them to a group portal.
ProfileWrapper	getGroupProfile(GroupPortal groupPortal) Retrieve Profile for a user
java.util.List	getUsernamesForVisitorUserGroup(GroupPortal groupPortal, java.lang.String searchExpression, int limit) Retrieve the users for a given user group
java.util.List	getUsernamesForVisitorUserGroupSubGroups(GroupPortal groupPortal, java.lang.String groupName, java.lang.String searchExpression, int limit) Retrieve the users for a given user group sub groups
ProfileWrapper	getUserProfile(ProfileIdentity user, GroupPortal groupPortal, PortalIdentifier portalId, java.util.List groupPortals) Retrieve Profile for a user
java.util.List	getVisitorUserGroupNamesForUser(ProfileIdentity user) Retrieve the group names for a given user
boolean	isWritableRealm() Checks if the underlying user realm is writable or not
void	removeUser(ProfileIdentity user, GroupPortal groupPortal, PortalIdentifier portalId, java.util.List groupPortals) Removes an end user
void	removeUserFromGroup(ProfileIdentity user, GroupPortal groupPortal) Admin removes an end user from a user group
void	setPassword(ProfileIdentity user, java.lang.String password, GroupPortal groupPortal, PortalIdentifier portalId, java.util.List groupPortals) Set an end user password

Methods inherited from interface javax.ejb.EJBObject

getEJBHome, getHandle, getPrimaryKey, isIdentical, remove

Method Detail

isWritableRealm

public boolean isWritableRealm()
                        throws java.rmi.RemoteException

Checks if the underlying user realm is writable or not

Returns:

true if realm is writable

addUserToGroup

public void addUserToGroup(ProfileIdentity user,
                           GroupPortal groupPortal)
                    throws RealmNotWritableAddException,
                           java.rmi.RemoteException

Admin adds an end user to a user group

Parameters:

user - the User to add

groupPortal - the GroupPortal to receive the user

Throws:

java.rmi.RemoteException - because of EJB contract

RealmNotWritableAddException - thrown if the underlying realm is not writable (ie. LDAP)

VisitorUserSystemException - if there is a system exception

DelegatedAdminSecurityException - if the caller does not have sufficient rights to perform this action

IllegalArgumentException - if the arguments are not valid

OperationUnsupportedException - thrown if an Unmanageable Realm (LDAP, for example) is being used

removeUserFromGroup

public void removeUserFromGroup(ProfileIdentity user,
                                GroupPortal groupPortal)
                         throws RealmNotWritableRemoveException,
                                java.rmi.RemoteException

Admin removes an end user from a user group

Parameters:

user - the User to remove

group - the Group to remove the User from

Throws:

java.rmi.RemoteException - because of EJB contract

RealmNotWritableRemoveException - thrown if the underlying realm is not writable (ie. LDAP)

VisitorUserSystemException - if there is a system exception

DelegatedAdminSecurityException - if the caller does not have sufficient rights to perform this action

IllegalArgumentException - if the arguments are not valid

OperationUnsupportedException - thrown if an Unmanageable Realm (LDAP, for example) is being used

createUser

public ProfileWrapper createUser(ProfileIdentity user,
                                 java.lang.String password,
                                 java.lang.String profileType,
                                 GroupPortal groupPortal)
                          throws UserAlreadyExistsException,
                                 InvalidUsernameException,
                                 InvalidPasswordException,
                                 RealmNotWritableAddException,
                                 java.rmi.RemoteException

Create a visitor user and add to the given group portal's user group

Parameters:

user - the user to create

password - the user's password

profileType - the user's profile type

groupPortal - the group portal - used to verify the admin has User Mgmt access

Returns:

ProfileWrapper

Throws:

java.rmi.RemoteException - because of EJB contract

RealmNotWritableAddException - thrown if the underlying realm is not writable (ie. LDAP)

VisitorUserSystemException - if there is a system exception

UserAlreadyExistsException - if the user already exists

InvalidUserNameException - if the user name is invalid

InvalidPasswordException - if the password is invalid

DelegatedAdminSecurityException - if the caller does not have sufficient rights to perform this action

IllegalArgumentException - if the arguments are not valid

OperationUnsupportedException - thrown if an Unmanageable Realm (LDAP, for example) is being used

createUser

public ProfileWrapper createUser(ProfileIdentity user,
                                 java.lang.String password,
                                 GroupPortal groupPortal)
                          throws UserAlreadyExistsException,
                                 InvalidUsernameException,
                                 InvalidPasswordException,
                                 RealmNotWritableAddException,
                                 java.rmi.RemoteException

Create a visitor user and add to the given group portal's user group

Parameters:

user - the user to create

password - the user's password

groupPortal - the group portal - used to verify the admin has User Mgmt access

Returns:

ProfileWrapper

Throws:

java.rmi.RemoteException - because of EJB contract

RealmNotWritableAddException - thrown if the underlying realm is not writable (ie. LDAP)

VisitorUserSystemException - if there is a system exception

UserAlreadyExistsException - if the user already exists

InvalidUserNameException - if the user name is invalid

InvalidPasswordException - if the password is invalid

DelegatedAdminSecurityException - if the caller does not have sufficient rights to perform this action

IllegalArgumentException - if the arguments are not valid

OperationUnsupportedException - thrown if an Unmanageable Realm (LDAP, for example) is being used

setPassword

public void setPassword(ProfileIdentity user,
                        java.lang.String password,
                        GroupPortal groupPortal,
                        PortalIdentifier portalId,
                        java.util.List groupPortals)
                 throws PrincipalNotExclusivelyManagedByAdminException,
                        InvalidPasswordException,
                        RealmNotWritableAddException,
                        java.rmi.RemoteException

Set an end user password

Parameters:

user - the User

password - the password

groupPortal - the group portal - used to verify the admin has User Mgmt access

portalId - the PortalIdentifier of the Portal to remove any PA associations

groupPortals - all Group Portals for the Portal to remove any GA associations

Throws:

java.rmi.RemoteException - because of EJB contract

RealmNotWritableAddException - thrown if the underlying realm is not writable (ie. LDAP)

VisitorUserSystemException - if there is a system exception

DelegatedAdminSecurityException - if the caller does not have sufficient rights to perform this action

InvalidPasswordException - if the password is invalid

IllegalArgumentException - if the arguments are not valid

PrincipalNotExclusivelyManagedByAdminException - thrown if the user is part of another Portal or Group Portal

OperationUnsupportedException - thrown if an Unmanageable Realm (LDAP, for example) is being used

removeUser

public void removeUser(ProfileIdentity user,
                       GroupPortal groupPortal,
                       PortalIdentifier portalId,
                       java.util.List groupPortals)
                throws PrincipalNotExclusivelyManagedByAdminException,
                       RealmNotWritableRemoveException,
                       java.rmi.RemoteException

Removes an end user

Parameters:

user - the User to remove

groupPortal - the group portal - used to verify the admin has User Mgmt access

portalId - the PortalIdentifier of the Portal to remove any PA associations

groupPortals - all Group Portals for the Portal to remove any GA associations

Throws:

java.rmi.RemoteException - because of EJB contract

RealmNotWritableRemoveException - thrown if the underlying realm is not writable (ie. LDAP)

VisitorUserSystemException - if there is a system exception

DelegatedAdminSecurityException - if the caller does not have sufficient rights to perform this action

IllegalArgumentException - if the arguments are not valid

PrincipalNotExclusivelyManagedByAdminException - thrown if the user is part of another Portal or Group Portal that the admin does not have access to

getUserProfile

public ProfileWrapper getUserProfile(ProfileIdentity user,
                                     GroupPortal groupPortal,
                                     PortalIdentifier portalId,
                                     java.util.List groupPortals)
                              throws ProfileNotFoundException,
                                     PrincipalNotExclusivelyManagedByAdminException,
                                     java.rmi.RemoteException

Retrieve Profile for a user

Parameters:

user - the User

groupPortal - the group portal - used to verify the admin has User Mgmt access

portalId - the PortalIdentifier of the Portal to ensure that the user is exclusively managed

groupPortals - all Group Portals for the Portal to remove Note: All subsequent setProperty calls must occur on ProfileWrapper

Returns:

ProfileWrapper

Throws:

java.rmi.RemoteException - because of EJB contract

VisitorUserSystemException - if there is a system exception

DelegatedAdminSecurityException - if the caller does not have sufficient rights to perform this action

ProfileNotFoundException - if the profile is not found

IllegalArgumentException - if the arguments are not valid

PrincipalNotExclusivelyManagedByAdminException - thrown if the user is part of another Portal or Group Portal that the admin does not have access to

getGroupProfile

public ProfileWrapper getGroupProfile(GroupPortal groupPortal)
                               throws ProfileNotFoundException,
                                      PrincipalNotExclusivelyManagedByAdminException,
                                      java.rmi.RemoteException

Retrieve Profile for a user

Parameters:

groupPortal - the group portal - used to verify the admin has User Mgmt access Note: All subsequent setProperty calls must occur on ProfileWrapper

Returns:

ProfileWrapper

Throws:

java.rmi.RemoteException - because of EJB contract

VisitorUserSystemException - if there is a system exception

DelegatedAdminSecurityException - if the caller does not have sufficient rights to perform this action

ProfileNotFoundException - if the profile is not found

IllegalArgumentException - if the arguments are not valid

PrincipalNotExclusivelyManagedByAdminException - thrown if the user is part of another Portal or Group Portal that the admin does not have access to

getUsernamesForVisitorUserGroup

public java.util.List getUsernamesForVisitorUserGroup(GroupPortal groupPortal,
                                                      java.lang.String searchExpression,
                                                      int limit)
                                               throws java.rmi.RemoteException

Retrieve the users for a given user group

Parameters:

groupName - the user Group Identifier (String)

searchExpression - "*" wildcard is supported

limit - limit of number of users to return

Returns:

List of usernames (Strings) in this group

Throws:

java.rmi.RemoteException - because of EJB contract

VisitorUserSystemException - if there is a system exception

DelegatedAdminSecurityException - if the caller does not have sufficient rights to perform this action

IllegalArgumentException - if the arguments are not valid

getUsernamesForVisitorUserGroupSubGroups

public java.util.List getUsernamesForVisitorUserGroupSubGroups(GroupPortal groupPortal,
                                                               java.lang.String groupName,
                                                               java.lang.String searchExpression,
                                                               int limit)
                                                        throws java.rmi.RemoteException

Retrieve the users for a given user group sub groups

Parameters:

groupPortal - the group portal that the user group belongs to

groupName - the user Group Identifier (String)

searchExpression - "*" wildcard is supported

limit - limit of number of users to return

Returns:

List of usernames (Strings) in this group

Throws:

java.rmi.RemoteException - because of EJB contract

VisitorUserSystemException - if there is a system exception

DelegatedAdminSecurityException - if the caller does not have sufficient rights to perform this action

IllegalArgumentException - if the arguments are not valid

getVisitorUserGroupNamesForUser

public java.util.List getVisitorUserGroupNamesForUser(ProfileIdentity user)
                                               throws java.rmi.RemoteException

Retrieve the group names for a given user

Parameters:

user - the user

Returns:

List of groupnames (Strings) in this user

Throws:

java.rmi.RemoteException - because of EJB contract

VisitorUserSystemException - if there is a system exception

DelegatedAdminSecurityException - if the caller does not have sufficient rights to perform this action

IllegalArgumentException - if the arguments are not valid

getGroupPortalEligibleVisitorUsers

public java.util.List getGroupPortalEligibleVisitorUsers(GroupPortal groupPortal,
                                                         java.lang.String searchExpression,
                                                         int limit)
                                                  throws java.rmi.RemoteException

Retrieve all visitor users with the intention of adding them to a group portal. Filters out existing group portal users.

Parameters:

groupPortal - the group portal to filter users for

searchExpression - "*" wildcard is supported

limit - limit of number of users to return

Returns:

List of usernames (Strings)

Throws:

java.rmi.RemoteException - because of EJB contract

VisitorUserSystemException - if there is a system exception

DelegatedAdminSecurityException - if the caller does not have sufficient rights to perform this action

IllegalArgumentException - if the arguments are not valid

getAllVisitorUserGroups

public java.util.List getAllVisitorUserGroups()
                                       throws java.rmi.RemoteException

Retrieve all visitor user groups Filters out existing group portal users.

Returns:

List of user groups (Strings)

Throws:

java.rmi.RemoteException - because of EJB contract

VisitorUserSystemException - if there is a system exception

DelegatedAdminSecurityException - if the caller does not have sufficient rights to perform this action

IllegalArgumentException - if the arguments are not valid

canAdminManageUser

public boolean canAdminManageUser(ProfileIdentity user,
                                  ProfileIdentity admin,
                                  PortalIdentifier portalId,
                                  java.util.List groupPortals)
                           throws java.rmi.RemoteException

Checks if an admin can manage a particular visitor user - returns true if admin is a System Admin or - if admin is a PA or GA - they have exclusive rights to manage that user

Parameters:

user - the visitor user

admin - the admin user

portalId - the portal

groupPortals - ALL of the portal's contained group portals (must use ARM.getAllGroupPortals())

Returns:

true if admin can manage the user

Throws:

java.rmi.RemoteException - because of EJB contract

VisitorUserSystemException - if there is a system exception

DelegatedAdminSecurityException - if the caller does not have sufficient rights to perform this action

IllegalArgumentException - if the arguments are not valid