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

java.lang.Object
  extended byorg.apache.jetspeed.security.spi.impl.DefaultCredentialHandler
All Implemented Interfaces:
CredentialHandler

public class DefaultCredentialHandler
extends Object
implements CredentialHandler

Author:
David Le Strat
See Also:
CredentialHandler

Field Summary
private  InternalPasswordCredentialInterceptor ipcInterceptor
           
private static org.apache.commons.logging.Log log
           
private  PasswordCredentialProvider pcProvider
           
private  SecurityAccess securityAccess
           
 
Constructor Summary
DefaultCredentialHandler(SecurityAccess securityAccess, PasswordCredentialProvider pcProvider, InternalPasswordCredentialInterceptor ipcInterceptor)
           
 
Method Summary
 boolean authenticate(String userName, String password)
           Authenticate a user.
private  org.apache.jetspeed.security.om.InternalCredential getPasswordCredential(org.apache.jetspeed.security.om.InternalUserPrincipal internalUser, String username)
           
 Set getPrivateCredentials(String username)
           Gets the private credentials for the user.
 Set getPublicCredentials(String username)
           Gets the public credentials for the user.
 void setPassword(String userName, String oldPassword, String newPassword)
           Adds or updates a private password credential.
If oldPassword is not null, the oldPassword will first be checked (authenticated).
 void setPasswordEnabled(String userName, boolean enabled)
           Set the enabled state of the user password credential.
 void setPasswordExpiration(String userName, Date expirationDate)
           Set the expiration date and the expired flag of the password credential.
 void setPasswordUpdateRequired(String userName, boolean updateRequired)
           Set the update required state of the user password credential.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

private static final org.apache.commons.logging.Log log

securityAccess

private SecurityAccess securityAccess

pcProvider

private PasswordCredentialProvider pcProvider

ipcInterceptor

private InternalPasswordCredentialInterceptor ipcInterceptor
Constructor Detail

DefaultCredentialHandler

public DefaultCredentialHandler(SecurityAccess securityAccess,
                                PasswordCredentialProvider pcProvider,
                                InternalPasswordCredentialInterceptor ipcInterceptor)
Method Detail

getPrivateCredentials

public Set getPrivateCredentials(String username)
Description copied from interface: CredentialHandler

Gets the private credentials for the user.

Specified by:
getPrivateCredentials in interface CredentialHandler
Parameters:
username - The username.
Returns:
The set of private credentials.
See Also:
CredentialHandler.getPrivateCredentials(java.lang.String)

getPublicCredentials

public Set getPublicCredentials(String username)
Description copied from interface: CredentialHandler

Gets the public credentials for the user.

Specified by:
getPublicCredentials in interface CredentialHandler
Parameters:
username - The username.
Returns:
The set of public credentials.
See Also:
CredentialHandler.getPublicCredentials(java.lang.String)

getPasswordCredential

private org.apache.jetspeed.security.om.InternalCredential getPasswordCredential(org.apache.jetspeed.security.om.InternalUserPrincipal internalUser,
                                                                                 String username)

setPassword

public void setPassword(String userName,
                        String oldPassword,
                        String newPassword)
                 throws org.apache.jetspeed.security.SecurityException
Description copied from interface: CredentialHandler

Adds or updates a private password credential.
If oldPassword is not null, the oldPassword will first be checked (authenticated).

Specified by:
setPassword in interface CredentialHandler
Parameters:
oldPassword - The old password.
newPassword - The new password.
Throws:
org.apache.jetspeed.security.SecurityException - Throws a SecurityException.
See Also:
CredentialHandler.setPassword(java.lang.String,java.lang.String,java.lang.String)

setPasswordEnabled

public void setPasswordEnabled(String userName,
                               boolean enabled)
                        throws org.apache.jetspeed.security.SecurityException
Description copied from interface: CredentialHandler

Set the enabled state of the user password credential.

Specified by:
setPasswordEnabled in interface CredentialHandler
Parameters:
userName - The user name.
enabled - The enabled state.
Throws:
org.apache.jetspeed.security.SecurityException
See Also:
CredentialHandler.setPasswordEnabled(java.lang.String, boolean)

setPasswordUpdateRequired

public void setPasswordUpdateRequired(String userName,
                                      boolean updateRequired)
                               throws org.apache.jetspeed.security.SecurityException
Description copied from interface: CredentialHandler

Set the update required state of the user password credential.

Specified by:
setPasswordUpdateRequired in interface CredentialHandler
Parameters:
userName - The user name.
updateRequired - The update required state.
Throws:
org.apache.jetspeed.security.SecurityException
See Also:
CredentialHandler.setPasswordUpdateRequired(java.lang.String, boolean)

setPasswordExpiration

public void setPasswordExpiration(String userName,
                                  Date expirationDate)
                           throws org.apache.jetspeed.security.SecurityException
Description copied from interface: CredentialHandler

Set the expiration date and the expired flag of the password credential.

If a date equal or before the current date is provided, the expired flag will be set to true, otherwise to false.

Specified by:
setPasswordExpiration in interface CredentialHandler
Parameters:
userName - The user name.
expirationDate - The expiration date to set.
Throws:
org.apache.jetspeed.security.SecurityException
See Also:
CredentialHandler.setPasswordExpiration(java.lang.String, java.sql.Date)

authenticate

public boolean authenticate(String userName,
                            String password)
                     throws org.apache.jetspeed.security.SecurityException
Description copied from interface: CredentialHandler

Authenticate a user.

Specified by:
authenticate in interface CredentialHandler
Parameters:
userName - The user name.
password - The user password.
Returns:
Whether or not a user is authenticated.
Throws:
org.apache.jetspeed.security.SecurityException
See Also:
CredentialHandler.authenticate(java.lang.String, java.lang.String)


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