Module org.elasticsearch.server

Package org.elasticsearch.common.settings

Class ProjectSecrets

java.lang.Object

org.elasticsearch.cluster.AbstractNamedDiffable<Metadata.ProjectCustom>

org.elasticsearch.common.settings.ProjectSecrets

All Implemented Interfaces:

Diffable<Metadata.ProjectCustom>, Metadata.MetadataCustom<Metadata.ProjectCustom>, Metadata.ProjectCustom, NamedDiffable<Metadata.ProjectCustom>, NamedWriteable, VersionedNamedWriteable, Writeable, ChunkedToXContent

public class ProjectSecrets
extends AbstractNamedDiffable<Metadata.ProjectCustom>
implements Metadata.ProjectCustom

Secrets that are stored in project state as a Metadata.ProjectCustom

Project state secrets are initially loaded on the master node, from a file on disk. Once the cluster is running, the master node watches the file for changes. This class propagates changes in the file-based secure settings for each project from the master node out to other nodes using the transport protocol.

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 Metadata.ProjectCustom as a "private custom" object by not serializing its content in toXContentChunked(ToXContent.Params).

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	TYPE

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
ProjectSecrets(StreamInput in)
ProjectSecrets(SecureClusterStateSettings settings)

Method Summary

Modifier and Type	Method	Description
EnumSet<Metadata.XContentContext>	context()
boolean	equals(Object o)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to.
Set<String>	getSettingNames()
SecureSettings	getSettings()
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
static NamedDiff<Metadata.ProjectCustom>	readDiffFrom(StreamInput in)
String	toString()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params params)	Create an iterator of ToXContent chunks for a REST response.
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.cluster.metadata.Metadata.MetadataCustom

isRestorable

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

supportsVersion

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

Constructor Details

ProjectSecrets

public ProjectSecrets(SecureClusterStateSettings settings)

ProjectSecrets

public ProjectSecrets(StreamInput in)
               throws IOException

Throws:

IOException

Method Details

getSettings

public SecureSettings getSettings()

getSettingNames

public Set<String> getSettingNames()

toXContentChunked

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

Description copied from interface: ChunkedToXContent

Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. The last chunk in the iterator must always yield at least one byte of output. See also ChunkedToXContentHelper for some handy utilities.

Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

Specified by:

toXContentChunked in interface ChunkedToXContent

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<Metadata.ProjectCustom> readDiffFrom(StreamInput in)
                                                      throws IOException

Throws:

IOException

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

context

public EnumSet<Metadata.XContentContext> context()

Specified by:

context in interface Metadata.MetadataCustom<Metadata.ProjectCustom>