planetj.dataexplorer
Class DXApplicationSignOn

java.lang.Object
  |
  +--planetj.dataengine.security.http.GenericSignOn
        |
        +--planetj.dataexplorer.DXApplicationSignOn

All Implemented Interfaces:

ISignOn, Serializable

public class DXApplicationSignOn

extends GenericSignOn

Author:

PlanetJ Corporation

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

boolean

signOn(String userId, 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, prepareForSignOn, processSignOnAttemptsExhausted, sessionExpired, signOff, updateProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

DXApplicationSignOn

public DXApplicationSignOn()

Method Detail

signOn

public boolean signOn(String userId,
                      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

userId - The user id identifying the user signing on to the application. If the isUserPromptRequired() method returned false, then pUserId will be null

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

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.

CMException