Interface PrivateKeyLoader

All Known Implementing Classes:

AbstractPrivateKeyLoader, URLPrivateKeyLoader

public interface PrivateKeyLoader

A class that can create a PrivateKey.

Since:

22.06

Author:

Jonathan Knight 2020.01.25

Method Summary

Modifier and Type	Method	Description
default boolean	isEnabled()	Return true if this PrivateKeyLoader is enabled, or false if PrivateKeyLoader should not be used.
default boolean	isRefreshable()	Return true if the PrivateKey loaded previously by this loader should be refreshed.
PrivateKey	load(PasswordProvider password)	Load a named PrivateKey.

Method Details

load

PrivateKey load(PasswordProvider password)
         throws GeneralSecurityException,
IOException

Load a named PrivateKey.

Parameters:

password - an optional PasswordProvider for encrypted keys

Returns:

the PrivateKey or null if no key could be loaded

Throws:

GeneralSecurityException

IOException

isEnabled

default boolean isEnabled()

Return true if this PrivateKeyLoader is enabled, or false if PrivateKeyLoader should not be used.

Returns:

true if this PrivateKeyLoader is enabled, or false if PrivateKeyLoader should not be used

isRefreshable

default boolean isRefreshable()

Return true if the PrivateKey loaded previously by this loader should be refreshed.

Returns:

the default implementation always returns true