|
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 UserInfoControl
This control is used to query information about a particular user, such
as which groups the user belongs to, which roles the user is in, which
roles are available to the user.
Security requirements:
The caller must be in the role of "PortalSystemAdministrator" to invoke
method 'getAllGroupNames()
Method Summary | |
---|---|
void |
authenticate(String username,
String password)
Authenticate a user. |
List<String> |
getAllGroupNames()
Deprecated Use GroupProviderControl.getAllGroupNames() |
String |
getAuthenticatedUserId(HttpServletRequest request)
Get the authenticated user from the request object |
List<String> |
getAvailableUserRoles(HttpServletRequest request)
Get a list of role names that the user is in |
List<String> |
getGroupNamesForUser(String username)
Get a list of groups to which this user belongs This method federated through all readable GroupProviders in default security realm |
List<String> |
getUserGroupNames(HttpServletRequest request)
Get a list of groups to which this user belongs This method federated through all readable GroupProviders in default security realm |
boolean |
isCurrentUserInRole(HttpServletRequest request,
String roleName)
Determine whether this user is allowed in this particular role |
boolean |
isMemberOfGroup(String groupname,
String username)
Determine if a user is a member of a group This method federated through all readable GroupProviders in default security realm |
boolean |
userIsRegistered(HttpServletRequest request)
Determine whether this user is a registered user type |
Method Detail |
---|
void authenticate(String username, String password) throws P13nControlException
username
- the username for the userpassword
- the password for the user
P13nControlException
- if the user is not a valid user or
credentials are incorrectboolean isMemberOfGroup(String groupname, String username) throws P13nControlException
groupname
- the group to queryusername
- the user to look for
P13nControlException
- if exceptions encountered accessing backing GroupProviderList<String> getAllGroupNames() throws P13nControlException
P13nControlException
- if exceptions encountered accessing backing GroupProvider
or if user is not in the role of 'PortalSystemAdministrator' or 'Admin' List<String> getUserGroupNames(HttpServletRequest request) throws P13nControlException
request
- object, which will contain current user name
P13nControlException
- if exceptions encountered accessing backing GroupProviderList<String> getGroupNamesForUser(String username) throws P13nControlException
username
- Current user name
P13nControlException
- if exceptions encountered accessing backing GroupProviderList<String> getAvailableUserRoles(HttpServletRequest request) throws P13nControlException
request
- the HttpServletRequest object
P13nControlException
- if exceptions encountered accessing backing security serviceboolean isCurrentUserInRole(HttpServletRequest request, String roleName) throws P13nControlException
request
- the HttpServletRequest objectroleName
- The name of the role, defined as one of the available Portal roles
P13nControlException
- if remote exceptions encountered accessing backing security serviceboolean userIsRegistered(HttpServletRequest request) throws P13nControlException
request
- the HttpServletRequest object
P13nControlException
- if request is nullString getAuthenticatedUserId(HttpServletRequest request) throws P13nControlException
request
- the HttpServletRequest object
P13nControlException
- if remote exceptions encountered accessing backing security service
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |