org.elasticsearch.common.settings

Interface SecureSettings

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

KeyStoreWrapper

public interface SecureSettings
extends java.io.Closeable

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

Method Summary

Modifier and Type	Method and Description
void	close()
java.io.InputStream	getFile(java.lang.String setting) Return a file setting.
java.util.Set<java.lang.String>	getSettingNames() Returns the names of all secure settings available.
SecureString	getString(java.lang.String setting) Return a string setting.
boolean	isLoaded() Returns true iff the settings are loaded and retrievable.

Method Detail

isLoaded

boolean isLoaded()

Returns true iff the settings are loaded and retrievable.

getSettingNames

java.util.Set<java.lang.String> getSettingNames()

Returns the names of all secure settings available.

getString

SecureString getString(java.lang.String setting)
                throws java.security.GeneralSecurityException

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

Throws:

java.security.GeneralSecurityException

getFile

java.io.InputStream getFile(java.lang.String setting)
                     throws java.security.GeneralSecurityException

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

Throws:

java.security.GeneralSecurityException

close

void close()
    throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException