Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.security.cloud

Class PersistedCloudCredential

java.lang.Object

org.elasticsearch.xpack.core.security.cloud.PersistedCloudCredential

All Implemented Interfaces:

Closeable, AutoCloseable, Writeable, Releasable, ToXContent, ToXContentObject

public final class PersistedCloudCredential
extends Object
implements Writeable, ToXContentObject, Releasable

Persistence envelope for a cloud-managed credential, pairing the public API key id with the raw internal API key text. The version field exists so that a future envelope encoding (e.g. an encrypted payload) can be introduced without breaking documents written today.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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 int	CURRENT_VERSION

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
PersistedCloudCredential(String id, SecureString internalApiKey)
PersistedCloudCredential(StreamInput in)

Method Summary

Modifier and Type	Method	Description
void	close()	Releases the underlying SecureString.
boolean	equals(Object o)
static PersistedCloudCredential	fromXContent(XContentParser parser)
int	hashCode()
String	id()
SecureString	internalApiKey()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
int	version()
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

CURRENT_VERSION

public static final int CURRENT_VERSION

See Also:

• Constant Field Values

Constructor Details

PersistedCloudCredential

public PersistedCloudCredential(String id,
 SecureString internalApiKey)

PersistedCloudCredential

public PersistedCloudCredential(StreamInput in)
                         throws IOException

Throws:

IOException

Method Details

version

public int version()

id

public String id()

internalApiKey

public SecureString internalApiKey()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static PersistedCloudCredential fromXContent(XContentParser parser)
                                             throws IOException

Throws:

IOException

close

public void close()

Releases the underlying SecureString.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Releasable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object