ome.security.auth

Class FilePasswordProvider

java.lang.Object

ome.security.auth.ConfigurablePasswordProvider

ome.security.auth.FilePasswordProvider

All Implemented Interfaces:

PasswordProvider, PasswordUtility, ApplicationContextAware

public class FilePasswordProvider
extends ConfigurablePasswordProvider

Example password provider which uses the given file as password lookup. All entries in the file are of the form: username=password, where password is in whatever encoding is configured for the provider. Changing passwords is not supported.

Since:

4.0

Author:

Josh Moore, josh at glencoesoftware.com

Field Summary

Fields

Modifier and Type	Field and Description
protected File	file Flat file read on each invocation with name, value pairs in Java Properties notation.

Fields inherited from class ome.security.auth.ConfigurablePasswordProvider

ctx, hash, ignoreUnknown, legacyUtil, log, salt, util

Constructor Summary

Constructors

Constructor and Description
FilePasswordProvider(PasswordUtil util, File file)
FilePasswordProvider(PasswordUtil util, File file, boolean ignoreUnknown)

Method Summary

Modifier and Type	Method and Description
Boolean	checkPassword(String user, String password, boolean readOnly) If this was constructed with the ignoreUnknown argument set to true, returns null, since the base class knows no users.
protected Boolean	doCheckPassword(String user, String password, Properties p, boolean readOnly)
protected Properties	getProperties()
boolean	hasPassword(String user) Always returns false, override with specific logic.

Methods inherited from class ome.security.auth.ConfigurablePasswordProvider

changePassword, comparePasswords, comparePasswords, comparePasswords, encodePassword, encodePassword, encodeSaltedPassword, loginAttempt, setApplicationContext, setLegacyUtil

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

file

protected final File file

Flat file read on each invocation with name, value pairs in Java Properties notation.

Constructor Detail

FilePasswordProvider

public FilePasswordProvider(PasswordUtil util,
                            File file)

FilePasswordProvider

public FilePasswordProvider(PasswordUtil util,
                            File file,
                            boolean ignoreUnknown)

Method Detail

hasPassword

public boolean hasPassword(String user)

Description copied from class: ConfigurablePasswordProvider

Always returns false, override with specific logic.

Specified by:

hasPassword in interface PasswordProvider

Overrides:

hasPassword in class ConfigurablePasswordProvider

checkPassword

public Boolean checkPassword(String user,
                             String password,
                             boolean readOnly)

Description copied from class: ConfigurablePasswordProvider

If this was constructed with the ignoreUnknown argument set to true, returns null, since the base class knows no users. Otherwise, returns Boolean.FALSE specifying that authentication should fail.

Specified by:

checkPassword in interface PasswordProvider

Overrides:

checkPassword in class ConfigurablePasswordProvider

doCheckPassword

protected Boolean doCheckPassword(String user,
                                  String password,
                                  Properties p,
                                  boolean readOnly)

getProperties

protected Properties getProperties()