planetj.dataexplorer
Class DXApplicationSignOn

java.lang.Object
  planetj.dataengine.security.http.GenericSignOn
      planetj.dataexplorer.DXApplicationSignOn

All Implemented Interfaces:

ISignOn, java.io.Serializable

public class DXApplicationSignOn

extends GenericSignOn

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

DXApplicationSignOn()

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.
boolean	signOn(java.lang.String userId, java.lang.String pPassword, ISecured pSecuredApp, javax.servlet.http.HttpServletRequest pReq) Signs on to an Application.

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

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

Methods inherited from class java.lang.Object

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

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

signOn

Constructor Detail

DXApplicationSignOn

public DXApplicationSignOn()

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

signOn

public boolean signOn(java.lang.String userId,
                      java.lang.String pPassword,
                      ISecured pSecuredApp,
                      javax.servlet.http.HttpServletRequest pReq)
               throws CMException

Signs on to an Application. This method is only invoked if the user has not already signed on. As part of a successful sign on, 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:

pPassword - The password for signing on to the application. If the isUserPromptRequired() method returned false, then pPassword will be null

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