Module org.elasticsearch.server

Package org.elasticsearch.common.settings

Class SecureClusterStateSettings

java.lang.Object

org.elasticsearch.common.settings.SecureClusterStateSettings

All Implemented Interfaces:

Closeable, AutoCloseable, Writeable, SecureSettings

public class SecureClusterStateSettings
extends Object
implements SecureSettings

Implementation of SecureSettings that represents secrets in cluster state. Secrets are stored as byte arrays along with their SHA-256 digests. Provides functionality to read and serialize secure settings to broadcast them as part of cluster state. Does not provide any encryption.

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor	Description
SecureClusterStateSettings(Map<String,byte[]> settings)
SecureClusterStateSettings(SecureSettings secureSettings)

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	equals(Object o)
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.
int	hashCode()
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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SecureClusterStateSettings

public SecureClusterStateSettings(SecureSettings secureSettings)

SecureClusterStateSettings

public SecureClusterStateSettings(Map<String,byte[]> settings)

Method Details

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

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)

Description copied from interface: SecureSettings

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

Specified by:

getFile in interface SecureSettings

getSHA256Digest

public byte[] getSHA256Digest(String setting)

Specified by:

getSHA256Digest in interface SecureSettings

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface SecureSettings

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object