sapphire.action

Class BaseAuthentication

java.lang.Object

com.labvantage.sapphire.BaseCustom

sapphire.action.BaseAuthentication

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

Created by IntelliJ IDEA. User: cliu Date: Jul 5, 2005 Time: 2:38:58 PM To change this template use File | Settings | File Templates.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTHENTICATION_FAIL_MESSAGE
protected DBAccess	database
protected java.lang.String	databaseid
static int	FAILURE
static int	SUCCESS
protected javax.naming.directory.Attributes	userAttributes

Fields inherited from class com.labvantage.sapphire.BaseCustom

logger, logName

Constructor Summary

Constructors

Constructor and Description
BaseAuthentication()

Method Summary

Modifier and Type	Method and Description
abstract void	authenticateUser(java.lang.String userid, java.lang.String password, PropertyList properties)
void	createUser(java.lang.String userid, java.lang.String password, PropertyList properties)
void	endAuthenticate()
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)
void	startAuthenticate(java.lang.String databaseid, com.labvantage.sapphire.DBUtil dbutil)
void	synchronizeUser(java.lang.String userid, java.lang.String password, PropertyList properties)

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

AUTHENTICATION_FAIL_MESSAGE

public static final java.lang.String AUTHENTICATION_FAIL_MESSAGE

See Also:

Constant Field Values

database

protected DBAccess database

databaseid

protected java.lang.String databaseid

userAttributes

protected javax.naming.directory.Attributes userAttributes

Constructor Detail

BaseAuthentication

public BaseAuthentication()

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)

startAuthenticate

public void startAuthenticate(java.lang.String databaseid,
                              com.labvantage.sapphire.DBUtil dbutil)
                       throws SapphireException

Throws:

SapphireException

endAuthenticate

public void endAuthenticate()

authenticateUser

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

Parameters:

userid - id of the user

password - password to be checked

properties - configuration properties for third party authentication

Throws:

SapphireException - Throw an exception if authentication failed - message should be message to display to user.

synchronizeUser

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

Parameters:

userid - id of the user

password - password to be checked

properties - configuration properties for third party authentication

Throws:

SapphireException - Throw an exception if synchronization failed, which should fail authentication process - message should be message to display to user.

createUser

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

Parameters:

userid - id of the user

password - password to be checked

properties - configuration properties for third party authentication

Throws:

SapphireException - Throw an exception if creation of a sapphire user failed, which should fail authentication process - message should be message to display to user.