Package org.apache.archiva.redback.users.cached

Class CachedUserManager

java.lang.Object

org.apache.archiva.redback.users.cached.CachedUserManager

All Implemented Interfaces:

UserManager, UserManagerListener

@Service("userManager#cached")
public class CachedUserManager
extends Object
implements UserManager, UserManagerListener

CachedUserManager

Author:

Joakim Erdfelt

Field Summary

Fields inherited from interface org.apache.archiva.redback.users.UserManager

GUEST_USERNAME

Constructor Summary

Constructors

Constructor	Description
CachedUserManager()

Method Summary

Modifier and Type	Method	Description
User	addUser(User user)	Add a User.
void	addUserManagerListener(UserManagerListener listener)	Add a UserManagerListener to track major events in the UserManager.
void	addUserUnchecked(User user)	Add a user to the database without checking for consistency or adjusting the password.
void	clearCache()	Clears the users cache
User	createGuestUser()	Factory method to create the guest user.
User	createUser(String username, String fullName, String emailAddress)	Factory method to create new User Objects based on provider specific implementation.
UserQuery	createUserQuery()	Factory method to create UserQuerys based on provider specific implementations.
void	deleteUser(String username)	Delete a user using the username.
void	eraseDatabase()
User	findUser(String username)	Find a User using a User name.
User	findUser(String username, boolean useCache)	Find a User using a User name.
List<? extends User>	findUsersByEmailKey(String emailKey, boolean orderAscending)
List<? extends User>	findUsersByFullNameKey(String fullNameKey, boolean orderAscending)
List<? extends User>	findUsersByQuery(UserQuery query)	Find users matching properties, ordering and range as specified by the UserQuery.
List<? extends User>	findUsersByUsernameKey(String usernameKey, boolean orderAscending)
String	getDescriptionKey()
User	getGuestUser()	Get the guest user.
String	getId()	An Identifier for the UserManager.
UserManager	getUserImpl()
List<? extends User>	getUsers()	Get the List of User objects.
List<? extends User>	getUsers(boolean orderAscending)
org.apache.archiva.components.cache.Cache<String,User>	getUsersCache()
void	initialize()	consumer of user manager can use it to reload various configuration with the configurable implementation is possible to change dynamically the real implementation used.
boolean	isFinalImplementation()
boolean	isReadOnly()	Is the UserManager read only? if so then create and modify actions are to be disabled
void	removeUserManagerListener(UserManagerListener listener)	Remove a UserManagerListener from the collection of listeners.
void	setUserImpl(UserManager userImpl)
void	setUsersCache(org.apache.archiva.components.cache.Cache<String,User> usersCache)
void	shutdown()
User	updateUser(User user)	Update a User.
User	updateUser(User user, boolean passwordChangeRequired)
boolean	userExists(String userName)	true if the user exists, false if it doesn't
void	userManagerInit(boolean freshDatabase)
void	userManagerUserAdded(User user)
void	userManagerUserRemoved(User user)
void	userManagerUserUpdated(User user)

Methods inherited from class java.lang.Object

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

Constructor Detail

CachedUserManager

public CachedUserManager()

Method Detail

isReadOnly

public boolean isReadOnly()

Description copied from interface: UserManager

Is the UserManager read only? if so then create and modify actions are to be disabled

Specified by:

isReadOnly in interface UserManager

Returns:

boolean true if user manager is disabled

createGuestUser

public User createGuestUser()
                     throws UserManagerException

Description copied from interface: UserManager

Factory method to create the guest user.

Specified by:

createGuestUser in interface UserManager

Returns:

The guest user

Throws:

UserManagerException

addUser

public User addUser(User user)
             throws UserManagerException

Description copied from interface: UserManager

Add a User.

Specified by:

addUser in interface UserManager

Parameters:

user - the user to add.

Returns:

the user that was just added.

Throws:

UserManagerException

addUserManagerListener

public void addUserManagerListener(UserManagerListener listener)

Description copied from interface: UserManager

Add a UserManagerListener to track major events in the UserManager.

Specified by:

addUserManagerListener in interface UserManager

Parameters:

listener - the listener to add.

addUserUnchecked

public void addUserUnchecked(User user)
                      throws UserManagerException

Description copied from interface: UserManager

Add a user to the database without checking for consistency or adjusting the password. Should only be used for re-importing known-good data.

Specified by:

addUserUnchecked in interface UserManager

Parameters:

user - the user to add

Throws:

UserManagerException

createUser

public User createUser(String username,
                       String fullName,
                       String emailAddress)
                throws UserManagerException

Description copied from interface: UserManager

Factory method to create new User Objects based on provider specific implementation. User objects created this way do not exist in the provider's underlying data store until a call to UserManager.addUser(User) is made.

Specified by:

createUser in interface UserManager

Parameters:

username - the username for this user.

fullName - the full name for this user.

emailAddress - the email address for this user.

Returns:

the new user object ready to use.

Throws:

UserManagerException

deleteUser

public void deleteUser(String username)
                throws UserNotFoundException,
                       UserManagerException

Description copied from interface: UserManager

Delete a user using the username.

Specified by:

deleteUser in interface UserManager

Parameters:

username - the username to look for.

Throws:

UserNotFoundException - the user was not found.

UserManagerException

eraseDatabase

public void eraseDatabase()

Specified by:

eraseDatabase in interface UserManager

findUser

public User findUser(String username)
              throws UserNotFoundException,
                     UserManagerException

