|
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 GroupProviderControl
This control:
Nested Class Summary | |
---|---|
static interface |
GroupProviderControl.GroupProviderParams
Define the properties for this control. |
Method Summary | |
---|---|
void |
addGroupToGroup(String parentGroup,
String childGroup)
Add a child group to a group Caller must be in the role of PortalSystemAdminstrator |
void |
addUserToGroup(String groupname,
String username)
Add a user to a group. |
ProfileWrapper |
createGroup(String name)
Caller must be in the role of PortalSystemAdminstrator |
List |
getAllGroupNames()
|
List |
getChildGroupNames(String groupname)
Caller must be in the role of PortalSystemAdminstrator Retrieve a list of all children of a group. |
List |
getGroupNamesForUser(String username)
Get a list of groups to which this user belongs |
List |
getParentGroupNames(String groupname)
Retrieve the parents of a group. |
List |
getTopLevelGroupNames()
Retrieve a list of groups that do not have parent groups. |
List |
getUsernamesForGroup(String groupname)
Caller must be in the role of PortalSystemAdminstrator |
List |
getUsernamesForGroupLimited(String groupname,
String searchExpression,
int limit)
Retrieve a list of users in a group, matching the provided wildcard expression Caller must be in the role of PortalSystemAdminstrator |
boolean |
groupExists(String group)
Determines if a group exists in the realm. |
boolean |
isDeletableGroup(String groupName)
Determine if a group can be deleted. |
boolean |
isDescendent(String ancestor,
String descendent)
Determine if one group is a descendent of another. |
boolean |
isMemberOfGroup(String groupname,
String username,
boolean recurse)
Determine if a user is a member of a group. |
void |
removeGroup(String groupname)
Remove a group. |
void |
removeGroupFromGroup(String parentGroup,
String childGroup)
Remove a child group from a group Caller must be in the role of PortalSystemAdminstrator |
void |
removeUserFromGroup(String groupname,
String username)
Remove a user from a group Caller must be in the role of PortalSystemAdminstrator |
Method Detail |
---|
List getParentGroupNames(String groupname) throws OperationNotSupportedException
OperationNotSupportedException
- if authentication provider
implementation does not support this operationList getAllGroupNames() throws OperationNotSupportedException
OperationNotSupportedException
- if authentication provider
implementation does not support this operationList getGroupNamesForUser(String username) throws OperationNotSupportedException
username
- Current user name
OperationNotSupportedException
- if authentication provider
implementation does not support this operationvoid addGroupToGroup(String parentGroup, String childGroup) throws OperationNotSupportedException
parentGroup
- the name of the group to modifychildGroup
- the name of the group to add
OperationNotSupportedException
- if authentication provider
implementation does not support this operationvoid addUserToGroup(String groupname, String username) throws OperationNotSupportedException
groupname
- the name of the group to modifyusername
- the name of the user to add
OperationNotSupportedException
- if authentication provider
implementation does not support this operationProfileWrapper createGroup(String name) throws GroupAlreadyExistsException, InvalidGroupnameException, OperationNotSupportedException, P13nControlException
the
- name of the group to create
GroupAlreadyExistsException
- if the group already exists
InvalidGroupnameException
- if the group name is invalid
OperationNotSupportedException
- if authentication provider
implementation does not support this operation
P13nControlException
- if remote errors occurList getChildGroupNames(String groupname) throws OperationNotSupportedException
groupname
- the group to query
OperationNotSupportedException
- if authentication provider
implementation does not support this operationList getTopLevelGroupNames() throws OperationNotSupportedException
OperationNotSupportedException
- if authentication provider
implementation does not support this operationboolean groupExists(String group) throws OperationNotSupportedException
name
- the group name to check
OperationNotSupportedException
- if authentication provider
implementation does not support this operationboolean isDeletableGroup(String groupName) throws OperationNotSupportedException
OperationNotSupportedException
- if authentication provider
implementation does not support this operationboolean isDescendent(String ancestor, String descendent) throws OperationNotSupportedException
ancestor
- see if the other group is a descendent of this groupdescendent
- see if this is a descendent of the other group
OperationNotSupportedException
- if authentication provider
implementation does not support this operationboolean isMemberOfGroup(String groupname, String username, boolean recurse) throws OperationNotSupportedException
groupname
- the group to queryusername
- the user to look forrecurse
- Extend search to descendents of groupName
OperationNotSupportedException
- if authentication provider
implementation does not support this operationvoid removeGroup(String groupname) throws InvalidGroupnameException, OperationNotSupportedException
the
- name of the group to remove
InvalidGroupnameException
- if the group name is invalid
OperationNotSupportedException
- if authentication provider
implementation does not support this operationvoid removeGroupFromGroup(String parentGroup, String childGroup) throws OperationNotSupportedException
parentGroup
- the name of the group to modifychildGroup
- the name of the group to remove
OperationNotSupportedException
- if authentication provider
implementation does not support this operationvoid removeUserFromGroup(String groupname, String username) throws OperationNotSupportedException
groupname
- the name of the group to modifyusername
- the name of the user to remove
OperationNotSupportedException
- if authentication provider
implementation does not support this operationList getUsernamesForGroup(String groupname) throws OperationNotSupportedException
OperationNotSupportedException
- if authentication provider
implementation does not support this operationList getUsernamesForGroupLimited(String groupname, String searchExpression, int limit) throws OperationNotSupportedException
groupname
- the group to querysearchExpression
- a wildcard expression to matchlimit
- the maximum number of results to return
OperationNotSupportedException
- if authentication provider
implementation does not support this operation
|
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 |