org.apache.jetspeed.security.spi
Interface UserSecurityHandler

All Known Subinterfaces:

AuthenticationProviderProxy

public interface UserSecurityHandler

This interface encapsulates the persistence of a user security.

This provides a central placeholder for changing the persistence of user security information.

A security implementation wanting to store user security implementation in LDAP for instance would need to provide an LDAP implementation of this interface.

Author:

David Le Strat

Method Summary

void	addUserPrincipal(UserPrincipal userPrincipal) Adds a new user principal in the backing store.
Principal	getUserPrincipal(String username) Gets the user principal for the given user name.
List	getUserPrincipals(String filter) Gets the an iterator of user principals for a given filter.
boolean	isUserPrincipal(String userName) Checks if a UserPrincipal exists
void	removeUserPrincipal(UserPrincipal userPrincipal) Removes the user principal.
void	updateUserPrincipal(UserPrincipal userPrincipal) Updates the user principal in the backing store.

Method Detail

isUserPrincipal

boolean isUserPrincipal(String userName)

Checks if a UserPrincipal exists

Parameters:

userName -

Returns:

true if a UserPrincipal exists

getUserPrincipal

Principal getUserPrincipal(String username)

Gets the user principal for the given user name.

Parameters:

username - The user name.

Returns:

The Principal

getUserPrincipals

List getUserPrincipals(String filter)

Gets the an iterator of user principals for a given filter.

Parameters:

filter - The filter.

Returns:

The list of Principal

addUserPrincipal

void addUserPrincipal(UserPrincipal userPrincipal)
                      throws SecurityException

Adds a new user principal in the backing store.

Parameters:

userPrincipal - The new UserPrincipal.

Throws:

SecurityException - Throws a SecurityException.

updateUserPrincipal

void updateUserPrincipal(UserPrincipal userPrincipal)
                         throws SecurityException

Updates the user principal in the backing store.

Parameters:

userPrincipal - The UserPrincipal.

Throws:

SecurityException - Throws a SecurityException.

removeUserPrincipal

void removeUserPrincipal(UserPrincipal userPrincipal)
                         throws SecurityException

Removes the user principal.

Parameters:

userPrincipal - The UserPrincipal.

Throws:

SecurityException - Throws a SecurityException.