com.oracle.bmc.auth

Interface SessionKeySupplier

All Known Implementing Classes:

AbstractRequestingAuthenticationDetailsProvider.CachingSessionKeySupplier, FileBasedKeySupplier, FixedContentKeySupplier

public interface SessionKeySupplier

A session key supplier is responsible for providing public/private key pairs that will be used to both fetch federated service tokens and to sign individual requests to OCI.

The returned keys should not change unless there as been a call to refreshKeys().

Method Summary

Modifier and Type	Method and Description
KeyPair	getKeyPair() Returns the current RSA key pair.
RSAPrivateKey	getPrivateKey() Deprecated. use getKeyPair instead
RSAPublicKey	getPublicKey() Deprecated. use getKeyPair instead
void	refreshKeys() If the auth service-issued security token expires, the federation client will try to re-generate a new set of keys by calling this method.

Method Detail

getKeyPair

KeyPair getKeyPair()

Returns the current RSA key pair.

Returns:

The RSA key pair.

getPublicKey

@Deprecated
RSAPublicKey getPublicKey()

Deprecated. use getKeyPair instead

Gets the public key

Returns:

the public key, not null

getPrivateKey

@Deprecated
RSAPrivateKey getPrivateKey()

Deprecated. use getKeyPair instead

Gets the private key

Returns:

the private key, not null

refreshKeys

void refreshKeys()

If the auth service-issued security token expires, the federation client will try to re-generate a new set of keys by calling this method. The implementer should create a new pair of keys for security reasons.

Refreshing keys should not be a long-running blocking call. You can refresh keys in an async thread and return from this method immediately. When the async process is done refreshing the keys, the client code will automatically pick up the latest set of keys and update the security token accordingly