Package com.tangosol.net.ssl

Class AbstractPrivateKeyLoader

java.lang.Object

com.tangosol.net.ssl.AbstractPrivateKeyLoader

All Implemented Interfaces:

PrivateKeyLoader

Direct Known Subclasses:

URLPrivateKeyLoader

public abstract class AbstractPrivateKeyLoader
extends Object
implements PrivateKeyLoader

A base class for PrivateKeyLoader implementations.

Since:

22.06

Author:

Jonathan Knight 2020.01.25

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_sName	The name of the private key to load.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPrivateKeyLoader(String sName)	Create a AbstractPrivateKeyLoader.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
protected abstract InputStream	getInputStream()	Open an InputStream for the specified named resource, which should be the contents of a Java PrivateKey in the format required by this PrivateKeyLoader implementation.
String	getName()	Return the name of the private ky to load.
int	hashCode()
PrivateKey	load(PasswordProvider provider)	Load a named PrivateKey.
protected void	safeClose(Closeable closeable)	Close the specified Closeable, ignoring any errors or the fact that the Closeable may be null.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.tangosol.net.ssl.PrivateKeyLoader

isEnabled, isRefreshable

Field Detail

m_sName

protected final String m_sName

The name of the private key to load.

Constructor Detail

AbstractPrivateKeyLoader

protected AbstractPrivateKeyLoader(String sName)

Create a AbstractPrivateKeyLoader.

Parameters:

sName - the name of the private key to load

Method Detail

load

public PrivateKey load(PasswordProvider provider)
                throws GeneralSecurityException,
                       IOException

Description copied from interface: PrivateKeyLoader

Load a named PrivateKey.

Specified by:

load in interface PrivateKeyLoader

Parameters:

provider - an optional PasswordProvider for encrypted keys

Returns:

the PrivateKey or null if no key could be loaded

Throws:

GeneralSecurityException

IOException

getName

public String getName()

Return the name of the private ky to load.

Returns:

the name of the private ky to load

getInputStream

protected abstract InputStream getInputStream()
                                       throws IOException

Open an InputStream for the specified named resource, which should be the contents of a Java PrivateKey in the format required by this PrivateKeyLoader implementation.

How the InputStream is created based on the name is purely dependent on how subclasses are implemented. For example, the name could be a URL, or it could refer to a name of a secret in some secrets store, etc.

Returns:

an InputStream containing the named resource contents, or null if no InputStream could be opened

Throws:

IOException - if an error occurs creating the InputStream

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

safeClose

protected void safeClose(Closeable closeable)

Close the specified Closeable, ignoring any errors or the fact that the Closeable may be null.

Any exception thrown calling Closeable.close() will be ignored.

Parameters:

closeable - the Closeable to close