Module org.elasticsearch.server

Package org.elasticsearch.common.settings

Class ClusterSecrets

java.lang.Object

org.elasticsearch.cluster.AbstractNamedDiffable<ClusterState.Custom>

org.elasticsearch.common.settings.ClusterSecrets

All Implemented Interfaces:

ClusterState.Custom, Diffable<ClusterState.Custom>, NamedDiffable<ClusterState.Custom>, NamedWriteable, VersionedNamedWriteable, Writeable, ChunkedToXContent

public class ClusterSecrets
extends AbstractNamedDiffable<ClusterState.Custom>
implements ClusterState.Custom

Secrets that are stored in cluster state.

Cluster state secrets are initially loaded on each node from the cluster_secrets chunk in the reserved state file on disk. The format of that chunk is defined by SecureClusterStateSettings. Once the cluster is running, changes to cluster secrets are propagated by the master node that watches for changes of the reserved state settings file.

Since the master node should always have settings on disk, we don't need to persist this class to saved cluster state, either on disk or in the cloud. Therefore, we have defined this ClusterState.Custom as a private custom object. Additionally, we don't want to ever write this class's secrets out in a client response, so toXContentChunked(ToXContent.Params) returns an empty iterator.

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	The name of the cluster secrets chunk used in the settings state file.
static final String	TYPE	The name for this data class

Fields inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

EMPTY

Constructor Summary

Constructors

Constructor	Description
ClusterSecrets(long version, SecureClusterStateSettings settings)
ClusterSecrets(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	containsSecureSettings(SecureSettings settings)
boolean	equals(Object o)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to.
SecureSettings	getSettings()
long	getVersion()
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
boolean	isPrivate()	Returns true iff this ClusterState.Custom is private to the cluster and should never be sent to a client.
static NamedDiff<ClusterState.Custom>	readDiffFrom(StreamInput in)
String	toString()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params params)	Serialize this ClusterState.Custom for diagnostic purposes, exposed by the
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.cluster.AbstractNamedDiffable

diff, get, readDiffFrom

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

isFragment, toXContentChunked, toXContentChunkedV8

Methods inherited from interface org.elasticsearch.cluster.Diffable

diff

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

supportsVersion

Field Details

NAME

public static final String NAME

The name of the cluster secrets chunk used in the settings state file.

See Also:

• Constant Field Values

TYPE

public static final String TYPE

The name for this data class

This name will be used to identify this NamedWriteable in cluster state. See getWriteableName().

See Also:

• Constant Field Values

Constructor Details

ClusterSecrets

public ClusterSecrets(long version,
 SecureClusterStateSettings settings)

ClusterSecrets

public ClusterSecrets(StreamInput in)
               throws IOException

Throws:

IOException

Method Details

getSettings

public SecureSettings getSettings()

getVersion

public long getVersion()

isPrivate

public boolean isPrivate()

Description copied from interface: ClusterState.Custom

Returns true iff this ClusterState.Custom is private to the cluster and should never be sent to a client. The default is false;

Specified by:

isPrivate in interface ClusterState.Custom

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params)

Description copied from interface: ClusterState.Custom

Serialize this ClusterState.Custom for diagnostic purposes, exposed by the

GET _cluster/state

API etc. The XContent representation does not need to be 100% faithful since we never reconstruct a cluster state from its XContent representation, but the more faithful it is the more useful it is for diagnostics.

Specified by:

toXContentChunked in interface ChunkedToXContent

Specified by:

toXContentChunked in interface ClusterState.Custom

Returns:

iterator over chunks of ToXContent

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to. See VersionedNamedWriteable.supportsVersion(TransportVersion) for the default serialization check.

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

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

readDiffFrom

public static NamedDiff<ClusterState.Custom> readDiffFrom(StreamInput in)
                                                   throws IOException

Throws:

IOException

containsSecureSettings

public boolean containsSecureSettings(SecureSettings settings)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object