sapphire.action

Class BasePasswordValidator

java.lang.Object

com.labvantage.sapphire.BaseCustom

sapphire.action.BasePasswordValidator

public abstract class BasePasswordValidator
extends com.labvantage.sapphire.BaseCustom

Field Summary

Fields

Modifier and Type	Field and Description
protected DBAccess	database
static int	FAILURE
static int	SUCCESS

Fields inherited from class com.labvantage.sapphire.BaseCustom

logger, logName

Constructor Summary

Constructors

Constructor and Description
BasePasswordValidator()

Method Summary

Modifier and Type	Method and Description
abstract void	checkPasswordFormat(java.lang.String userid, java.lang.String password, PropertyList properties) Returns whether the password is a valid password for the current user
java.lang.String	encodePassword(java.lang.String password) Return encoded form of password.
java.lang.String	encrypt(java.lang.String password) Deprecated.
java.lang.String	encrypt(java.lang.String password, boolean isCaseSensitive) Deprecated.
void	endPasswordHandler()
java.lang.String	generatePassword(PropertyList properties)
protected void	logError(java.lang.String errormsg)
protected void	logError(java.lang.String errormsg, java.lang.Exception exception)
protected void	logTrace(java.lang.String tracemsg)
boolean	passwordMatches(java.lang.String password, java.lang.String encodedPassword, boolean isCaseSensitive) Checks if a stored password matches the provided one.
boolean	passwordNeedUpgrade(java.lang.String encodedPassword) Checks if a stored password should be upgraded to latest encoding.
void	startPasswordHandler()
void	startPasswordHandler(com.labvantage.sapphire.DBUtil dbutil)
void	startPasswordHandler(com.labvantage.sapphire.services.SapphireConnection sapphireConnection)

Methods inherited from class com.labvantage.sapphire.BaseCustom

getAccessorErrorIds, getAccessorErrorMsgs, getActionProcessor, getConfigurationProcessor, getConnectionid, getConnectionId, getConnectionProcessor, getDAMProcessor, getDepartmentList, getHttpProcessor, getQueryProcessor, getRakFile, getSDCProcessor, getSDIProcessor, getSequenceProcessor, getTranslationProcessor, setConnectionId, setLanguage, setRakFile

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS

public static final int SUCCESS

See Also:

Constant Field Values

FAILURE

public static final int FAILURE

See Also:

Constant Field Values

database

protected DBAccess database

Constructor Detail

BasePasswordValidator

public BasePasswordValidator()

Method Detail

logError

protected void logError(java.lang.String errormsg)

logError

protected void logError(java.lang.String errormsg,
                        java.lang.Exception exception)

logTrace

protected void logTrace(java.lang.String tracemsg)

startPasswordHandler

public void startPasswordHandler()

startPasswordHandler

public void startPasswordHandler(com.labvantage.sapphire.services.SapphireConnection sapphireConnection)
                          throws SapphireException

Throws:

SapphireException

startPasswordHandler

public void startPasswordHandler(com.labvantage.sapphire.DBUtil dbutil)
                          throws SapphireException

Throws:

SapphireException

endPasswordHandler

public void endPasswordHandler()

encrypt

@Deprecated
public java.lang.String encrypt(java.lang.String password)

Deprecated.

Returns encrypted form of the password. The may be useful when comparing the entered password with a password stored in the database

Parameters:

password - the password string to be encrypted

Returns:

encryptedpassword the password converted to its encrypted form

encrypt

@Deprecated
public java.lang.String encrypt(java.lang.String password,
                                             boolean isCaseSensitive)

Deprecated.

Returns encrypted form of the password. The may be useful when comparing the entered password with a password stored in the database

Parameters:

password - the password string to be encrypted

isCaseSensitive - whether the password string to be encrypted as case sensitive

Returns:

encryptedpassword the password converted to its encrypted form

encodePassword

public java.lang.String encodePassword(java.lang.String password)

Return encoded form of password. Use when you need to store a user password with strong encryption

Parameters:

password - the password string to be encoded

Returns:

encoded password

passwordMatches

public boolean passwordMatches(java.lang.String password,
                               java.lang.String encodedPassword,
                               boolean isCaseSensitive)

Checks if a stored password matches the provided one.

Parameters:

password - the clear text password

encodedPassword - the previously encoded password

isCaseSensitive - whether the password string to be encrypted as case sensitive

Returns:

true if password matches the encoded one

passwordNeedUpgrade

public boolean passwordNeedUpgrade(java.lang.String encodedPassword)

Checks if a stored password should be upgraded to latest encoding.

Parameters:

encodedPassword - the previously encoded password

Returns:

true if password is stored in an old format and should be upgraded

checkPasswordFormat

public abstract void checkPasswordFormat(java.lang.String userid,
                                         java.lang.String password,
                                         PropertyList properties)
                                  throws SapphireException

Returns whether the password is a valid password for the current user

Parameters:

userid - id of the user

password - password to be checked

Throws:

SapphireException - Throw an exception if not a valid password - message should be message to display to user.

generatePassword

public java.lang.String generatePassword(PropertyList properties)