BasicAuthenticationDetailsProvider (Oracle Cloud Infrastructure Java SDK - 3.63.0)

All Superinterfaces:

AbstractAuthenticationDetailsProvider

All Known Subinterfaces:

AuthenticationDetailsProvider, BasicConfigFileAuthenticationProvider

All Known Implementing Classes:

AbstractRequestingAuthenticationDetailsProvider, ConfigFileAuthenticationDetailsProvider, ConfigFileAuthenticationDetailsProvider.ConfigFileInstancePrincipalAuthenticationDetailsProvider, ConfigFileAuthenticationDetailsProvider.ConfigFileResourcePrincipalAuthenticationDetailsProvider, ConfigFileAuthenticationDetailsProvider.ConfigFileSimpleAuthenticationDetailsProvider, CustomerAuthenticationDetailsProvider, InstancePrincipalsAuthenticationDetailsProvider, KeyPairAuthenticationDetailProvider, ResourcePrincipalAuthenticationDetailsProvider, ResourcePrincipalsV3AuthenticationDetailsProvider, SessionTokenAuthenticationDetailsProvider, SimpleAuthenticationDetailsProvider
```
public interface BasicAuthenticationDetailsProvider
extends AbstractAuthenticationDetailsProvider
```
Base interface used provide required information to sign requests to Oracle Cloud Infrastructure.
Implementations may choose to provide hints about the cacheability of the keyId and privateKey using AuthCachingPolicy (optional).

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`getKeyId()`	Returns the keyId used to sign requests.
`String`	`getPassPhrase()`	Deprecated. Use getPassphraseCharacters instead
`char[]`	`getPassphraseCharacters()`	Returns the optional pass phrase for the (encrypted) private key, as a character array.
`InputStream`	`getPrivateKey()`	Returns a new InputStream to the private key.

- Method Detail
  - getKeyId
```
String getKeyId()
```
    Returns the keyId used to sign requests.
    
    Returns:
    
    The keyId.
  - getPrivateKey
```
InputStream getPrivateKey()
```
    Returns a new InputStream to the private key.
    This stream should be closed by the caller, implementations should return new streams each time.
    
    Returns:
    
    A new InputStream.
  - getPassPhrase
```
@Deprecated
String getPassPhrase()
```
    Deprecated.
    Use getPassphraseCharacters instead
    
    Returns the optional pass phrase for the (encrypted) private key.
    
    Returns:
    
    The pass phrase, or null if not applicable
  - getPassphraseCharacters
```
char[] getPassphraseCharacters()
```
    Returns the optional pass phrase for the (encrypted) private key, as a character array.
    
    Returns:
    
    The pass phrase as character array, or null if not applicable