Package org.elasticsearch.client.security

Class CreateTokenRequest

java.lang.Object

org.elasticsearch.client.security.CreateTokenRequest

All Implemented Interfaces:

Validatable, ToXContent, ToXContentObject

public final class CreateTokenRequest
extends java.lang.Object
implements Validatable, ToXContentObject

Request to create a new OAuth2 token from the Elasticsearch cluster.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Fields inherited from interface org.elasticsearch.client.Validatable

EMPTY

Constructor Summary

Constructors

Constructor	Description
CreateTokenRequest(java.lang.String grantType, java.lang.String scope, java.lang.String username, char[] password, java.lang.String refreshToken)	General purpose constructor.

Method Summary

Modifier and Type	Method	Description
static CreateTokenRequest	clientCredentialsGrant()
boolean	equals(java.lang.Object o)
java.lang.String	getGrantType()
char[]	getPassword()
java.lang.String	getRefreshToken()
java.lang.String	getScope()
java.lang.String	getUsername()
int	hashCode()
static CreateTokenRequest	passwordGrant(java.lang.String username, char[] password)
static CreateTokenRequest	refreshTokenGrant(java.lang.String refreshToken)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.client.Validatable

validate

Constructor Detail

CreateTokenRequest

public CreateTokenRequest(java.lang.String grantType,
                          @Nullable
                          java.lang.String scope,
                          @Nullable
                          java.lang.String username,
                          @Nullable
                          char[] password,
                          @Nullable
                          java.lang.String refreshToken)

General purpose constructor. This constructor is typically not useful, and one of the following factory methods should be used instead:

• passwordGrant(String, char[])
• refreshTokenGrant(String)
• clientCredentialsGrant()

Method Detail

passwordGrant

public static CreateTokenRequest passwordGrant(java.lang.String username,
                                               char[] password)

refreshTokenGrant

public static CreateTokenRequest refreshTokenGrant(java.lang.String refreshToken)

clientCredentialsGrant

public static CreateTokenRequest clientCredentialsGrant()

getGrantType

public java.lang.String getGrantType()

getScope

public java.lang.String getScope()

getUsername

public java.lang.String getUsername()

getPassword

public char[] getPassword()

getRefreshToken

public java.lang.String getRefreshToken()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object