org.apache.jetspeed.security.spi
Interface UserSecurityHandler

All Known Subinterfaces:

AuthenticationProviderProxy

All Known Implementing Classes:

AuthenticationProviderProxyImpl, DefaultUserSecurityHandler, LdapUserSecurityHandler

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(org.apache.jetspeed.security.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(org.apache.jetspeed.security.UserPrincipal userPrincipal) Removes the user principal.
void	updateUserPrincipal(org.apache.jetspeed.security.UserPrincipal userPrincipal) Updates the user principal in the backing store.

Method Detail

isUserPrincipal

public boolean isUserPrincipal(String userName)

Checks if a UserPrincipal exists

Parameters:

userName -

Returns:

true if a UserPrincipal exists

getUserPrincipal

public Principal getUserPrincipal(String username)

Gets the user principal for the given user name.

Parameters:

username - The user name.

Returns:

The Principal

getUserPrincipals

public 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

public void addUserPrincipal(org.apache.jetspeed.security.UserPrincipal userPrincipal)
                      throws org.apache.jetspeed.security.SecurityException

Adds a new user principal in the backing store.

Parameters:

userPrincipal - The new UserPrincipal.

Throws:

org.apache.jetspeed.security.SecurityException - Throws a SecurityException.

updateUserPrincipal

public void updateUserPrincipal(org.apache.jetspeed.security.UserPrincipal userPrincipal)
                         throws org.apache.jetspeed.security.SecurityException

Updates the user principal in the backing store.

Parameters:

userPrincipal - The UserPrincipal.

Throws:

org.apache.jetspeed.security.SecurityException - Throws a SecurityException.

removeUserPrincipal

public void removeUserPrincipal(org.apache.jetspeed.security.UserPrincipal userPrincipal)
                         throws org.apache.jetspeed.security.SecurityException

Removes the user principal.

Parameters:

userPrincipal - The UserPrincipal.

Throws:

org.apache.jetspeed.security.SecurityException - Throws a SecurityException.