Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.transform.transforms

Class AuthorizationState

java.lang.Object

org.elasticsearch.xpack.core.transform.transforms.AuthorizationState

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class AuthorizationState
extends Object
implements Writeable, ToXContentObject

AuthorizationState holds the state of the authorization performed in the past. By examining the instance of this class the caller can learn whether or not the user was authorized to access the source/dest indices present in the TransformConfig. This class is immutable.

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 ParseField	LAST_AUTH_ERROR
static final ConstructingObjectParser<AuthorizationState,Void>	PARSER
static final ParseField	STATUS
static final ParseField	TIMESTAMP

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
AuthorizationState(Long timestamp, HealthStatus status, String lastAuthError)
AuthorizationState(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
String	getLastAuthError()
HealthStatus	getStatus()
Instant	getTimestamp()
static AuthorizationState	green()
int	hashCode()
static boolean	isNullOrGreen(AuthorizationState authState)
static AuthorizationState	red(Exception e)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
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

TIMESTAMP

public static final ParseField TIMESTAMP

STATUS

public static final ParseField STATUS

LAST_AUTH_ERROR

public static final ParseField LAST_AUTH_ERROR

PARSER

public static final ConstructingObjectParser<AuthorizationState,Void> PARSER

Constructor Details

AuthorizationState

public AuthorizationState(Long timestamp,
 HealthStatus status,
 @Nullable
 String lastAuthError)

AuthorizationState

public AuthorizationState(StreamInput in)
                   throws IOException

Throws:

IOException

Method Details

green

public static AuthorizationState green()

isNullOrGreen

public static boolean isNullOrGreen(AuthorizationState authState)

red

public static AuthorizationState red(Exception e)

getTimestamp

public Instant getTimestamp()

getStatus

public HealthStatus getStatus()

getLastAuthError

public String getLastAuthError()

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

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object