org.apache.xindice.server
Interface UserManager

All Known Implementing Classes:

StdUserManager

public interface UserManager

UserManager is an interface that is implemented to handle the management of Users. StdUserManager is the standard implementation of this interface.

See Also:

StdUserManager

Method Summary

void	deleteUser(java.lang.String username) deleteUser deletes a User from the UserManager's persistent store.
User	getUser(java.lang.String username) getUser retrieves a User by username.
java.lang.String[]	listUsers() listUsers retrieves a list of User names.
java.lang.String[]	listUsers(java.lang.String startsWith) listUsers retrieves a list of User names.
User	newUser() newUser creates a new User.
void	setUser(User user) setUser stores the User to the UserManager's persistent store.

Method Detail

getUser

public User getUser(java.lang.String username)

getUser retrieves a User by username.

Parameters:

username - the User name

Returns:

the retrieved User

newUser

public User newUser()

newUser creates a new User. setUsername() must be called before storing this new User.

Returns:

a new User instance

setUser

public void setUser(User user)

setUser stores the User to the UserManager's persistent store.

Parameters:

user - the User

deleteUser

public void deleteUser(java.lang.String username)

deleteUser deletes a User from the UserManager's persistent store.

Parameters:

username - the User's name

listUsers

public java.lang.String[] listUsers(java.lang.String startsWith)

listUsers retrieves a list of User names. This method uses startsWith to narrow the retrieval set.

Parameters:

startsWith - a filter that evaluates to startsWith*

Returns:

the list of Users that match the filter

listUsers

public java.lang.String[] listUsers()

listUsers retrieves a list of User names. This method returns all available User names.

Returns:

the list of all Users