com.bankframe.services.authentication
Class AuthenticationBean

java.lang.Object
  |
  +--com.bankframe.ejb.ESessionBean
        |
        +--com.bankframe.services.authentication.AuthenticationBean

All Implemented Interfaces:

javax.ejb.EnterpriseBean, ESession, java.io.Serializable, javax.ejb.SessionBean

Direct Known Subclasses:

EJBUserAuthenticationBean, LDAPAuthenticationBean

public abstract class AuthenticationBean

extends ESessionBean

This class is the base class for all authentication session beans. Authentication beans are used to authenticate users with BankFrame MCA. Authentication beans must implement the processLogon() and processLogoff() methods. The processLogon() method must throw an AuthenticationException if authentication fails. If authentication is successful then it must return a vector of DataPackets to be returned to the client. The first DataPacket in the returned vector must contain an AuthenticationUtils.USER_ID field. The value of this field must be the unique user id of the authenticated user.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.bankframe.ejb.ESession

serialVersionUID

Constructor Summary

AuthenticationBean()
This constructor calls the super class constructor.

Method Summary

java.util.Vector	processDataPacket(DataPacket data) This method checks if the incoming request is a logon or logoff request and passes the request on to processLogon() or processLogoff(), as appropriate.
abstract java.util.Vector	processLogoff(DataPacket data) This method is called whenever a user attempts to logoff.
abstract java.util.Vector	processLogon(DataPacket data) This method is responsible for retrieving the authentication information from the DataPacket passed in and verifying that the information is correct.

Methods inherited from class com.bankframe.ejb.ESessionBean

audit, ejbActivate, ejbCreate, ejbLoad, ejbPassivate, ejbPostCreate, ejbRemove, ejbStore, getSessionContext, processDataPackets, setSessionContext, unsetSessionContext

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationBean

public AuthenticationBean()

This constructor calls the super class constructor.

Method Detail

processDataPacket

public java.util.Vector processDataPacket(DataPacket data)
                                   throws java.rmi.RemoteException,
                                          ProcessingErrorException

This method checks if the incoming request is a logon or logoff request and passes the request on to processLogon() or processLogoff(), as appropriate.

Specified by:

processDataPacket in interface ESession

Specified by:

processDataPacket in class ESessionBean

Parameters:

data - the incomin request

Returns:

a vector of DataPackets

Throws:

ProcessingErrorException - if the request cannot be processed

RemoteException - if a remote communication error occurs

processLogoff

public abstract java.util.Vector processLogoff(DataPacket data)
                                        throws ProcessingErrorException

This method is called whenever a user attempts to logoff. It allows the custom authentication mechanism to be notified when the user logs off, and to perform any clean ups that need to be carried out.

Parameters:

data - the logoff request to process

Returns:

a vector of DataPackets

Throws:

ProcessingErrorException - if the logoff request cannot be processed

processLogon

public abstract java.util.Vector processLogon(DataPacket data)
                                       throws AuthenticationException

This method is responsible for retrieving the authentication information from the DataPacket passed in and verifying that the information is correct.

Parameters:

data - the logon request to process

Returns:

a reponse vector of DataPackets

Throws:

AuthenticationException - if the logon request cannot be authenticated