Module org.elasticsearch.server

Package org.elasticsearch.common.settings

Class StatelessSecureSettings

java.lang.Object

org.elasticsearch.common.settings.StatelessSecureSettings

All Implemented Interfaces:

Closeable, AutoCloseable, Writeable, SecureSettings

public class StatelessSecureSettings
extends Object
implements SecureSettings

An implementation of secure settings from YML settings. WARNING: this is a temporary class only for Stateless. It applies only to YML settings with a predetermined prefix.

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.
static Settings	install(Settings settings)
boolean	isLoaded()	Returns true iff the settings are loaded and retrievable.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Method Details

install

public static Settings install(Settings settings)

isLoaded

public boolean isLoaded()

Description copied from interface: SecureSettings

Returns true iff the settings are loaded and retrievable.

Specified by:

isLoaded in interface SecureSettings

getSettingNames

public Set<String> getSettingNames()

Description copied from interface: SecureSettings

Returns the names of all secure settings available.

Specified by:

getSettingNames in interface SecureSettings

getString

public SecureString getString(String setting)

Description copied from interface: SecureSettings

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

Specified by:

getString in interface SecureSettings

getFile

public InputStream getFile(String setting)
                    throws GeneralSecurityException

Description copied from interface: SecureSettings

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

Specified by:

getFile in interface SecureSettings

Throws:

GeneralSecurityException

getSHA256Digest

public byte[] getSHA256Digest(String setting)

Specified by:

getSHA256Digest in interface SecureSettings

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface SecureSettings

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException