Module org.elasticsearch.security

Package org.elasticsearch.xpack.security.authc

Class UserToken

java.lang.Object

org.elasticsearch.xpack.security.authc.UserToken

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public final class UserToken
extends Object
implements Writeable, ToXContentObject

This token is a combination of a Authentication object with an expiry. This token can be serialized for use later. Note, if serializing this token to a entity outside of the cluster, care must be taken to encrypt and validate the serialized bytes or they cannot be trusted. Additionally, care must also be used when transporting these tokens as a stolen token can be used by an adversary to gain access. For this reason, TLS must be enabled for these tokens to be used.

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 inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
String	getId()	The ID of this token
Map<String,Object>	getMetadata()	The metadata associated with this token
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getId

public String getId()

The ID of this token

getMetadata

public Map<String,Object> getMetadata()

The metadata associated with this token

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException