|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ProfileControl
Control to access and modify the user profile. The methods all use the ProfileWrapper as the object for which the profile will be associated. The ProfileWrapper is available in every Session, regardless of whether the user is registered. To get the ProfileWrapper from the request, use PropertyControl.getProfileFromRequest().
This control is not compatible with the deprecated UserManagerControl and
GroupManagerControl. Instead, use this control with the UserProviderControl and GroupProviderControl.
Security requirements:
Are determined by the settings on the AtnSecurityProviderMBean.
ProfileWrapper
Method Summary | |
---|---|
void |
cleanupMisconfiguredGroups()
Removes misconfigured groups. |
void |
cleanupMisconfiguredUsers()
Removes misconfigured users. |
com.bea.p13n.usermgmt.profile.ProfileWrapper |
createGroupProfile(String groupname)
Create a new group profile |
com.bea.p13n.usermgmt.profile.ProfileWrapper |
createUserProfile(String username)
Create a new user profile |
com.bea.p13n.usermgmt.profile.ProfileWrapper |
getGroupProfile(String groupname)
Access the ProfileWrapper for the given groupname, if the group profile exists |
com.bea.p13n.usermgmt.profile.ProfileManager |
getGroupProfileManager()
Returns the GroupProfileManager EJB, a stateless session bean used to access profile values. |
String[] |
getGroupProfileNames()
Returns just the groups found in the database. |
String[] |
getMisconfiguredGroups()
Returns the group names that have profiles, but do not exist in the realm (no group created). |
String[] |
getMisconfiguredUsers()
Returns the usernames that have profiles, but do not exist in the realm as users. |
com.bea.p13n.usermgmt.profile.ProfileWrapper |
getProfile(String username,
String groupname)
Get the profile wrapper for this user, using the group profile as the successor. |
com.bea.p13n.usermgmt.profile.ProfileWrapper |
getProfileFromRequest(HttpServletRequest request)
Get the existing ProfileWrapper from the request, or return null if none exists. |
com.bea.p13n.usermgmt.profile.ProfileWrapper |
getUserProfile(String username)
Access the profile wrapper for this user, if the user profile exists. |
com.bea.p13n.usermgmt.profile.ProfileManager |
getUserProfileManager()
Returns the UserProfileManager EJB, a stateless session bean used to access profile values. |
String[] |
getUserProfileNames()
Returns just the users found in the database. |
boolean |
groupProfileExists(String groupname)
Determine whether the group profile exists |
void |
removeGroupProfile(String groupname)
Remove this group's profile. |
void |
removeUserProfile(String username)
Remove this user's profile. |
boolean |
userProfileExists(String username)
Determine whether the user profile exists |
Method Detail |
---|
com.bea.p13n.usermgmt.profile.ProfileWrapper getProfileFromRequest(HttpServletRequest request)
request
- the request object
boolean userProfileExists(String username) throws com.bea.p13n.controls.exceptions.P13nControlException
com.bea.p13n.controls.exceptions.P13nControlException
com.bea.p13n.usermgmt.profile.ProfileWrapper createUserProfile(String username) throws com.bea.p13n.controls.exceptions.P13nControlException
com.bea.p13n.controls.exceptions.P13nControlException
com.bea.p13n.usermgmt.profile.ProfileWrapper getUserProfile(String username) throws com.bea.p13n.controls.exceptions.P13nControlException
username
- the username of the profile
com.bea.p13n.controls.exceptions.P13nControlException
- errors are encountered accessing the user profile.com.bea.p13n.usermgmt.profile.ProfileWrapper getProfile(String username, String groupname) throws com.bea.p13n.controls.exceptions.P13nControlException
This method assumes the profile already exists for the user and group. Neither the username nor groupname can be null.
username
- the username of the profile. Cannot be null.groupname
- the groupname of the profile. Cannot be null.
com.bea.p13n.controls.exceptions.P13nControlException
void removeUserProfile(String username) throws com.bea.p13n.controls.exceptions.P13nControlException
com.bea.p13n.controls.exceptions.P13nControlException
- if caller is not in allowed roleboolean groupProfileExists(String groupname) throws com.bea.p13n.controls.exceptions.P13nControlException
com.bea.p13n.controls.exceptions.P13nControlException
com.bea.p13n.usermgmt.profile.ProfileWrapper createGroupProfile(String groupname) throws com.bea.p13n.controls.exceptions.P13nControlException
com.bea.p13n.controls.exceptions.P13nControlException
com.bea.p13n.usermgmt.profile.ProfileWrapper getGroupProfile(String groupname) throws com.bea.p13n.controls.exceptions.P13nControlException
groupname
- the groupname of the profile
com.bea.p13n.controls.exceptions.P13nControlException
- errors are encountered accessing the group profilecom.bea.p13n.usermgmt.profile.ProfileManager getUserProfileManager() throws com.bea.p13n.controls.exceptions.P13nControlException
com.bea.p13n.controls.exceptions.P13nControlException
String[] getUserProfileNames() throws com.bea.p13n.controls.exceptions.P13nControlException
com.bea.p13n.controls.exceptions.P13nControlException
- if errors accessing the database, or if caller is
not in allowed roleString[] getMisconfiguredUsers() throws com.bea.p13n.controls.exceptions.P13nControlException
com.bea.p13n.controls.exceptions.P13nControlException
- if user find error, or if caller is
not in allowed rolevoid cleanupMisconfiguredUsers() throws com.bea.p13n.controls.exceptions.P13nControlException
com.bea.p13n.controls.exceptions.P13nControlException
- if errors cleaning up users, or if caller is
not in allowed rolecom.bea.p13n.usermgmt.profile.ProfileManager getGroupProfileManager() throws com.bea.p13n.controls.exceptions.P13nControlException
com.bea.p13n.controls.exceptions.P13nControlException
String[] getGroupProfileNames() throws com.bea.p13n.controls.exceptions.P13nControlException
com.bea.p13n.controls.exceptions.P13nControlException
- if errors accessing the database, or if caller is
not in allowed rolevoid removeGroupProfile(String groupname) throws com.bea.p13n.controls.exceptions.P13nControlException
com.bea.p13n.controls.exceptions.P13nControlException
- if caller is not in allowed roleString[] getMisconfiguredGroups() throws com.bea.p13n.controls.exceptions.P13nControlException
com.bea.p13n.controls.exceptions.P13nControlException
- if user find error, or if caller is
not in allowed rolevoid cleanupMisconfiguredGroups() throws com.bea.p13n.controls.exceptions.P13nControlException
com.bea.p13n.controls.exceptions.P13nControlException
- if errors cleaning up groups, or if caller is
not in allowed role
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |