Package com.tangosol.net.ssl

Interface KeyStoreLoader

All Known Implementing Classes:

AbstractKeyStoreLoader, EmptyKeyStoreLoader, URLKeyStoreLoader

public interface KeyStoreLoader

A class that can create a KeyStore.

Since:

22.06

Author:

Jonathan Knight 2020.01.25

Method Summary

Modifier and Type	Method	Description
default KeyStore	createKeyStore(String sType)	Create a KeyStore of the specified type.
default boolean	isEnabled()	Return true if this KeyStoreLoader is enabled, or false if KeyStoreLoader should not be used.
default boolean	isRefreshable()	Return true if the KeyStore loaded previously by this loader should be refreshed.
KeyStore	load(String sType, PasswordProvider password)	Load a named KeyStore.
default KeyStore	load(String sType, PasswordProvider password, Certificate[] aCert)	Create a KeyStore and load certs.
default KeyStore	load(String sType, PasswordProvider password, PrivateKey key, PasswordProvider keyPassword, Certificate[] aCert)	Create a KeyStore and load a key and certs.

Method Detail

load

KeyStore load(String sType,
              PasswordProvider password)
       throws GeneralSecurityException,
              IOException

Load a named KeyStore.

Parameters:

sType - the KeyStore type

password - an optional PasswordProvider for the KeyStore password

Returns:

the KeyStore or null if no key could be loaded

Throws:

GeneralSecurityException

IOException

isEnabled

default boolean isEnabled()

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

Returns:

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

isRefreshable

default boolean isRefreshable()

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

Returns:

the default implementation always returns true

createKeyStore

default KeyStore createKeyStore(String sType)
                         throws GeneralSecurityException,
                                IOException

Create a KeyStore of the specified type.

Parameters:

sType - the type of the KeyStore to create

Returns:

a KeyStore of the specified type

Throws:

GeneralSecurityException

IOException

load

default KeyStore load(String sType,
                      PasswordProvider password,
                      PrivateKey key,
                      PasswordProvider keyPassword,
                      Certificate[] aCert)
               throws GeneralSecurityException,
                      IOException

Create a KeyStore and load a key and certs.

Parameters:

sType - the KeyStore type

password - an optional PasswordProvider for the KeyStore password

key - an optional PrivateKey to load into the KeyStore

keyPassword - an optional PasswordProvider for the PrivateKey password

aCert - an optional array of certs to load into the KeyStore

Returns:

the KeyStore or null if no key could be loaded

Throws:

GeneralSecurityException

IOException

load

default KeyStore load(String sType,
                      PasswordProvider password,
                      Certificate[] aCert)
               throws GeneralSecurityException,
                      IOException

Create a KeyStore and load certs.

Parameters:

sType - the KeyStore type

password - an optional PasswordProvider for the KeyStore password

aCert - an array of certs to load into the KeyStore

Returns:

the KeyStore or null if no key could be loaded

Throws:

GeneralSecurityException

IOException