planetj.dataengine.security.http
Class OSPlusOperationSignOn

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

All Implemented Interfaces:

ISignOn, java.io.Serializable

public class OSPlusOperationSignOn

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

protected

OSPlusOperationSignOn() OSPlusOperationSignOn constructor comment.

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	runOperation(java.lang.String user, java.lang.String password, ISecured secured, SignOnReceipt receipt, HttpServletRequest request) Attempts to read a property row from the table for the specified user
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, sessionExpired, signOff, updateProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

OSPlusOperationSignOn

protected OSPlusOperationSignOn()

OSPlusOperationSignOn constructor comment.

Method Detail

runOperation

public void runOperation(java.lang.String user,
                         java.lang.String password,
                         ISecured secured,
                         SignOnReceipt receipt,
                         HttpServletRequest request)
                  throws CMException

Attempts to read a property row from the table for the specified user

Throws:

CMException

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 pUserId,
                      java.lang.String pPassword,
                      ISecured pSecuredApplication,
                      HttpServletRequest pReq)
               throws CMException

Description copied from interface: ISignOn

Signs on to a Secured 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 secured application.

Parameters:

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

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

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

See Also:

planetj.dataengine.security.http.ISignOn#signOn(java.lang.String, java.lang.String, planetj.dataengine.security.http.ISecured, javax.servlet.http.HttpServletRequest)