org.apache.jetspeed.security
Interface AuthenticationProviderProxy

All Superinterfaces:

CredentialHandler, UserSecurityHandler

public interface AuthenticationProviderProxy
extends UserSecurityHandler, CredentialHandler

Proxy allowing to handle multiple authentication providers.

Author:

David Le Strat

Method Summary

void	addUserPrincipal(UserPrincipal userPrincipal, String authenticationProvider) Adds a new user principal in a given authentication provider.
boolean	authenticate(String userName, String password, String authenticationProvider) Authenticate a user in a given authentication provider
String	getAuthenticationProvider(String userName) Returns the authentication provider of a user principal.
String	getDefaultAuthenticationProvider() Returns the default authentication provider.
void	importPassword(String userName, String newPassword) Adds or updates a private password credentialin a given authentication provider. Note that there is no checking of the oldPassword and the provided password is assumed to be encoded.
void	importPassword(String userName, String newPassword, String authenticationProvider) Adds or updates a private password credentialin a given authentication provider. Note that there is no checking of the oldPassword and the provided password is assumed to be encoded.
void	removeUserPrincipal(UserPrincipal userPrincipal, String authenticationProvider) Remove user principal in a given authentication provider.
void	setPassword(String userName, String oldPassword, String newPassword, String authenticationProvider) Adds or updates a private password credential in a given authentication provider. If oldPassword is not null, the oldPassword will first be checked (authenticated).
void	setPasswordEnabled(String userName, boolean enabled, String authenticationProvider) Set the enabled state of the user password credential in a given authentication provider.
void	setPasswordExpiration(String userName, Date expirationDate, String authenticationProvider) Set the expiration date and the expired flag of the password credential in a given authentication provider
void	setPasswordUpdateRequired(String userName, boolean updateRequired, String authenticationProvider) Set the update required state of the user password credential in a given authentication provider.
void	updateUserPrincipal(UserPrincipal userPrincipal, String authenticationProvider) Updates user principal in a given authentication provider.

Methods inherited from interface org.apache.jetspeed.security.spi.UserSecurityHandler

addUserPrincipal, getUserPrincipal, getUserPrincipals, isUserPrincipal, removeUserPrincipal, updateUserPrincipal

Methods inherited from interface org.apache.jetspeed.security.spi.CredentialHandler

authenticate, getPrivateCredentials, getPublicCredentials, setPassword, setPasswordEnabled, setPasswordExpiration, setPasswordUpdateRequired

Method Detail

getDefaultAuthenticationProvider

String getDefaultAuthenticationProvider()

Returns the default authentication provider.

Returns:

The default authentication provider.

getAuthenticationProvider

String getAuthenticationProvider(String userName)

Returns the authentication provider of a user principal.

Parameters:

userName -

Returns:

The authentication provider or null if user is unknown.

addUserPrincipal

void addUserPrincipal(UserPrincipal userPrincipal,
                      String authenticationProvider)
                      throws SecurityException

Adds a new user principal in a given authentication provider.

Parameters:

userPrincipal - The new user principal.

authenticationProvider - The authentication provider name.

Throws:

SecurityException - Throws a security exception.

updateUserPrincipal

void updateUserPrincipal(UserPrincipal userPrincipal,
                         String authenticationProvider)
                         throws SecurityException

Updates user principal in a given authentication provider.

Parameters:

userPrincipal - The user principal.

authenticationProvider - The authentication provider name.

Throws:

SecurityException - Throws a security exception.

removeUserPrincipal

void removeUserPrincipal(UserPrincipal userPrincipal,
                         String authenticationProvider)
                         throws SecurityException

Remove user principal in a given authentication provider.

Parameters:

userPrincipal - The user principal.

authenticationProvider - The authentication provider name.

Throws:

SecurityException - Throws a security exception.

importPassword

void importPassword(String userName,
                    String newPassword)
                    throws SecurityException

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

Specified by:

importPassword in interface CredentialHandler

Parameters:

username - The user to be updated.

newPassword - The new password.

Throws:

SecurityException - Throws a SecurityException.

importPassword

void importPassword(String userName,
                    String newPassword,
                    String authenticationProvider)
                    throws SecurityException

Adds or updates a private password credentialin a given authentication provider.
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.

authenticationProvider - The authentication provider name.

Throws:

SecurityException - Throws a SecurityException.

setPassword

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

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

Parameters:

userName - The name of the user to be updated.

oldPassword - The old password value.

newPassword - The new password value.

authenticationProvider - The authentication provider name.

Throws:

SecurityException - Throws a SecurityException.

setPasswordUpdateRequired

void setPasswordUpdateRequired(String userName,
                               boolean updateRequired,
                               String authenticationProvider)
                               throws SecurityException

Set the update required state of the user password credential in a given authentication provider.

Parameters:

userName - The user name.

updateRequired - The update required state.

authenticationProvider - The authentication provider name.

Throws:

Throws - a security exception.

SecurityException

setPasswordEnabled

void setPasswordEnabled(String userName,
                        boolean enabled,
                        String authenticationProvider)
                        throws SecurityException

Set the enabled state of the user password credential in a given authentication provider.

Parameters:

userName - The user name.

enabled - The enabled state.

authenticationProvider - The authentication provider name.

Throws:

Throws - a security exception.

SecurityException

setPasswordExpiration

void setPasswordExpiration(String userName,
                           Date expirationDate,
                           String authenticationProvider)
                           throws SecurityException

Set the expiration date and the expired flag of the password credential in a given authentication provider

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.

authenticationProvider - The authentication provider name.

Throws:

Throws - a security exception.

SecurityException

authenticate

boolean authenticate(String userName,
                     String password,
                     String authenticationProvider)
                     throws SecurityException

Authenticate a user in a given authentication provider

Parameters:

userName - The user name.

password - The user password.

authenticationProvider - The authentication provider name.

Returns:

Whether or not a user is authenticated.

Throws:

SecurityException