Top Description Methods
com.oracle.bmc.auth

public Interface BasicAuthenticationDetailsProvider

extends AbstractAuthenticationDetailsProvider
Known Direct Subinterfaces
com.oracle.bmc.auth.AuthenticationDetailsProvider
Known Direct Implementers
com.oracle.bmc.auth.internal.KeyPairAuthenticationDetailProvider, com.oracle.bmc.auth.AbstractRequestingAuthenticationDetailsProvider
Imports
java.io.InputStream

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

Modifier and TypeMethod and Description
public String

Returns:

The keyId.
getKeyId
()

Returns the keyId used to sign requests.

public String

Returns:

The pass phrase, or null if not applicable
getPassPhrase
()
Deprecated Use getPassphraseCharacters instead

Returns the optional pass phrase for the (encrypted) private key.

public char[]

Returns:

The pass phrase as character array, or null if not applicable
getPassphraseCharacters
()

Returns the optional pass phrase for the (encrypted) private key, as a character array.

public InputStream

Returns:

A new InputStream.
getPrivateKey
()

Returns a new InputStream to the private key.

Method Detail

getKeyIdback to summary
public String getKeyId()

Returns the keyId used to sign requests.

Returns:String

The keyId.

getPassPhraseback to summary
public String getPassPhrase()

Deprecated

Use getPassphraseCharacters instead

Returns the optional pass phrase for the (encrypted) private key.

Returns:String

The pass phrase, or null if not applicable

Annotations
@Deprecated
getPassphraseCharactersback to summary
public char[] getPassphraseCharacters()

Returns the optional pass phrase for the (encrypted) private key, as a character array.

Returns:char[]

The pass phrase as character array, or null if not applicable

getPrivateKeyback to summary
public 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:InputStream

A new InputStream.