org.apache.jetspeed.security
Interface AuthenticationProviderProxy

All Superinterfaces:

CredentialHandler, UserSecurityHandler

All Known Implementing Classes:

AuthenticationProviderProxyImpl

public interface AuthenticationProviderProxy

extends UserSecurityHandler, CredentialHandler

Proxy allowing to handle multiple authentication providers.

Author:

David Le Strat

Method Summary

void	addUserPrincipal(org.apache.jetspeed.security.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	removeUserPrincipal(org.apache.jetspeed.security.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(org.apache.jetspeed.security.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

public String getDefaultAuthenticationProvider()

Returns the default authentication provider.

Returns:

The default authentication provider.

getAuthenticationProvider

public 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

public void addUserPrincipal(org.apache.jetspeed.security.UserPrincipal userPrincipal,
                             String authenticationProvider)
                      throws org.apache.jetspeed.security.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.

org.apache.jetspeed.security.SecurityException

updateUserPrincipal

public void updateUserPrincipal(org.apache.jetspeed.security.UserPrincipal userPrincipal,
                                String authenticationProvider)
                         throws org.apache.jetspeed.security.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.

org.apache.jetspeed.security.SecurityException

removeUserPrincipal

public void removeUserPrincipal(org.apache.jetspeed.security.UserPrincipal userPrincipal,
                                String authenticationProvider)
                         throws org.apache.jetspeed.security.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.

org.apache.jetspeed.security.SecurityException

setPassword

public void setPassword(String userName,
                        String oldPassword,
                        String newPassword,
                        String authenticationProvider)
                 throws org.apache.jetspeed.security.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:

oldPassword - The old password value.

newPassword - The new password value.

authenticationProvider - The authentication provider name.

Throws:

SecurityException - Throws a SecurityException.

org.apache.jetspeed.security.SecurityException

setPasswordUpdateRequired

public void setPasswordUpdateRequired(String userName,
                                      boolean updateRequired,
                                      String authenticationProvider)
                               throws org.apache.jetspeed.security.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.

org.apache.jetspeed.security.SecurityException

setPasswordEnabled

public void setPasswordEnabled(String userName,
                               boolean enabled,
                               String authenticationProvider)
                        throws org.apache.jetspeed.security.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.

org.apache.jetspeed.security.SecurityException

setPasswordExpiration

public void setPasswordExpiration(String userName,
                                  Date expirationDate,
                                  String authenticationProvider)
                           throws org.apache.jetspeed.security.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.

org.apache.jetspeed.security.SecurityException

authenticate

public boolean authenticate(String userName,
                            String password,
                            String authenticationProvider)
                     throws org.apache.jetspeed.security.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:

org.apache.jetspeed.security.SecurityException