Description copied from interface: UserManager

Find a User using a User name.

Specified by:

findUser in interface UserManager

Parameters:

username - the username to find.

Returns:

the user.

Throws:

UserNotFoundException - if the user was not found.

UserManagerException

findUser

public User findUser(String username,
                     boolean useCache)
              throws UserNotFoundException,
                     UserManagerException

Description copied from interface: UserManager

Find a User using a User name.

Specified by:

findUser in interface UserManager

Parameters:

username - the username to find.

useCache - to use or not caching

Returns:

the user.

Throws:

UserNotFoundException - if the user was not found.

UserManagerException

getGuestUser

public User getGuestUser()
                  throws UserNotFoundException,
                         UserManagerException

Description copied from interface: UserManager

Get the guest user.

Specified by:

getGuestUser in interface UserManager

Returns:

the guest user.

Throws:

UserNotFoundException

UserManagerException

createUserQuery

public UserQuery createUserQuery()

Description copied from interface: UserManager

Factory method to create UserQuerys based on provider specific implementations.

Specified by:

createUserQuery in interface UserManager

Returns:

the provider implementation of UserQuery

findUsersByQuery

public List<? extends User> findUsersByQuery(UserQuery query)
                                      throws UserManagerException

Description copied from interface: UserManager

Find users matching properties, ordering and range as specified by the UserQuery.

Specified by:

findUsersByQuery in interface UserManager

Parameters:

query - the query.

Returns:

a List of User objects.

Throws:

UserManagerException

findUsersByEmailKey

public List<? extends User> findUsersByEmailKey(String emailKey,
                                                boolean orderAscending)
                                         throws UserManagerException

Specified by:

findUsersByEmailKey in interface UserManager

Throws:

UserManagerException

findUsersByFullNameKey

public List<? extends User> findUsersByFullNameKey(String fullNameKey,
                                                   boolean orderAscending)
                                            throws UserManagerException

Specified by:

findUsersByFullNameKey in interface UserManager

Throws:

UserManagerException

findUsersByUsernameKey

public List<? extends User> findUsersByUsernameKey(String usernameKey,
                                                   boolean orderAscending)
                                            throws UserManagerException

Specified by:

findUsersByUsernameKey in interface UserManager

Throws:

UserManagerException

getId

public String getId()

Description copied from interface: UserManager

An Identifier for the UserManager.

Specified by:

getId in interface UserManager

Returns:

the user manager identifier.

getUsers

public List<? extends User> getUsers()
                              throws UserManagerException

Description copied from interface: UserManager

Get the List of User objects.

Specified by:

getUsers in interface UserManager

Returns:

the List of User Objects.

Throws:

UserManagerException

getUsers

public List<? extends User> getUsers(boolean orderAscending)
                              throws UserManagerException

Specified by:

getUsers in interface UserManager

Throws:

UserManagerException

removeUserManagerListener

public void removeUserManagerListener(UserManagerListener listener)

Description copied from interface: UserManager

Remove a UserManagerListener from the collection of listeners.

Specified by:

removeUserManagerListener in interface UserManager

Parameters:

listener - the listener to remove.

updateUser

public User updateUser(User user)
                throws UserNotFoundException,
                       UserManagerException

Description copied from interface: UserManager

Update a User.

Specified by:

updateUser in interface UserManager

Parameters:

user - the user to update.

Returns:

the user that was just updated.

Throws:

UserNotFoundException - if the user was not found to update.

UserManagerException

updateUser

public User updateUser(User user,
                       boolean passwordChangeRequired)
                throws UserNotFoundException,
                       UserManagerException

Specified by:

updateUser in interface UserManager

Throws:

UserNotFoundException

UserManagerException

userExists

public boolean userExists(String userName)
                   throws UserManagerException

Description copied from interface: UserManager

true if the user exists, false if it doesn't

Specified by:

userExists in interface UserManager

Returns:

true, if user exists

Throws:

UserManagerException

userManagerInit

public void userManagerInit(boolean freshDatabase)

Specified by:

userManagerInit in interface UserManagerListener

userManagerUserAdded

public void userManagerUserAdded(User user)

Specified by:

userManagerUserAdded in interface UserManagerListener

userManagerUserRemoved

public void userManagerUserRemoved(User user)

Specified by:

userManagerUserRemoved in interface UserManagerListener

userManagerUserUpdated

public void userManagerUserUpdated(User user)

Specified by:

userManagerUserUpdated in interface UserManagerListener

getUserImpl

public UserManager getUserImpl()

setUserImpl

public void setUserImpl(UserManager userImpl)

getUsersCache

public org.apache.archiva.components.cache.Cache<String,User> getUsersCache()

setUsersCache

public void setUsersCache(org.apache.archiva.components.cache.Cache<String,User> usersCache)

initialize

public void initialize()

Description copied from interface: UserManager

consumer of user manager can use it to reload various configuration with the configurable implementation is possible to change dynamically the real implementation used.

Specified by:

initialize in interface UserManager

isFinalImplementation

public boolean isFinalImplementation()

Specified by:

isFinalImplementation in interface UserManager

Returns:

true if this implementation is a final one and not a wrapper (configurable, cached)

getDescriptionKey

public String getDescriptionKey()

Specified by:

getDescriptionKey in interface UserManager

Returns:

a key to be able to customize label in UI

clearCache

public void clearCache()

Clears the users cache

shutdown

@PreDestroy
public void shutdown()