com.bea.p13n.controls.profile
Interface ProfileControl


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.

See Also
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

getProfileFromRequest

com.bea.p13n.usermgmt.profile.ProfileWrapper getProfileFromRequest(HttpServletRequest request)
Get the existing ProfileWrapper from the request, or return null if none exists.

Parameters
request - the request object
Returns
an initialized ProfileWrapper

userProfileExists

boolean userProfileExists(String username)
                          throws com.bea.p13n.controls.exceptions.P13nControlException
Determine whether the user profile exists

Returns
true if exists, false if not
Throws
com.bea.p13n.controls.exceptions.P13nControlException

createUserProfile

com.bea.p13n.usermgmt.profile.ProfileWrapper createUserProfile(String username)
                                                               throws com.bea.p13n.controls.exceptions.P13nControlException
Create a new user profile

Returns
a new profile wrapper representing the profile for this user.
Throws
com.bea.p13n.controls.exceptions.P13nControlException

getUserProfile

com.bea.p13n.usermgmt.profile.ProfileWrapper getUserProfile(String username)
                                                            throws com.bea.p13n.controls.exceptions.P13nControlException
Access the profile wrapper for this user, if the user profile exists. No successor will be assumed. Use getProfile(username, groupname) if you want the user profile to use the group profile as its successor.

Parameters
username - the username of the profile
Returns
an initialized ProfileWrapper if the user profile exists, null otherwise
Throws
com.bea.p13n.controls.exceptions.P13nControlException - errors are encountered accessing the user profile.

getProfile

com.bea.p13n.usermgmt.profile.ProfileWrapper getProfile(String username,
                                                        String groupname)
                                                        throws com.bea.p13n.controls.exceptions.P13nControlException
Get the profile wrapper for this user, using the group profile as the successor.

This method assumes the profile already exists for the user and group. Neither the username nor groupname can be null.

Parameters
username - the username of the profile. Cannot be null.
groupname - the groupname of the profile. Cannot be null.
Returns
an initialized ProfileWrapper if the user and group profiles exist, null otherwise.
Throws
com.bea.p13n.controls.exceptions.P13nControlException

removeUserProfile

void removeUserProfile(String username)
                       throws com.bea.p13n.controls.exceptions.P13nControlException
Remove this user's profile. If profile does not exist, this method returns with no exceptions. Caller must be in the role of PortalSystemAdminstrator

Throws
com.bea.p13n.controls.exceptions.P13nControlException - if caller is not in allowed role

groupProfileExists

boolean groupProfileExists(String groupname)
                           throws com.bea.p13n.controls.exceptions.P13nControlException
Determine whether the group profile exists

Returns
true if exists, false if not
Throws
com.bea.p13n.controls.exceptions.P13nControlException

createGroupProfile

com.bea.p13n.usermgmt.profile.ProfileWrapper createGroupProfile(String groupname)
                                                                throws com.bea.p13n.controls.exceptions.P13nControlException
Create a new group profile

Returns
a new profile wrapper representing the profile for this group.
Throws
com.bea.p13n.controls.exceptions.P13nControlException

getGroupProfile

com.bea.p13n.usermgmt.profile.ProfileWrapper getGroupProfile(String groupname)
                                                             throws com.bea.p13n.controls.exceptions.P13nControlException
Access the ProfileWrapper for the given groupname, if the group profile exists

Parameters
groupname - the groupname of the profile
Returns
an initialized ProfileWrapper if the group profile exists, null otherwise
Throws
com.bea.p13n.controls.exceptions.P13nControlException - errors are encountered accessing the group profile

getUserProfileManager

com.bea.p13n.usermgmt.profile.ProfileManager getUserProfileManager()
                                                                   throws com.bea.p13n.controls.exceptions.P13nControlException
Returns the UserProfileManager EJB, a stateless session bean used to access profile values. It coordinates successor searches and mapping properties to different datasources.

Returns
The profile manager used for this control
Throws
com.bea.p13n.controls.exceptions.P13nControlException

getUserProfileNames

String[] getUserProfileNames()
                             throws com.bea.p13n.controls.exceptions.P13nControlException
Returns just the users found in the database. Caller must be in the role of PortalSystemAdminstrator

Returns
a list of usernames in the database
Throws
com.bea.p13n.controls.exceptions.P13nControlException - if errors accessing the database, or if caller is not in allowed role

getMisconfiguredUsers

String[] getMisconfiguredUsers()
                               throws com.bea.p13n.controls.exceptions.P13nControlException
Returns the usernames that have profiles, but do not exist in the realm as users. Caller must be in the role of PortalSystemAdminstrator

Returns
the usersnames for the users that are misconfigured
Throws
com.bea.p13n.controls.exceptions.P13nControlException - if user find error, or if caller is not in allowed role

cleanupMisconfiguredUsers

void cleanupMisconfiguredUsers()
                               throws com.bea.p13n.controls.exceptions.P13nControlException
Removes misconfigured users. Caller must be in the role of PortalSystemAdminstrator

Throws
com.bea.p13n.controls.exceptions.P13nControlException - if errors cleaning up users, or if caller is not in allowed role

getGroupProfileManager

com.bea.p13n.usermgmt.profile.ProfileManager getGroupProfileManager()
                                                                    throws com.bea.p13n.controls.exceptions.P13nControlException
Returns the GroupProfileManager EJB, a stateless session bean used to access profile values. It coordinates successor searches and mapping properties to different datasources.

Returns
The profile manager used for this control
Throws
com.bea.p13n.controls.exceptions.P13nControlException

getGroupProfileNames

String[] getGroupProfileNames()
                              throws com.bea.p13n.controls.exceptions.P13nControlException
Returns just the groups found in the database. Caller must be in the role of PortalSystemAdminstrator

Returns
a list of groups in the database
Throws
com.bea.p13n.controls.exceptions.P13nControlException - if errors accessing the database, or if caller is not in allowed role

removeGroupProfile

void removeGroupProfile(String groupname)
                        throws com.bea.p13n.controls.exceptions.P13nControlException
Remove this group's profile. If profile does not exist, this method returns with no exceptions. Caller must be in the role of PortalSystemAdminstrator

Throws
com.bea.p13n.controls.exceptions.P13nControlException - if caller is not in allowed role

getMisconfiguredGroups

String[] getMisconfiguredGroups()
                                throws com.bea.p13n.controls.exceptions.P13nControlException
Returns the group names that have profiles, but do not exist in the realm (no group created). Caller must be in the role of PortalSystemAdminstrator

Returns
the names for the groups that are misconfigured
Throws
com.bea.p13n.controls.exceptions.P13nControlException - if user find error, or if caller is not in allowed role

cleanupMisconfiguredGroups

void cleanupMisconfiguredGroups()
                                throws com.bea.p13n.controls.exceptions.P13nControlException
Removes misconfigured groups. Caller must be in the role of PortalSystemAdminstrator

Throws
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