planetj.dataengine.security.http
Class UserListSignOn

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

All Implemented Interfaces:

ISignOn, java.io.Serializable

public class UserListSignOn

extends GenericSignOn

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_KEY

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

GLOBAL_SIGNON_KEY_OPERATION_ID, GLOBAL_SIGNON_KEY_SYSTEM_ALIAS, TIMEOUT_SECONDS

Constructor Summary

UserListSignOn()

Method Summary

java.lang.String	getUniqueId(java.lang.String userid, ISecured secured, HttpServletRequest req) Gets an id for this userid and secured entity which uniquely identifies this signon attempt.
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	prepareForSignOnOLD(ISecured secured, HttpServletRequest request, HttpServletResponse response)
boolean	signOn(java.lang.String user, java.lang.String password, ISecured secured, HttpServletRequest request) 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

Field Detail

CLASS_KEY

public static final java.lang.String CLASS_KEY

See Also:

Constant Field Values

Constructor Detail

UserListSignOn

public UserListSignOn()

Method Detail

getUniqueId

public java.lang.String getUniqueId(java.lang.String userid,
                                    ISecured secured,
                                    HttpServletRequest req)
                             throws CMException

Gets an id for this userid and secured entity which uniquely identifies this signon attempt. After a succesful signon with this ID occurs, if the same browser session attempts a signon with the same info, signon will occur automatically.

Parameters:

userid - The user id used for signing on

secured - The secured entity being signed onto

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

prepareForSignOnOLD

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

Throws:

CMException

signOn

public boolean signOn(java.lang.String user,
                      java.lang.String password,
                      ISecured secured,
                      HttpServletRequest request)
               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:

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

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

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

request - 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