org.apache.jetspeed.security.spi
Interface CredentialHandler

All Known Subinterfaces:

AuthenticationProviderProxy

public interface CredentialHandler

This interface encapsulates the handling of security credentials.

This provides a central placeholder for changing the mapping of user credentials. The default implementation only supports PasswordCredential

A security implementation wanting to map additional credentials should do so here.

Author:

David Le Strat

Method Summary

boolean	authenticate(String userName, String password) Authenticate a user.
Set	getPrivateCredentials(String username) Gets the private credentials for the user.
Set	getPublicCredentials(String username) Gets the public credentials for the user.
void	importPassword(String userName, String newPassword) Adds or updates a private password credential. Note that there is no checking of the oldPassword and the provided password is assumed to be encoded.
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.

Method Detail

getPublicCredentials

Set getPublicCredentials(String username)

Gets the public credentials for the user.

Parameters:

username - The username.

Returns:

The set of public credentials.

getPrivateCredentials

Set getPrivateCredentials(String username)

Gets the private credentials for the user.

Parameters:

username - The username.

Returns:

The set of private credentials.

importPassword

void importPassword(String userName,
                    String newPassword)
                    throws SecurityException

Adds or updates a private password credential.
Note that there is no checking of the oldPassword and the provided password is assumed to be encoded. Hence no encoding will take place.

Parameters:

username - The user to be updated.

newPassword - The new password.

Throws:

SecurityException - Throws a SecurityException.

setPassword

void setPassword(String userName,
                 String oldPassword,
                 String newPassword)
                 throws SecurityException

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

Parameters:

username - The user to be updated.

oldPassword - The old password.

newPassword - The new password.

Throws:

SecurityException - Throws a SecurityException.

setPasswordUpdateRequired

void setPasswordUpdateRequired(String userName,
                               boolean updateRequired)
                               throws SecurityException

Set the update required state of the user password credential.

Parameters:

userName - The user name.

updateRequired - The update required state.

Throws:

Throws - a security exception.

SecurityException

setPasswordEnabled

void setPasswordEnabled(String userName,
                        boolean enabled)
                        throws SecurityException

Set the enabled state of the user password credential.

Parameters:

userName - The user name.

enabled - The enabled state.

Throws:

Throws - a security exception.

SecurityException

setPasswordExpiration

void setPasswordExpiration(String userName,
                           Date expirationDate)
                           throws SecurityException

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.

Parameters:

userName - The user name.

expirationDate - The expiration date to set.

Throws:

Throws - a security exception.

SecurityException

authenticate

boolean authenticate(String userName,
                     String password)
                     throws SecurityException

Authenticate a user.

Parameters:

userName - The user name.

password - The user password.

Returns:

Whether or not a user is authenticated.

Throws:

SecurityException