ome.security.auth

Interface PasswordProvider

All Known Implementing Classes:

ConfigurablePasswordProvider, FilePasswordProvider, JdbcHashedPasswordProvider, JdbcPasswordProvider, LdapPasswordProvider, LdapPasswordProvider431, PasswordProviders

public interface PasswordProvider

Authentication interface responsible for checking and changing passwords. In addition, a implementation may claim to know nothing for a particular user name. See checkPassword(String, String, boolean) for more information.

Since:

4.0

Author:

Josh Moore, josh at glencoesoftware.com

See Also:

SecuritySystem, Permissions

Method Summary

Modifier and Type	Method and Description
void	changePassword(java.lang.String user, java.lang.String password) Attempts to change the password for the given user.
java.lang.Boolean	checkPassword(java.lang.String user, java.lang.String password, boolean readOnly) Authenticates the give user given the password token.
boolean	hasPassword(java.lang.String user) Returns true if this provider considers itself responsible for the given user name.

Method Detail

hasPassword

boolean hasPassword(java.lang.String user)

Returns true if this provider considers itself responsible for the given user name. In general, if this method returns false, then checkPassword will return null or false for all possible passwords. However, some providers (like the LDAP provider) may create a user to synchronize with some backend during a call to checkPassword(String, String, boolean). hasPassword(String) will not do this. This is typically only of importance during changePassword(String, String) since a provider which is not responsible for a password should not attempt to change it, and before a provider has not created a user, it is also not responsible.

checkPassword

java.lang.Boolean checkPassword(java.lang.String user,
                                java.lang.String password,
                                boolean readOnly)

Authenticates the give user given the password token. May return a null Boolean in order to signal that this provider is not responsible for the given user and can make no decision. Concrete implementations may decide to return false for all unknown users. If readOnly is false, then some implementations may choose to create new users.

changePassword

void changePassword(java.lang.String user,
                    java.lang.String password)
             throws PasswordChangeException

Attempts to change the password for the given user. May throw a PasswordChangeException, for example if the provider uses a read-only medium.

Throws:

PasswordChangeException