com.opensymphony.user.provider
Interface AccessProvider

All Superinterfaces:

java.io.Serializable, UserProvider

All Known Implementing Classes:

CastorAccessProvider, EJBAccessProvider, FileAccessProvider, HibernateAccessProvider, JDBCAccessProvider, MemoryAccessProvider, OFBizAccessProvider, OrionAccessProvider, WeblogicAccessProvider

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(java.lang.String username, java.lang.String groupname) Add user to group.
boolean	inGroup(java.lang.String username, java.lang.String groupname) Find out whether given user is member of given group.
java.util.List	listGroupsContainingUser(java.lang.String username) List all groups that contain a user.
java.util.List	listUsersInGroup(java.lang.String groupname) List all users that are contained within a group.
boolean	removeFromGroup(java.lang.String username, java.lang.String groupname) Remove user from group.

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

create, flushCaches, handles, init, list, load, remove, store

Method Detail

addToGroup

public boolean addToGroup(java.lang.String username,
                          java.lang.String groupname)

Add user to group.

Returns:

Whether user was successfully added to group.

inGroup

public boolean inGroup(java.lang.String username,
                       java.lang.String groupname)

Find out whether given user is member of given group.

Returns:

Whether user is member of group.

listGroupsContainingUser

public java.util.List listGroupsContainingUser(java.lang.String username)

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

public java.util.List listUsersInGroup(java.lang.String groupname)

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

public boolean removeFromGroup(java.lang.String username,
                               java.lang.String groupname)

Remove user from group.

Returns:

Whether user was successfully removed from group.