AS400BasicAuthenticationCredential

All Known Implementing Classes:

ProfileTokenCredential
```
public interface AS400BasicAuthenticationCredential
```
The AS400BasicAuthenticationCredential interface defines IBM i credentials that can be exploited by authentication services that rely on basic user and password authentication.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.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, char[] password, boolean isPrivate, boolean isReusable, boolean isRenewable, int timeoutInterval)` Initializes and validates a credential for the local IBM i system.
`void`	`initialize(AS400BasicAuthenticationPrincipal principal, java.lang.String password, boolean isPrivate, boolean isReusable, boolean isRenewable, int timeoutInterval)` Initializes and validates a credential for the local IBM i system.
`boolean`	`isPrivate()` Indicates whether the credential is considered private.

- Method Detail
  - basicAuthenticationPrompt
```
java.lang.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
```
void initialize(AS400BasicAuthenticationPrincipal principal,
              java.lang.String password,
              boolean isPrivate,
              boolean isReusable,
              boolean isRenewable,
              int timeoutInterval)
                throws java.lang.Exception
```
    Initializes and validates a credential for the local IBM i 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:
    
    java.lang.Exception - If an exception occurs.
  - initialize
```
void initialize(AS400BasicAuthenticationPrincipal principal,
              char[] password,
              boolean isPrivate,
              boolean isReusable,
              boolean isRenewable,
              int timeoutInterval)
                throws java.lang.Exception
```
    Initializes and validates a credential for the local IBM i 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:
    
    java.lang.Exception - If an exception occurs.
  - isPrivate
```
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.

basicAuthenticationPrompt

initialize

initialize

isPrivate