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

Class SecretStoreAccessor

java.lang.Object

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

public class SecretStoreAccessor
extends Object

Main class for the secret store functionality.

This class handles the access to the secret and key store by delegating the calls to the underlying SecretStoreFacade.

Constructor Summary

Constructors

Constructor and Description
SecretStoreAccessor()

Method Summary

Modifier and Type	Method and Description
static KeyStore	getKeyStore(String name, SecretStore password) Retrieves a KeyStore by its name.
static Optional<KeyStore>	getKeyStoreIfPresent(String name, SecretStore password) Retrieves a KeyStore by its name, if present.
static SecretStore	getSecretStore(String name) Retrieves a SecretStore by its name.
static SecretStoreFacade	getSecretStoreFacade() Returns the SecretStoreFacade instance.
static Optional<SecretStore>	getSecretStoreIfPresent(String name) Retrieves a SecretStore by its name, if present.
static void	setSecretStoreFacade(SecretStoreFacade secretStoreFacade) Replaces the default SecretStoreFacade instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecretStoreAccessor

public SecretStoreAccessor()

Method Detail

setSecretStoreFacade

public static void setSecretStoreFacade(@Nonnull
                                        SecretStoreFacade secretStoreFacade)

Replaces the default SecretStoreFacade instance. This method is for internal use only.

Parameters:

secretStoreFacade - The facade to replace the current/default one with.

getSecretStore

@Nonnull
public static 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
public static 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
public static 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
public static 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.

getSecretStoreFacade

@Nullable
public static SecretStoreFacade getSecretStoreFacade()

Returns the SecretStoreFacade instance. For internal use only.