Modifier and Type	Class and Description
protected abstract static class	AbstractRequestingAuthenticationDetailsProvider.Builder< builder class B extends AbstractRequestingAuthenticationDetailsProvider.Builder<B>> Base class for builders.
protected static class	AbstractRequestingAuthenticationDetailsProvider.CachingSessionKeySupplier Helper class to cache the private key as bytes so we don't have to parse it every time.

Modifier and Type	Field and Description
protected final FederationClient	federationClient
protected final AbstractRequestingAuthenticationDetailsProvider.CachingSessionKeySupplier	sessionKeySupplier

Access	Constructor and Description
public	AbstractRequestingAuthenticationDetailsProvider(FederationClient federationClient, SessionKeySupplier sessionKeySupplier)

Method Summary

Modifier and Type	Method and Description
public String	getKeyId() Implements com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getKeyId. Returns the keyId used to sign requests.
public String	getPassPhrase() Implements com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getPassPhrase. Deprecated 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() Implements com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getPassphraseCharacters. Returns the optional pass phrase for the (encrypted) private key, as a character array.
public InputStream	getPrivateKey() Implements com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getPrivateKey. Returns a new InputStream to the private key.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

federationClient	back to summary
protected final FederationClient federationClient

sessionKeySupplier	back to summary
protected final AbstractRequestingAuthenticationDetailsProvider.CachingSessionKeySupplier sessionKeySupplier

AbstractRequestingAuthenticationDetailsProvider	back to summary
public AbstractRequestingAuthenticationDetailsProvider(FederationClient federationClient, SessionKeySupplier sessionKeySupplier)

Method Detail

getKeyId	back to summary
public String getKeyId() Implements com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getKeyId. Doc from com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getKeyId. Returns the keyId used to sign requests. Returns:String The keyId. Annotations @Override

getKeyId

back to summary

public String getKeyId()

Implements com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getKeyId.

Doc from com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getKeyId.

Returns the keyId used to sign requests.

Returns:String

The keyId.

Annotations

@Override

getPassPhrase	back to summary
public String getPassPhrase() Implements com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getPassPhrase. Doc from com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getPassPhrase. Deprecated Returns the optional pass phrase for the (encrypted) private key. Returns:String The pass phrase, or null if not applicable Annotations @Deprecated @Override

getPassPhrase

back to summary

public String getPassPhrase()

Implements com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getPassPhrase.

Doc from com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getPassPhrase.

Deprecated

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

Returns:String

The pass phrase, or null if not applicable

Annotations

@Deprecated
@Override

getPassphraseCharacters	back to summary
public char[] getPassphraseCharacters() Implements com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.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 Annotations @Override

getPassphraseCharacters

back to summary

public char[] getPassphraseCharacters()

Implements com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.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

Annotations

@Override

getPrivateKey	back to summary
public InputStream getPrivateKey() Implements com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getPrivateKey. Doc from com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.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. Annotations @Override

getPrivateKey

back to summary

public InputStream getPrivateKey()

Implements com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getPrivateKey.

Doc from com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.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.

Annotations

@Override

com.oracle.bmc.auth back to summary

protected abstract Class AbstractRequestingAuthenticationDetailsProvider.Builder<B extends AbstractRequestingAuthenticationDetailsProvider.Builder<B>>

Class Inheritance

extends Object

java.lang.Object
com.oracle.bmc.auth.AbstractRequestingAuthenticationDetailsProvider.Builder

Known Direct Subclasses

com.oracle.bmc.auth.AbstractFederationClientAuthenticationDetailsProviderBuilder

Type Parameters

<B>: builder class

Base class for builders.

Field Summary

Modifier and Type	Field and Description
protected List<ClientConfigurator>	additionalFederationClientConfigurators
protected FederationClient	federationClient
protected ClientConfigurator	federationClientConfigurator
protected Set<X509CertificateSupplier>	intermediateCertificateSuppliers
protected SessionKeySupplier	sessionKeySupplier

Constructor Summary

Access	Constructor and Description
protected	Builder()

Method Summary

Modifier and Type	Method and Description
public B	Returns: this builder additionalFederationClientConfigurator(ClientConfigurator the additional client configurator additionalClientConfigurator) Add an additional client configurator to be run after the primary configurator.
public B	federationClientConfigurator(ClientConfigurator clientConfigurator) Configures the ClientConfigurator to set on the REST client used by the federation client, if any.
public B	intermediateCertificateSuppliers(Set<X509CertificateSupplier> intermediateCertificateSuppliers) Configures the set of intermediate certificate suppliers to use, if any.
public B	sessionKeySupplier(SessionKeySupplier sessionKeySupplier) Configures the custom SessionKeySupplier to use.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

additionalFederationClientConfigurators	back to summary
protected List<ClientConfigurator> additionalFederationClientConfigurators

federationClient	back to summary
protected FederationClient federationClient

