Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.security.action.apikey

Class InvalidateApiKeyRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.UntypedActionRequest

org.elasticsearch.xpack.core.security.action.apikey.InvalidateApiKeyRequest

All Implemented Interfaces:

Writeable, RefCounted, TaskAwareRequest, TransportRequest

public final class InvalidateApiKeyRequest
extends UntypedActionRequest

Request for invalidating API key(s) so that it can no longer be used

Nested Class Summary

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.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
InvalidateApiKeyRequest()
InvalidateApiKeyRequest(String realmName, String userName, String name, boolean ownedByAuthenticatedUser, String[] ids)
InvalidateApiKeyRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static InvalidateApiKeyRequest	forOwnedApiKeys()	Creates invalidate api key request to invalidate api keys owned by the current authenticated user.
String[]	getIds()
String	getName()
String	getRealmName()
String	getUserName()
int	hashCode()
boolean	ownedByAuthenticatedUser()
static InvalidateApiKeyRequest	usingApiKeyId(String id, boolean ownedByAuthenticatedUser)	Creates invalidate API key request for given api key ids
static InvalidateApiKeyRequest	usingApiKeyIds(String[] ids, boolean ownedByAuthenticatedUser)	Creates invalidate API key request for given api key id
static InvalidateApiKeyRequest	usingApiKeyName(String name, boolean ownedByAuthenticatedUser)	Creates invalidate api key request for given api key name
static InvalidateApiKeyRequest	usingRealmAndUserName(String realmName, String userName)	Creates invalidate API key request for given realm and user name
static InvalidateApiKeyRequest	usingRealmName(String realmName)	Creates invalidate api key request for given realm name
static InvalidateApiKeyRequest	usingUserName(String userName)	Creates invalidate API key request for given user name
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

copyFieldsFrom, getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, createTask, getDescription, setParentTask

Constructor Details

InvalidateApiKeyRequest

public InvalidateApiKeyRequest()

InvalidateApiKeyRequest

public InvalidateApiKeyRequest(StreamInput in)
                        throws IOException

Throws:

IOException

InvalidateApiKeyRequest

public InvalidateApiKeyRequest(@Nullable
 String realmName,
 @Nullable
 String userName,
 @Nullable
 String name,
 boolean ownedByAuthenticatedUser,
 @Nullable
 String[] ids)

Method Details

getRealmName

public String getRealmName()

getUserName

public String getUserName()

getIds

public String[] getIds()

getName

public String getName()

ownedByAuthenticatedUser

public boolean ownedByAuthenticatedUser()

usingRealmName

public static InvalidateApiKeyRequest usingRealmName(String realmName)

Creates invalidate api key request for given realm name

Parameters:

realmName - realm name

Returns:

InvalidateApiKeyRequest

usingUserName

public static InvalidateApiKeyRequest usingUserName(String userName)

Creates invalidate API key request for given user name

Parameters:

userName - user name

Returns:

InvalidateApiKeyRequest

usingRealmAndUserName

public static InvalidateApiKeyRequest usingRealmAndUserName(String realmName,
 String userName)

Creates invalidate API key request for given realm and user name

Parameters:

realmName - realm name

userName - user name

Returns:

InvalidateApiKeyRequest

usingApiKeyId

public static InvalidateApiKeyRequest usingApiKeyId(String id,
 boolean ownedByAuthenticatedUser)

Creates invalidate API key request for given api key ids

Parameters:

id - api key id

ownedByAuthenticatedUser - set true if the request is only for the API keys owned by current authenticated user else false

Returns:

InvalidateApiKeyRequest

usingApiKeyIds

public static InvalidateApiKeyRequest usingApiKeyIds(String[] ids,
 boolean ownedByAuthenticatedUser)

Creates invalidate API key request for given api key id

Parameters:

ids - array of api key ids

ownedByAuthenticatedUser - set true if the request is only for the API keys owned by current authenticated user else false

Returns:

InvalidateApiKeyRequest

usingApiKeyName

public static InvalidateApiKeyRequest usingApiKeyName(String name,
 boolean ownedByAuthenticatedUser)

Creates invalidate api key request for given api key name

Parameters:

name - api key name

ownedByAuthenticatedUser - set true if the request is only for the API keys owned by current authenticated user else false

Returns:

InvalidateApiKeyRequest

forOwnedApiKeys

public static InvalidateApiKeyRequest forOwnedApiKeys()

Creates invalidate api key request to invalidate api keys owned by the current authenticated user.

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object