Module org.elasticsearch.xcore
Class InvalidateApiKeyRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.AbstractTransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.LegacyActionRequest
org.elasticsearch.xpack.core.security.action.apikey.InvalidateApiKeyRequest
- All Implemented Interfaces:
Writeable,org.elasticsearch.core.RefCounted,TaskAwareRequest,TransportRequest
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
ConstructorsConstructorDescriptionInvalidateApiKeyRequest(String realmName, String userName, String name, boolean ownedByAuthenticatedUser, String[] ids) -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic InvalidateApiKeyRequestCreates invalidate api key request to invalidate api keys owned by the current authenticated user.String[]getIds()getName()inthashCode()booleanstatic InvalidateApiKeyRequestusingApiKeyId(String id, boolean ownedByAuthenticatedUser) Creates invalidate API key request for given api key idsstatic InvalidateApiKeyRequestusingApiKeyIds(String[] ids, boolean ownedByAuthenticatedUser) Creates invalidate API key request for given api key idstatic InvalidateApiKeyRequestusingApiKeyName(String name, boolean ownedByAuthenticatedUser) Creates invalidate api key request for given api key namestatic InvalidateApiKeyRequestusingRealmAndUserName(String realmName, String userName) Creates invalidate API key request for given realm and user namestatic InvalidateApiKeyRequestusingRealmName(String realmName) Creates invalidate api key request for given realm namestatic InvalidateApiKeyRequestusingUserName(String userName) Creates invalidate API key request for given user namevalidate()voidwriteTo(StreamOutput out) Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResultMethods inherited from class org.elasticsearch.transport.AbstractTransportRequest
getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toStringMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, tryIncRefMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.core.RefCounted
decRef, hasReferences, incRef, mustIncRef, tryIncRefMethods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, createTask, getDescription, setParentTask
-
Constructor Details
-
InvalidateApiKeyRequest
public InvalidateApiKeyRequest() -
InvalidateApiKeyRequest
- Throws:
IOException
-
InvalidateApiKeyRequest
-
-
Method Details
-
getRealmName
-
getUserName
-
getIds
-
getName
-
ownedByAuthenticatedUser
public boolean ownedByAuthenticatedUser() -
usingRealmName
Creates invalidate api key request for given realm name- Parameters:
realmName- realm name- Returns:
InvalidateApiKeyRequest
-
usingUserName
Creates invalidate API key request for given user name- Parameters:
userName- user name- Returns:
InvalidateApiKeyRequest
-
usingRealmAndUserName
Creates invalidate API key request for given realm and user name- Parameters:
realmName- realm nameuserName- user name- Returns:
InvalidateApiKeyRequest
-
usingApiKeyId
Creates invalidate API key request for given api key ids- Parameters:
id- api key idownedByAuthenticatedUser- settrueif the request is only for the API keys owned by current authenticated user elsefalse- 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 idsownedByAuthenticatedUser- settrueif the request is only for the API keys owned by current authenticated user elsefalse- 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 nameownedByAuthenticatedUser- settrueif the request is only for the API keys owned by current authenticated user elsefalse- Returns:
InvalidateApiKeyRequest
-
forOwnedApiKeys
Creates invalidate api key request to invalidate api keys owned by the current authenticated user. -
validate
- Specified by:
validatein classActionRequest
-
writeTo
- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classActionRequest- Throws:
IOException
-
equals
-
hashCode
public int hashCode()
-