Package com.oracle.bmc.auth

Class URLBasedX509CertificateSupplier

java.lang.Object

com.oracle.bmc.auth.URLBasedX509CertificateSupplier

All Implemented Interfaces:

X509CertificateSupplier, Refreshable

public class URLBasedX509CertificateSupplier
extends Object
implements X509CertificateSupplier, Refreshable

X509CertificateSupplier implementation that reads both certificate and private key off of URL.

This class also provides a way to manually refresh the certificate and private key at any point.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	URLBasedX509CertificateSupplier.ResourceDetails

Nested classes/interfaces inherited from interface com.oracle.bmc.auth.X509CertificateSupplier

X509CertificateSupplier.CertificateAndPrivateKeyPair

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	CERTIFICATE_URL_CONNECTION_READ_TIMEOUT_IN_MILLIS	Set the environment variables to configure read timeout and connection timeout (in milliseconds) for URL Connection
protected static String	CERTIFICATE_URL_CONNECTION_TIMEOUT_IN_MILLIS

Constructor Summary

Constructors

Constructor	Description
URLBasedX509CertificateSupplier(URLBasedX509CertificateSupplier.ResourceDetails certificateResourceDetails, URLBasedX509CertificateSupplier.ResourceDetails privateKeyResourceDetails, char[] privateKeyPassphraseCharacters)	Constructor.
URLBasedX509CertificateSupplier(URL certificateUrl, URL privateKeyUrl, char[] privateKeyPassphraseCharacters)	Constructor.
URLBasedX509CertificateSupplier(URL certificateUrl, URL privateKeyUrl, String privateKeyPassphrase)	Deprecated. use URLBasedX509CertificateSupplier(URL, URL, char[]) instead

Method Summary

Modifier and Type	Method	Description
X509Certificate	getCertificate()	Deprecated. use X509CertificateSupplier.getCertificateAndKeyPair() instead
X509CertificateSupplier.CertificateAndPrivateKeyPair	getCertificateAndKeyPair()	Returns the X509 certificate and private key.
RSAPrivateKey	getPrivateKey()	Deprecated. use X509CertificateSupplier.getCertificateAndKeyPair() instead
boolean	isCurrent()	So far we don’t care whether the certificate is current or not.
void	refresh()	A method to refresh the X509 certificate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CERTIFICATE_URL_CONNECTION_READ_TIMEOUT_IN_MILLIS

protected static final String CERTIFICATE_URL_CONNECTION_READ_TIMEOUT_IN_MILLIS

Set the environment variables to configure read timeout and connection timeout (in milliseconds) for URL Connection

CERTIFICATE_URL_CONNECTION_TIMEOUT_IN_MILLIS

protected static final String CERTIFICATE_URL_CONNECTION_TIMEOUT_IN_MILLIS

Constructor Detail

URLBasedX509CertificateSupplier

public URLBasedX509CertificateSupplier(URLBasedX509CertificateSupplier.ResourceDetails certificateResourceDetails,
                                       URLBasedX509CertificateSupplier.ResourceDetails privateKeyResourceDetails,
                                       char[] privateKeyPassphraseCharacters)

Constructor.

Parameters:

certificateResourceDetails - The certificate resource details

privateKeyResourceDetails - The private key resource details, may be null for intermediate certificates

privateKeyPassphraseCharacters - The private key passphrase, may be null for unencrypted private keys

URLBasedX509CertificateSupplier

public URLBasedX509CertificateSupplier(URL certificateUrl,
                                       URL privateKeyUrl,
                                       char[] privateKeyPassphraseCharacters)

Constructor.

Parameters:

certificateUrl - The certificate url

privateKeyUrl - The private key url, may be null for intermediate certificates

privateKeyPassphraseCharacters - The private key passphrase, may be null for unencrypted private keys

URLBasedX509CertificateSupplier

@Deprecated
public URLBasedX509CertificateSupplier(URL certificateUrl,
                                       URL privateKeyUrl,
                                       String privateKeyPassphrase)

Deprecated.

use URLBasedX509CertificateSupplier(URL, URL, char[]) instead

Constructor.

Parameters:

certificateUrl - The certificate url

privateKeyUrl - The private key url, may be null for intermediate certificates

privateKeyPassphrase - The private key passphrase, may be null for unencrypted private keys

Method Detail

getCertificate

@Deprecated
public X509Certificate getCertificate()

Deprecated.

use X509CertificateSupplier.getCertificateAndKeyPair() instead

Gets the certificate

Specified by:

getCertificate in interface X509CertificateSupplier

Returns:

The certificate, must not be null

refresh

public void refresh()

A method to refresh the X509 certificate.

Specified by:

refresh in interface Refreshable

isCurrent

public boolean isCurrent()

So far we don’t care whether the certificate is current or not.

Specified by:

isCurrent in interface Refreshable

Returns:

false always.

getPrivateKey

@Deprecated
public RSAPrivateKey getPrivateKey()

Deprecated.

use X509CertificateSupplier.getCertificateAndKeyPair() instead

Corresponding private key of the certificate.

You must implement this method for leaf certificates (to sign the request made to the auth service to get a security token). For intermediate certificates, you can return null.

Specified by:

getPrivateKey in interface X509CertificateSupplier

Returns:

The private key

getCertificateAndKeyPair

public X509CertificateSupplier.CertificateAndPrivateKeyPair getCertificateAndKeyPair()

Returns the X509 certificate and private key.

The X509 certificate will always be valid. The private key may be null for intermediate certificates. For leaf certificates, the private key will always be valid.

Specified by:

getCertificateAndKeyPair in interface X509CertificateSupplier

Returns:

The certificate and private key pair.