Package org.opensearch.common.settings

Interface SecureSettings

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

KeyStoreWrapper

@PublicApi(since="1.0.0")
public interface SecureSettings
extends Closeable

An accessor for settings which are securely stored. See SecureSetting.

Opensearch.api:

Method Summary

Modifier and Type	Method	Description
void	close()
InputStream	getFile(String setting)	Return a file setting.
Set<String>	getSettingNames()	Returns the names of all secure settings available.
byte[]	getSHA256Digest(String setting)
org.opensearch.core.common.settings.SecureString	getString(String setting)	Return a string setting.
boolean	isLoaded()	Returns true iff the settings are loaded and retrievable.

Method Details

isLoaded

boolean isLoaded()

Returns true iff the settings are loaded and retrievable.

getSettingNames

Set<String> getSettingNames()

Returns the names of all secure settings available.

getString

org.opensearch.core.common.settings.SecureString getString(String setting)
                                                    throws GeneralSecurityException

Return a string setting. The SecureString should be closed once it is used.

Throws:

GeneralSecurityException

getFile

InputStream getFile(String setting)
             throws GeneralSecurityException

Return a file setting. The InputStream should be closed once it is used.

Throws:

GeneralSecurityException

getSHA256Digest

byte[] getSHA256Digest(String setting)
                throws GeneralSecurityException

Throws:

GeneralSecurityException

close

void close()
    throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException