org.apache.xindice.server.standard
Class StdUserManager

java.lang.Object
  |
  +--org.apache.xindice.server.standard.StdUserManager

All Implemented Interfaces:

Configurable, KernelAccess, UserManager

public final class StdUserManager

extends java.lang.Object

implements Configurable, UserManager, KernelAccess

StdUserManager

Constructor Summary

StdUserManager()

Method Summary

void	deleteUser(java.lang.String username) deleteUser deletes a User from the UserManager's persistent store.
Configuration	getConfig() getConfig retrieves the configuration information for the Configurable object instance.
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	setConfig(Configuration config) setConfig sets the configuration information for the Configurable object instance.
void	setKernel(Kernel kernel) setKernel provides a Kernel callback interface to the implementing object.
void	setUser(User user) setUser stores the User to the UserManager's persistent store.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StdUserManager

public StdUserManager()

Method Detail

setKernel

public void setKernel(Kernel kernel)

Description copied from interface: KernelAccess

setKernel provides a Kernel callback interface to the implementing object.

Specified by:

setKernel in interface KernelAccess

Following copied from interface: org.apache.xindice.server.KernelAccess

Parameters:

kernel - the Kernel reference

setConfig

public void setConfig(Configuration config)

Description copied from interface: Configurable

setConfig sets the configuration information for the Configurable object instance.

Specified by:

setConfig in interface Configurable

Following copied from interface: org.apache.xindice.util.Configurable

Parameters:

config - The configuration Node

getConfig

public Configuration getConfig()

Description copied from interface: Configurable

getConfig retrieves the configuration information for the Configurable object instance.

Specified by:

getConfig in interface Configurable

Following copied from interface: org.apache.xindice.util.Configurable

Returns:

The configuration Node

getUser

public User getUser(java.lang.String username)

Description copied from interface: UserManager

getUser retrieves a User by username.

Specified by:

getUser in interface UserManager

Following copied from interface: org.apache.xindice.server.UserManager

Parameters:

username - the User name

Returns:

the retrieved User

newUser

public User newUser()

Description copied from interface: UserManager

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

Specified by:

newUser in interface UserManager

Following copied from interface: org.apache.xindice.server.UserManager

Returns:

a new User instance

setUser

public void setUser(User user)

Description copied from interface: UserManager

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

Specified by:

setUser in interface UserManager

Following copied from interface: org.apache.xindice.server.UserManager

Parameters:

user - the User

deleteUser

public void deleteUser(java.lang.String username)

Description copied from interface: UserManager

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

Specified by:

deleteUser in interface UserManager

Following copied from interface: org.apache.xindice.server.UserManager

Parameters:

username - the User's name

listUsers

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

Description copied from interface: UserManager

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

Specified by:

listUsers in interface UserManager

Following copied from interface: org.apache.xindice.server.UserManager

Parameters:

startsWith - a filter that evaluates to startsWith*

Returns:

the list of Users that match the filter

listUsers

public java.lang.String[] listUsers()

Description copied from interface: UserManager

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

Specified by:

listUsers in interface UserManager

Following copied from interface: org.apache.xindice.server.UserManager

Returns:

the list of all Users