Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.security.authc.support

Class TokensInvalidationResult

java.lang.Object

org.elasticsearch.xpack.core.security.authc.support.TokensInvalidationResult

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class TokensInvalidationResult
extends Object
implements ToXContentObject, Writeable

The result of attempting to invalidate one or multiple tokens. The result contains information about:

• how many of the tokens were actually invalidated
• how many tokens are not invalidated in this request because they were already invalidated
• how many errors were encountered while invalidating tokens and the error details

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

Constructor Summary

Constructors

Constructor	Description
TokensInvalidationResult(List<String> invalidatedTokens, List<String> previouslyInvalidatedTokens, List<ElasticsearchException> errors, RestStatus restStatus)
TokensInvalidationResult(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static TokensInvalidationResult	emptyResult(RestStatus restStatus)
List<ElasticsearchException>	getErrors()
List<String>	getInvalidatedTokens()
List<String>	getPreviouslyInvalidatedTokens()
RestStatus	getRestStatus()
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

Constructor Details

TokensInvalidationResult

public TokensInvalidationResult(List<String> invalidatedTokens,
 List<String> previouslyInvalidatedTokens,
 @Nullable
 List<ElasticsearchException> errors,
 RestStatus restStatus)

TokensInvalidationResult

public TokensInvalidationResult(StreamInput in)
                         throws IOException

Throws:

IOException

Method Details

emptyResult

public static TokensInvalidationResult emptyResult(RestStatus restStatus)

getInvalidatedTokens

public List<String> getInvalidatedTokens()

getPreviouslyInvalidatedTokens

public List<String> getPreviouslyInvalidatedTokens()

getErrors

public List<ElasticsearchException> getErrors()

getRestStatus

public RestStatus getRestStatus()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException