Control
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()
Control
, Control
, Serializable
Method Summary |
public void |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public boolean |
|
public boolean |
|
public boolean |
|
Method Detail |
public void authenticate(Authenticate a user. This method is only used to verify a username and password. It does not do anything to "log in" or set the user as the "current" system user.String
username,String
password)
throwsP13nControlException
P13nControlException
DEPRECATED Use GroupProviderControl.getAllGroupNames()
publicGet a List of all group names in the systemList
getAllGroupNames()
throwsP13nControlException
P13nControlException
publicGet the authenticated user from the request objectString
getAuthenticatedUserId(HttpServletRequest
request)
throwsP13nControlException
P13nControlException
publicGet a list of role names that the user is inList
getAvailableUserRoles(HttpServletRequest
request)
throwsP13nControlException
P13nControlException
DEPRECATED Use GroupProviderControl.getGroupNamesForUser(username)
publicGet a list of groups to which this user belongsList
getGroupNamesForUser(String
username)
throwsP13nControlException
P13nControlException
DEPRECATED Use GroupProviderControl.getGroupNamesForUser(username)
publicGet a list of groups to which this user belongsList
getUserGroupNames(HttpServletRequest
request)
throwsP13nControlException
P13nControlException
public boolean isCurrentUserInRole(Determine whether this user is allowed in this particular roleHttpServletRequest
request,String
roleName)
throwsP13nControlException
P13nControlException
DEPRECATED Use GroupProviderControl.getAllGroupNames()
public boolean isMemberOfGroup(Determine if a user is a member of a group.String
groupname,String
username)
throwsP13nControlException
P13nControlException
public boolean userIsRegistered(Determine whether this user is a registered user typeHttpServletRequest
request)
throwsP13nControlException
P13nControlException