com.opensymphony.user.provider
Interface AccessProvider

All Superinterfaces:

Serializable, UserProvider

All Known Implementing Classes:

EmbeddedCrowdAccessProvider

Deprecated.

@Deprecated
public interface AccessProvider
extends UserProvider

The AccessProvider is a UserProvider specifically used for storing details about Groups and memberships. All Entities referred to are of type Group, and all Entity.Accessor objects can be safely cast to Group.Accessor

Version:

$Revision: 1.2 $

Author:

Joe Walnes

See Also:

UserProvider, Group

Method Summary

boolean	addToGroup(String username, String groupname) Deprecated. Add user to group.
boolean	inGroup(String username, String groupname) Deprecated. Find out whether given user is member of given group.
List<String>	listGroupsContainingUser(String username) Deprecated. List all groups that contain a user.
List<String>	listUsersInGroup(String groupname) Deprecated. List all users that are contained within a group.
boolean	removeFromGroup(String username, String groupname) Deprecated. Remove user from group.

Methods inherited from interface com.opensymphony.user.provider.UserProvider

create, flushCaches, handles, init, list, remove

Method Detail

addToGroup

boolean addToGroup(String username,
                   String groupname)

Deprecated.

Add user to group.

Returns:

Whether user was successfully added to group.

inGroup

boolean inGroup(String username,
                String groupname)

Deprecated.

Find out whether given user is member of given group.

Returns:

Whether user is member of group.

listGroupsContainingUser

List<String> listGroupsContainingUser(String username)

Deprecated.

List all groups that contain a user.

Returns:

List containing Strings of groupnames. If no groups found, empty list should be returned. If feature not supported by UserProvider, null shall be returned. This List should be immutable.

listUsersInGroup

List<String> listUsersInGroup(String groupname)

Deprecated.

List all users that are contained within a group.

Returns:

List containing Strings of usernames. If no users found, empty list should be returned. If feature not supported by UserProvider, null shall be returned. This List should be immutable.

removeFromGroup

boolean removeFromGroup(String username,
                        String groupname)

Deprecated.

Remove user from group.

Returns:

Whether user was successfully removed from group.