com.ibm.as400.security.auth
Interface AS400BasicAuthenticationCredential

All Known Implementing Classes:

ProfileTokenCredential

public interface AS400BasicAuthenticationCredential

The AS400BasicAuthenticationCredential interface defines iSeries credentials that can be exploited by authentication services that rely on basic user and password authentication.

Method Summary

String[]	basicAuthenticationPrompt() Returns text that can be displayed to prompt for the basic user and password information used to initialize the credential.
void	initialize(AS400BasicAuthenticationPrincipal principal, String password, boolean isPrivate, boolean isReusable, boolean isRenewable, int timeoutInterval) Initializes and validates a credential for the local iSeries system.
boolean	isPrivate() Indicates whether the credential is considered private.

Method Detail

basicAuthenticationPrompt

public String[] basicAuthenticationPrompt()

Returns text that can be displayed to prompt for the basic user and password information used to initialize the credential.

Returns:

An array of two Strings. The first string is the text to prompt for the user name; the second is the text to prompt for the password.

initialize

public void initialize(AS400BasicAuthenticationPrincipal principal,
                       String password,
                       boolean isPrivate,
                       boolean isReusable,
                       boolean isRenewable,
                       int timeoutInterval)
                throws Exception

Initializes and validates a credential for the local iSeries system.

Parameters:

principal - The principal identifying the authenticated user.

password - The password for the authenticated user.

isPrivate - Indicates whether the credential is considered private.

isReusable - true if the credential can be used to swap thread identity multiple times; otherwise false.

isRenewable - true if the validity period of the credential can be programmatically updated or extended; otherwise false.

timeoutInterval - The number of seconds to expiration when the credential is initially created; ignored if the credential does not expire based on time.

Throws:

Exception - If an exception occurs.

isPrivate

public boolean isPrivate()

Indicates whether the credential is considered private.

This value can be referenced by authentication services as an indication of when to check permissions or otherwise protect access to sensitive credentials.

Returns:

true if private; false if public.