com.portal.app.comp

Interface AuthModule

public interface AuthModule

This interface enables interaction with 3rd party authentication software. If the property portal.authentication.module is defined, the PIALoginDialog will instantiate the class defined by by that property and pass it the data specified in the login dialog. If additional data is required, the AuthModule implementation can display another dialog to capture that information.

Remember that this may not be the most desirable mechanism for alternative login but the Portal clients require a specific type of authentication with Portal (and possibly the BAS framework) so they must be allowed to authenticate as they normally would.

Implementations of this interface should provide a default constructor as they will be dynamically constructed.

Version:

%version: 2 % %date_modified: Tue Oct 23 18:49:48 2001 %

Author:

kapono

Field Summary

Fields

Modifier and Type	Field and Description
static int	FAILURE_CODE Indicates the secondary login failed.
static String	MODULE_PROPERTY
static int	REDISPLAY_CODE Indicates the Portal login dialog should be redisplayed.
static int	SUCCESS_CODE Indicates the secondary login was successful.

Method Summary

Modifier and Type	Method and Description
int	authenticate(String id, String host, String port) Provides a hook for authentication with an authentication system other than Portal.
void	postInfranetAuthenticate() A hook called after the normal login dialog connects to Portal.

Field Detail

REDISPLAY_CODE

static final int REDISPLAY_CODE

Indicates the Portal login dialog should be redisplayed. There may have been a problem with the data specified.

See Also:

Constant Field Values

FAILURE_CODE

static final int FAILURE_CODE

Indicates the secondary login failed. The application will exit without even attempting to connect to Portal.

See Also:

Constant Field Values

SUCCESS_CODE

static final int SUCCESS_CODE

Indicates the secondary login was successful. A connect attempt will be made to Portal.

See Also:

Constant Field Values

MODULE_PROPERTY

static final String MODULE_PROPERTY

See Also:

Constant Field Values

Method Detail

authenticate

int authenticate(String id,
                 String host,
                 String port)

Provides a hook for authentication with an authentication system other than Portal. The data collected from Portal's login dialog is passed in. The implementation of this module can either use this data to authenticate with the alternate system, or display a secondary dialog to capture additional information.
Once the authentication attempt is completed, this method should return one of three status flags:
REDISPLAY_CODE means the original login dialog should be redisplayed. The user specified data may have been erroneous. Note that no error dialog will be provided before redisplaying the original login dialog
FAILURE_CODE means the authentication attempt failed or reached a maximum retry limit. Upon receipt of this status flag the original login dialog will exit. SUCCESS_CODE means the authentication attempt was successful, and it is ok to attempt to connect to Portal.

Parameters:

id - The login ID specified in the login dialog

id - The CM host specified in the login dialog

id - The port number specified in the login dialog

Returns:

The status from the secondary login attempt. One of REDISPLAY_CODE, FAILURE_CODE, or SUCCESS_CODE

postInfranetAuthenticate

void postInfranetAuthenticate()

A hook called after the normal login dialog connects to Portal. This gives you an opportunity to do anything you need to do post Portal connection but before the main application appears.