com.sap.cloud.sdk.cloudplatform.security.secret

Interface SecretStoreFacade

All Known Implementing Classes:

AbstractSecretStoreFacade

public interface SecretStoreFacade

Facade interface encapsulating the access to concrete SecretStore and KeyStore classes.

Method Summary

Modifier and Type	Method and Description
KeyStore	getKeyStore(String name, SecretStore password) Retrieves a KeyStore by its name.
Optional<KeyStore>	getKeyStoreIfPresent(String name, SecretStore password) Retrieves a KeyStore by its name, if present.
SecretStore	getSecretStore(String name) Retrieves a SecretStore by its name.
Class<? extends SecretStore>	getSecretStoreClass() Returns the platform-specific implementation class of SecretStore.
Optional<SecretStore>	getSecretStoreIfPresent(String name) Retrieves a SecretStore by its name, if present.

Method Detail

getSecretStoreClass

@Nonnull
Class<? extends SecretStore> getSecretStoreClass()

Returns the platform-specific implementation class of SecretStore. For internal use only.

Returns:

The type of the platform-specific implementation.

getSecretStore

@Nonnull
SecretStore getSecretStore(String name)
                             throws SecretStoreNotFoundException,
                                    SecretStoreAccessException

Retrieves a SecretStore by its name.

Parameters:

name - The name identifying a SecretStore.

Returns:

The SecretStore for the given name.

Throws:

SecretStoreNotFoundException - If the SecretStore cannot be found.

SecretStoreAccessException - If there is an issue while accessing the SecretStore.

getSecretStoreIfPresent

@Nonnull
Optional<SecretStore> getSecretStoreIfPresent(String name)
                                                throws SecretStoreAccessException

Retrieves a SecretStore by its name, if present.

Parameters:

name - The name identifying a SecretStore.

Returns:

An Optional of the SecretStore for the given name.

Throws:

SecretStoreAccessException - If there is an issue while accessing the SecretStore.

getKeyStore

@Nonnull
KeyStore getKeyStore(String name,
                              SecretStore password)
                       throws KeyStoreNotFoundException,
                              KeyStoreAccessException

Retrieves a KeyStore by its name.

Parameters:

name - The name identifying a KeyStore.

password - The password to unlock the KeyStore.

Returns:

The KeyStore for the given name.

Throws:

KeyStoreNotFoundException - If the KeyStore cannot be found.

KeyStoreAccessException - If there is an issue while accessing the KeyStore.

getKeyStoreIfPresent

@Nonnull
Optional<KeyStore> getKeyStoreIfPresent(String name,
                                                 SecretStore password)
                                          throws KeyStoreAccessException

Retrieves a KeyStore by its name, if present.

Parameters:

name - The name identifying a KeyStore.

password - The password to unlock the KeyStore.

Returns:

The KeyStore for the given name.

Throws:

KeyStoreAccessException - If there is an issue while accessing the KeyStore.