Module org.elasticsearch.server

Package org.elasticsearch.common.settings

Interface SecureSettings

All Superinterfaces:

AutoCloseable, Closeable, Writeable

All Known Implementing Classes:

KeyStoreWrapper, LocallyMountedSecrets, StatelessSecureSettings

public interface SecureSettings
extends Closeable, Writeable

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

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)
SecureString	getString(String setting)	Return a string setting.
boolean	isLoaded()	Returns true iff the settings are loaded and retrievable.

Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

writeTo

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

SecureString getString(String setting)

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

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