org.apache.jetspeed.security.spi.impl
Class DefaultUserSecurityHandler

java.lang.Object
  extended byorg.apache.jetspeed.security.spi.impl.DefaultUserSecurityHandler
All Implemented Interfaces:
UserSecurityHandler

public class DefaultUserSecurityHandler
extends Object
implements UserSecurityHandler

Author:
David Le Strat
See Also:
UserSecurityHandler

Field Summary
private  SecurityAccess securityAccess
          SecurityAccess.
 
Constructor Summary
DefaultUserSecurityHandler(SecurityAccess securityAccess)
          Constructor providing access to the SecurityAccess implementation.
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

securityAccess

private SecurityAccess securityAccess
SecurityAccess.

Constructor Detail

DefaultUserSecurityHandler

public DefaultUserSecurityHandler(SecurityAccess securityAccess)

Constructor providing access to the SecurityAccess implementation.

Method Detail

isUserPrincipal

public boolean isUserPrincipal(String userName)
Description copied from interface: UserSecurityHandler

Checks if a UserPrincipal exists

Specified by:
isUserPrincipal in interface UserSecurityHandler
Parameters:
userName -
Returns:
true if a UserPrincipal exists
See Also:
UserSecurityHandler.isUserPrincipal(java.lang.String)

getUserPrincipal

public Principal getUserPrincipal(String username)
Description copied from interface: UserSecurityHandler

Gets the user principal for the given user name.

Specified by:
getUserPrincipal in interface UserSecurityHandler
Parameters:
username - The user name.
Returns:
The Principal

See Also:
UserSecurityHandler.getUserPrincipal(java.lang.String)

getUserPrincipals

public List getUserPrincipals(String filter)
Description copied from interface: UserSecurityHandler

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

Specified by:
getUserPrincipals in interface UserSecurityHandler
Parameters:
filter - The filter.
Returns:
The list of Principal
See Also:
UserSecurityHandler.getUserPrincipals(java.lang.String)

addUserPrincipal

public void addUserPrincipal(org.apache.jetspeed.security.UserPrincipal userPrincipal)
                      throws org.apache.jetspeed.security.SecurityException
Description copied from interface: UserSecurityHandler

Adds a new user principal in the backing store.

Specified by:
addUserPrincipal in interface UserSecurityHandler
Parameters:
userPrincipal - The new UserPrincipal.
Throws:
org.apache.jetspeed.security.SecurityException - Throws a SecurityException.
See Also:
UserSecurityHandler.addUserPrincipal(org.apache.jetspeed.security.UserPrincipal)

updateUserPrincipal

public void updateUserPrincipal(org.apache.jetspeed.security.UserPrincipal userPrincipal)
                         throws org.apache.jetspeed.security.SecurityException
Description copied from interface: UserSecurityHandler

Updates the user principal in the backing store.

Specified by:
updateUserPrincipal in interface UserSecurityHandler
Parameters:
userPrincipal - The UserPrincipal.
Throws:
org.apache.jetspeed.security.SecurityException - Throws a SecurityException.
See Also:
UserSecurityHandler.updateUserPrincipal(org.apache.jetspeed.security.UserPrincipal)

removeUserPrincipal

public void removeUserPrincipal(org.apache.jetspeed.security.UserPrincipal userPrincipal)
                         throws org.apache.jetspeed.security.SecurityException
Description copied from interface: UserSecurityHandler

Removes the user principal.

Specified by:
removeUserPrincipal in interface UserSecurityHandler
Parameters:
userPrincipal - The UserPrincipal.
Throws:
org.apache.jetspeed.security.SecurityException - Throws a SecurityException.
See Also:
UserSecurityHandler.removeUserPrincipal(org.apache.jetspeed.security.UserPrincipal)


Copyright © 1999-2005 Apache Software Foundation. All Rights Reserved.