Overview | Package | Class | Tree | Deprecated | Index | Help
| © 2004 BEA Systems, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.bea.p13n.controls.securityProvider
Interface GroupProviderControl

All Superinterfaces:
  weblogic.jws.control.Control, com.bea.control.Control, Serializable

public interface GroupProviderControl
extends weblogic.jws.control.Control

This control:

- is used as an interface to the Portal security provider functionality that is specific to groups.

Control properties:

- atnProvider The name of the authentication provider to perform these operations on. If not configured, the default authentication provider will be used.

Security requirements: These are determined by the roles specified on the AtnSecurityProvider MBean for the application. For example: ``

Nested Class Summary

Nested classes inherited from class com.bea.control.Control
`com.bea.control.Control.Callback`

Method Summary
`void` | `addGroupToGroup(String parentGroup, String childGroup)` Add a child group to a group
`void` | `addUserToGroup(String groupname, String username)` Add a user to a group.
`ProfileWrapper` | `createGroup(String name)`
`List` | `getAllGroupNames()`
`List` | `getChildGroupNames(String groupname)` 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)`
`List` | `getUsernamesForGroupLimited(String groupname, String searchExpression, int limit)` Retrieve a list of users in a group, matching the provided wildcard expression
`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
`void` | `removeUserFromGroup(String groupname, String username)` Remove a user from a group

Method Detail

### getParentGroupNames

    public List getParentGroupNames(String groupname)
                             throws OperationNotSupportedException

  Retrieve the parents of a group. Returns a List of parents, or null if there are none.

  Throws:
    `OperationNotSupportedException` - if authentication provider implementation does not support this operation

### getAllGroupNames

    public List getAllGroupNames()
                          throws OperationNotSupportedException

  Returns:
    a List of all group names in the system
  Throws:
    `OperationNotSupportedException` - if authentication provider implementation does not support this operation

### getGroupNamesForUser

    public List getGroupNamesForUser(String username)
                              throws OperationNotSupportedException

  Get a list of groups to which this user belongs

  Parameters:
    `username` - Current user name
  Returns:
    List of group names (String) to which the user belongs
  Throws:
    `OperationNotSupportedException` - if authentication provider implementation does not support this operation

### addGroupToGroup

    public void addGroupToGroup(String parentGroup,
                                String childGroup)
                         throws OperationNotSupportedException

  Add a child group to a group

  Parameters:
    `parentGroup` - the name of the group to modify
    `childGroup` - the name of the group to add
  Throws:
    `OperationNotSupportedException` - if authentication provider implementation does not support this operation

### addUserToGroup

    public void addUserToGroup(String groupname,
                               String username)
                        throws OperationNotSupportedException

  Add a user to a group.

  Parameters:
    `groupname` - the name of the group to modify
    `username` - the name of the user to add
  Throws:
    `OperationNotSupportedException` - if authentication provider implementation does not support this operation

### createGroup

    public ProfileWrapper createGroup(String name)
                               throws GroupAlreadyExistsException,
                                      InvalidGroupnameException,
                                      OperationNotSupportedException,
                                      P13nControlException

  Throws:
    `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 occur

### getChildGroupNames

    public List getChildGroupNames(String groupname)
                            throws OperationNotSupportedException

  Retrieve a list of all children of a group.

  Parameters:
    `groupname` - the group to query
  Throws:
    `OperationNotSupportedException` - if authentication provider implementation does not support this operation

### getTopLevelGroupNames

    public List getTopLevelGroupNames()
                               throws OperationNotSupportedException

  Retrieve a list of groups that do not have parent groups. This will not return the built-in WLS "everyone" or "users" groups.

  Throws:
    `OperationNotSupportedException` - if authentication provider implementation does not support this operation

### groupExists

    public boolean groupExists(String group)
                        throws OperationNotSupportedException

  Determines if a group exists in the realm.

  Returns:
    true if the group exists, false otherwise
  Throws:
    `OperationNotSupportedException` - if authentication provider implementation does not support this operation

### isDeletableGroup

    public boolean isDeletableGroup(String groupName)
                             throws OperationNotSupportedException

  Determine if a group can be deleted.

  Returns:
    false if the group name given is protected by the system in any way
  Throws:
    `OperationNotSupportedException` - if authentication provider implementation does not support this operation

### isDescendent

    public boolean isDescendent(String ancestor,
                                String descendent)
                         throws OperationNotSupportedException

  Determine if one group is a descendent of another.

  Parameters:
    `ancestor` - see if the other group is a descendent of this group
    `descendent` - see if this is a descendent of the other group
  Throws:
    `OperationNotSupportedException` - if authentication provider implementation does not support this operation

### isMemberOfGroup

    public boolean isMemberOfGroup(String groupname,
                                   String username,
                                   boolean recurse)
                            throws OperationNotSupportedException

  Determine if a user is a member of a group.

  Parameters:
    `groupname` - the group to query
    `username` - the user to look for
    `recurse` - Extend search to descendents of groupName
  Throws:
    `OperationNotSupportedException` - if authentication provider implementation does not support this operation

### removeGroup

    public void removeGroup(String groupname)
                     throws InvalidGroupnameException,
                            OperationNotSupportedException

  Remove a group. This will remove the group from both the realm and the profile tables.

  Throws:
    `InvalidGroupnameException` - if the group name is invalid
    `OperationNotSupportedException` - if authentication provider implementation does not support this operation

### removeGroupFromGroup

    public void removeGroupFromGroup(String parentGroup,
                                     String childGroup)
                              throws OperationNotSupportedException

  Remove a child group from a group

  Parameters:
    `parentGroup` - the name of the group to modify
    `childGroup` - the name of the group to remove
  Throws:
    `OperationNotSupportedException` - if authentication provider implementation does not support this operation

### removeUserFromGroup

    public void removeUserFromGroup(String groupname,
                                    String username)
                             throws OperationNotSupportedException

  Remove a user from a group

  Parameters:
    `groupname` - the name of the group to modify
    `username` - the name of the user to remove
  Throws:
    `OperationNotSupportedException` - if authentication provider implementation does not support this operation

### getUsernamesForGroup

    public List getUsernamesForGroup(String groupname)
                              throws OperationNotSupportedException

  Throws:
    `OperationNotSupportedException` - if authentication provider implementation does not support this operation

### getUsernamesForGroupLimited

    public List getUsernamesForGroupLimited(String groupname,
                                            String searchExpression,
                                            int limit)
                                     throws OperationNotSupportedException

  Retrieve a list of users in a group, matching the provided wildcard expression

  Parameters:
    `groupname` - the group to query
    `searchExpression` - a wildcard expression to match
    `limit` - the maximum number of results to return
  Returns:
    a List of usernames that are in this group
  Throws:
    `OperationNotSupportedException` - if authentication provider implementation does not support this operation

Overview | Package | Class | Tree | Deprecated | Index | Help
| © 2004 BEA Systems, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2004 BEA Systems, Inc. All Rights Reserved