federationClientConfigurator	back to summary
protected ClientConfigurator federationClientConfigurator

intermediateCertificateSuppliers	back to summary
protected Set<X509CertificateSupplier> intermediateCertificateSuppliers

sessionKeySupplier	back to summary
protected SessionKeySupplier sessionKeySupplier

Constructor Detail

Builder	back to summary
protected Builder()

Method Detail

additionalFederationClientConfigurator	back to summary
public B additionalFederationClientConfigurator(ClientConfigurator additionalClientConfigurator) Add an additional client configurator to be run after the primary configurator. Parameters additionalClientConfigurator:ClientConfigurator the additional client configurator Returns:B this builder

additionalFederationClientConfigurator

back to summary

public B additionalFederationClientConfigurator(ClientConfigurator additionalClientConfigurator)

Add an additional client configurator to be run after the primary configurator.

Parameters

additionalClientConfigurator:ClientConfigurator: the additional client configurator

Returns:B

this builder

federationClientConfigurator	back to summary
public B federationClientConfigurator(ClientConfigurator clientConfigurator) Configures the ClientConfigurator to set on the REST client used by the federation client, if any.

intermediateCertificateSuppliers	back to summary
public B intermediateCertificateSuppliers(Set<X509CertificateSupplier> intermediateCertificateSuppliers) Configures the set of intermediate certificate suppliers to use, if any.

sessionKeySupplier	back to summary
public B sessionKeySupplier(SessionKeySupplier sessionKeySupplier) Configures the custom SessionKeySupplier to use.

com.oracle.bmc.auth back to summary

protected Class AbstractRequestingAuthenticationDetailsProvider.CachingSessionKeySupplier

Class Inheritance

extends Object
implements SessionKeySupplier

java.lang.Object
com.oracle.bmc.auth.AbstractRequestingAuthenticationDetailsProvider.CachingSessionKeySupplier

All Implemented Interfaces

com.oracle.bmc.auth.SessionKeySupplier

Helper class to cache the private key as bytes so we don't have to parse it every time. The key only changes during calls to refresh.

All methods in this class that are called outside of this class should be synchronized.

Field Summary

Modifier and Type	Field and Description
private final SessionKeySupplier	delegate
private RSAPrivateKey	lastPrivateKey
private byte[]	privateKeyBytes

Constructor Summary

Access	Constructor and Description
protected	CachingSessionKeySupplier(final SessionKeySupplier delegate)

Method Summary

Modifier and Type	Method and Description
public KeyPair	getKeyPair() Implements com.oracle.bmc.auth.SessionKeySupplier.getKeyPair. Returns the current RSA key pair.
protected synchronized byte[]	getPrivateKeyBytes()
public synchronized void	refreshKeys() Implements com.oracle.bmc.auth.SessionKeySupplier.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.
private void	setPrivateKeyBytes(RSAPrivateKey privateKey)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

delegate	back to summary
private final SessionKeySupplier delegate

lastPrivateKey	back to summary
private RSAPrivateKey lastPrivateKey

privateKeyBytes	back to summary
private byte[] privateKeyBytes

Constructor Detail

CachingSessionKeySupplier	back to summary
protected CachingSessionKeySupplier(final SessionKeySupplier delegate)

Method Detail

getKeyPair	back to summary
public KeyPair getKeyPair() Implements com.oracle.bmc.auth.SessionKeySupplier.getKeyPair. Doc from com.oracle.bmc.auth.SessionKeySupplier.getKeyPair. Returns the current RSA key pair. Returns:KeyPair The RSA key pair. Annotations @Override

getKeyPair

back to summary

public KeyPair getKeyPair()

Implements com.oracle.bmc.auth.SessionKeySupplier.getKeyPair.

Doc from com.oracle.bmc.auth.SessionKeySupplier.getKeyPair.

Returns the current RSA key pair.

Returns:KeyPair

The RSA key pair.

Annotations

@Override

getPrivateKeyBytes	back to summary
protected synchronized byte[] getPrivateKeyBytes()

refreshKeys	back to summary
public synchronized void refreshKeys() Implements com.oracle.bmc.auth.SessionKeySupplier.refreshKeys. Doc from com.oracle.bmc.auth.SessionKeySupplier.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 Annotations @Override

refreshKeys

back to summary

public synchronized void refreshKeys()

Implements com.oracle.bmc.auth.SessionKeySupplier.refreshKeys.

Doc from com.oracle.bmc.auth.SessionKeySupplier.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

Annotations

@Override

setPrivateKeyBytes	back to summary
private void setPrivateKeyBytes(RSAPrivateKey privateKey)

public Class AbstractRequestingAuthenticationDetailsProvider

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected abstract Class AbstractRequestingAuthenticationDetailsProvider.Builder<B extends AbstractRequestingAuthenticationDetailsProvider.Builder<B>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class AbstractRequestingAuthenticationDetailsProvider.CachingSessionKeySupplier

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail