|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ControlInterface public interface ProfileControl
Control to create, retrieve, and remove user and group profiles. Access to profile data is provided by ProfileWrapper objects which are obtained through this control. Additionally, a ProfileWrapper is available in every Session, regardless of whether the user is registered. To get the ProfileWrapper from the request, use ProfileControl.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. |
ProfileWrapper |
createGroupProfile(String groupname)
Create a new group profile |
ProfileWrapper |
createUserProfile(String username)
Create a new user profile |
ProfileWrapper |
getGroupProfile(String groupname)
Access the ProfileWrapper for the given groupname, if the group profile exists |
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. |
ProfileWrapper |
getProfile(String username,
String groupname)
Get the profile wrapper for this user, using the group profile as the successor. |
ProfileWrapper |
getProfileFromRequest(javax.servlet.http.HttpServletRequest request)
Get the existing ProfileWrapper from the request, or return null if none exists. |
ProfileWrapper |
getUserProfile(String username)
Access the profile wrapper for this user, if the user profile exists. |
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 |
---|
ProfileWrapper getProfileFromRequest(javax.servlet.http.HttpServletRequest request)
request
- the request object
boolean userProfileExists(String username) throws P13nControlException
P13nControlException
ProfileWrapper createUserProfile(String username) throws P13nControlException
P13nControlException
ProfileWrapper getUserProfile(String username) throws P13nControlException
username
- the username of the profile
P13nControlException
- errors are encountered accessing the user profile.ProfileWrapper getProfile(String username, String groupname) throws 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.
P13nControlException
void removeUserProfile(String username) throws P13nControlException
P13nControlException
- if caller is not in allowed roleboolean groupProfileExists(String groupname) throws P13nControlException
P13nControlException
ProfileWrapper createGroupProfile(String groupname) throws P13nControlException
P13nControlException
ProfileWrapper getGroupProfile(String groupname) throws P13nControlException
groupname
- the groupname of the profile
P13nControlException
- errors are encountered accessing the group profileProfileManager getUserProfileManager() throws P13nControlException
P13nControlException
String[] getUserProfileNames() throws P13nControlException
P13nControlException
- if errors accessing the database, or if caller is
not in allowed roleString[] getMisconfiguredUsers() throws P13nControlException
P13nControlException
- if user find error, or if caller is
not in allowed rolevoid cleanupMisconfiguredUsers() throws P13nControlException
P13nControlException
- if errors cleaning up users, or if caller is
not in allowed roleProfileManager getGroupProfileManager() throws P13nControlException
P13nControlException
String[] getGroupProfileNames() throws P13nControlException
P13nControlException
- if errors accessing the database, or if caller is
not in allowed rolevoid removeGroupProfile(String groupname) throws P13nControlException
P13nControlException
- if caller is not in allowed roleString[] getMisconfiguredGroups() throws P13nControlException
P13nControlException
- if user find error, or if caller is
not in allowed rolevoid cleanupMisconfiguredGroups() throws P13nControlException
P13nControlException
- if errors cleaning up groups, or if caller is
not in allowed role
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |