planetj.dataengine.security.http
Class DBPersonalConnectionPoolSignOn

java.lang.Object
  planetj.dataengine.security.http.GenericSignOn
      planetj.dataengine.security.http.DBPersonalConnectionPoolSignOn

All Implemented Interfaces:

ISignOn, java.io.Serializable

public class DBPersonalConnectionPoolSignOn

extends GenericSignOn

Verifies signon information by trying to connect to the database. A successful sign on results in a new connection pool being created which will only be used by a single user.

See Also:

Serialized Form

Field Summary

Fields inherited from interface planetj.dataengine.security.http.ISignOn

GLOBAL_SIGNON_KEY_OPERATION_ID, GLOBAL_SIGNON_KEY_SYSTEM_ALIAS, TIMEOUT_SECONDS

Constructor Summary

DBPersonalConnectionPoolSignOn()
DBPersonalConnectionPoolSignOn constructor

Method Summary

void	prepareForSignOn(ISecured secured, HttpServletRequest request, HttpServletResponse response) If any subclasses need to do anything special before sign on, they can override this method and call it accordingly.
void	sessionExpired(SignOnReceipt pReceipt) This method is invoked when the session in which a SignOnReceipt is stored expires.
void	signOff(java.lang.String pUserId, ISecured pSecuredApp, HttpServletRequest pReq) Signs the user off of the secured application.
boolean	signOn(java.lang.String pUserId, java.lang.String pPassword, ISecured pSecuredApplication, HttpServletRequest pReq) Signs on to a Secured Application..

Methods inherited from class planetj.dataengine.security.http.GenericSignOn

getFailureMessage, getMaximumSignOnFailures, getSignOnURI, isAdditionalSignOnRequired, isAlreadySignedOn, isUserPromptRequired, processSignOnAttemptsExhausted, updateProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

DBPersonalConnectionPoolSignOn

public DBPersonalConnectionPoolSignOn()

DBPersonalConnectionPoolSignOn constructor

Method Detail

prepareForSignOn

public void prepareForSignOn(ISecured secured,
                             HttpServletRequest request,
                             HttpServletResponse response)
                      throws CMException

Description copied from class: GenericSignOn

If any subclasses need to do anything special before sign on, they can override this method and call it accordingly.

Specified by:

prepareForSignOn in interface ISignOn

Overrides:

prepareForSignOn in class GenericSignOn

Throws:

CMException

sessionExpired

public void sessionExpired(SignOnReceipt pReceipt)

This method is invoked when the session in which a SignOnReceipt is stored expires.

Specified by:

sessionExpired in interface ISignOn

Overrides:

sessionExpired in class GenericSignOn

signOff

public void signOff(java.lang.String pUserId,
                    ISecured pSecuredApp,
                    HttpServletRequest pReq)
             throws CMException

Signs the user off of the secured application. This is an optional method - it is okay to provide an empty implementation. Keep in mind that this method may never be invoked since the user may stop using the secured application without logging off.

Specified by:

signOff in interface ISignOn

Overrides:

signOff in class GenericSignOn

Throws:

CMException

signOn

public boolean signOn(java.lang.String pUserId,
                      java.lang.String pPassword,
                      ISecured pSecuredApplication,
                      HttpServletRequest pReq)
               throws CMException

Signs on to a Secured Application.. This method is only invoked if the user has not already signed on. As part of the sign on process, a SignOnReceipt object should be created and stored in the session using the setSignOnReceipt() method. In addition, this method should initialize any connection pools that will be used by the application.

Parameters:

pUserId - The user id identifying the user signing on to the application

pPassword - The password for signing on to the application

pSecuredApplication - The Secured Application object representing the application which is being signed on to.

pReq - The HttpServletRequest representing the http request of the user. Additional sign on information can be stored as attributes in the request

Returns:

If the sign on was successful true should be returned. A return value of false or a thrown CMException indicates that the sign on failed.

Throws:

CMException