All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.beans.samples.dips.sessauth.SAPrincipalQuery

java.lang.Object
   |
   +----com.ibm.beans.samples.dips.sessauth.SAPrincipalQuery

public abstract class SAPrincipalQuery
extends Object
Defines the interface through which information pertaining to a particular principal is queried. This abstract class should be extended to query for a particular principal. The Session Authentication Dip invokes this object's queryForPrincipal() method to initiate validation.

This method should obtain the principal information and invoke the authenticator to validate that principal. The information pertaining to a particular principal might consist of a User ID and Password, for example. A concrete implementation of this class for that principal would prompt the end user to enter a User ID and Password using an AWT dialog, and then invoke the appropriate authenticator to validate the User ID and Password.

See Also:
SAPrincipal, SAAuthenticator, SamplePrincipalQuery

Constructor Index

 o SAPrincipalQuery()

Method Index

 o getImplementation()
Returns the Session Authentication Dip implementation.
 o queryForPrincipal(SAPrincipal)
Queries the principal information and attempts to authenticate it.

Constructors

 o SAPrincipalQuery
 public SAPrincipalQuery()

Methods

 o queryForPrincipal
 public abstract boolean queryForPrincipal(SAPrincipal principal)
Queries the principal information and attempts to authenticate it. The Session Authentication Implementation state regarding the success or failure of authentication is updated based on the return value of this method.

This method obtains the principal information, and then invokes the authenticator to validate that principal. The authenticator is invoked by calling the implementation's doAuthentication() method.

This method must suspend the calling thread until authentication is complete, regardless of whether authentication is successful or not.

Returns:
true to indicate authentication successful, false otherwise.
See Also:
doAuthentication
 o getImplementation
 protected SAImpl getImplementation()
Returns the Session Authentication Dip implementation. This reference can be used to set the value entered by the user for the principal in the implementation, and to invoke the appropriate authenticator on the principal.

Returns:
The Session Authentication Dip implementation.
See Also:
setPrincipal

All Packages  Class Hierarchy  This Package  Previous  Next  Index