|
© 2003 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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,
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,
String password,
GroupPortal groupPortal)
Create a visitor user and add to the given group portal's user group |
ProfileWrapper |
createUser(ProfileIdentity user,
String password,
String profileType,
GroupPortal groupPortal)
Create a visitor user and add to the given group portal's user group |
List |
getAllVisitorUserGroups()
Retrieve all visitor user groups Filters out existing group portal users. |
List |
getGroupPortalEligibleVisitorUsers(GroupPortal groupPortal,
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 |
List |
getUsernamesForVisitorUserGroup(GroupPortal groupPortal,
String searchExpression,
int limit)
Retrieve the users for a given user group |
List |
getUsernamesForVisitorUserGroupSubGroups(GroupPortal groupPortal,
String groupName,
String searchExpression,
int limit)
Retrieve the users for a given user group sub groups |
ProfileWrapper |
getUserProfile(ProfileIdentity user,
GroupPortal groupPortal,
PortalIdentifier portalId,
List groupPortals)
Retrieve Profile for a user |
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,
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,
String password,
GroupPortal groupPortal,
PortalIdentifier portalId,
List groupPortals)
Set an end user password |
Methods inherited from interface javax.ejb.EJBObject |
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove |
Method Detail |
public boolean isWritableRealm() throws RemoteException
RemoteException
public void addUserToGroup(ProfileIdentity user, GroupPortal groupPortal) throws RealmNotWritableAddException, RemoteException
user
- the User to addgroupPortal
- the GroupPortal to receive the user
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 usedpublic void removeUserFromGroup(ProfileIdentity user, GroupPortal groupPortal) throws RealmNotWritableRemoveException, RemoteException
user
- the User to remove
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 usedpublic ProfileWrapper createUser(ProfileIdentity user, String password, String profileType, GroupPortal groupPortal) throws UserAlreadyExistsException, InvalidUsernameException, InvalidPasswordException, RealmNotWritableAddException, RemoteException
user
- the user to createpassword
- the user's passwordprofileType
- the user's profile typegroupPortal
- the group portal - used to verify the admin has User Mgmt access
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
InvalidUsernameException
public ProfileWrapper createUser(ProfileIdentity user, String password, GroupPortal groupPortal) throws UserAlreadyExistsException, InvalidUsernameException, InvalidPasswordException, RealmNotWritableAddException, RemoteException
user
- the user to createpassword
- the user's passwordgroupPortal
- the group portal - used to verify the admin has User Mgmt access
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
InvalidUsernameException
public void setPassword(ProfileIdentity user, String password, GroupPortal groupPortal, PortalIdentifier portalId, List groupPortals) throws PrincipalNotExclusivelyManagedByAdminException, InvalidPasswordException, RealmNotWritableAddException, RemoteException
user
- the Userpassword
- the passwordgroupPortal
- the group portal - used to verify the admin has User Mgmt accessportalId
- the PortalIdentifier of the Portal to remove any PA associationsgroupPortals
- all Group Portals for the Portal to remove any GA associations
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 usedpublic void removeUser(ProfileIdentity user, GroupPortal groupPortal, PortalIdentifier portalId, List groupPortals) throws PrincipalNotExclusivelyManagedByAdminException, RealmNotWritableRemoveException, RemoteException
user
- the User to removegroupPortal
- the group portal - used to verify the admin has User Mgmt accessportalId
- the PortalIdentifier of the Portal to remove any PA associationsgroupPortals
- all Group Portals for the Portal to remove any GA associations
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 topublic ProfileWrapper getUserProfile(ProfileIdentity user, GroupPortal groupPortal, PortalIdentifier portalId, List groupPortals) throws ProfileNotFoundException, PrincipalNotExclusivelyManagedByAdminException, RemoteException
user
- the UsergroupPortal
- the group portal - used to verify the admin has User Mgmt accessportalId
- the PortalIdentifier of the Portal to ensure that the user is exclusively managedgroupPortals
- all Group Portals for the Portal to remove
Note: All subsequent setProperty calls must occur on ProfileWrapper
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 topublic ProfileWrapper getGroupProfile(GroupPortal groupPortal) throws ProfileNotFoundException, PrincipalNotExclusivelyManagedByAdminException, RemoteException
groupPortal
- the group portal - used to verify the admin has User Mgmt access
Note: All subsequent setProperty calls must occur on ProfileWrapper
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 topublic List getUsernamesForVisitorUserGroup(GroupPortal groupPortal, String searchExpression, int limit) throws RemoteException
searchExpression
- "*" wildcard is supportedlimit
- limit of number of users to return
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 validpublic List getUsernamesForVisitorUserGroupSubGroups(GroupPortal groupPortal, String groupName, String searchExpression, int limit) throws RemoteException
groupPortal
- the group portal that the user group belongs togroupName
- the user Group Identifier (String)searchExpression
- "*" wildcard is supportedlimit
- limit of number of users to return
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 validpublic List getVisitorUserGroupNamesForUser(ProfileIdentity user) throws RemoteException
user
- the user
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 validpublic List getGroupPortalEligibleVisitorUsers(GroupPortal groupPortal, String searchExpression, int limit) throws RemoteException
groupPortal
- the group portal to filter users forsearchExpression
- "*" wildcard is supportedlimit
- limit of number of users to return
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 validpublic List getAllVisitorUserGroups() throws RemoteException
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 validpublic boolean canAdminManageUser(ProfileIdentity user, ProfileIdentity admin, PortalIdentifier portalId, List groupPortals) throws RemoteException
user
- the visitor useradmin
- the admin userportalId
- the portalgroupPortals
- ALL of the portal's contained group portals (must use ARM.getAllGroupPortals())
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
|
© 2003 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |