Module org.elasticsearch.security

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

Class RestCloneApiKeyAction

java.lang.Object

org.elasticsearch.rest.BaseRestHandler

org.elasticsearch.xpack.security.rest.action.SecurityBaseRestHandler

org.elasticsearch.xpack.security.rest.action.apikey.RestCloneApiKeyAction

All Implemented Interfaces:

RestHandler, RestRequestFilter

public final class RestCloneApiKeyAction
extends SecurityBaseRestHandler
implements RestRequestFilter

REST action to clone an existing API key. Creates a new key with the same role descriptors as the source, with a new name, id, and optional expiration and metadata.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.rest.BaseRestHandler

BaseRestHandler.RequestBodyChunkConsumer, BaseRestHandler.RestChannelConsumer

Nested classes/interfaces inherited from interface org.elasticsearch.rest.RestHandler

RestHandler.Route

Field Summary

Fields inherited from class org.elasticsearch.xpack.security.rest.action.SecurityBaseRestHandler

CLIENT_AUTHENTICATION_PARSER, licenseState, settings

Fields inherited from class org.elasticsearch.rest.BaseRestHandler

MULTI_ALLOW_EXPLICIT_INDEX

Constructor Summary

Constructors

Constructor	Description
RestCloneApiKeyAction(Settings settings, XPackLicenseState licenseState)

Method Summary

Modifier and Type	Method	Description
Set<String>	getFilteredFields()
String	getName()
protected Exception	innerCheckFeatureAvailable(RestRequest request)	Implementers should implement this method when sub-classes have additional license requirements.
protected BaseRestHandler.RestChannelConsumer	innerPrepareRequest(RestRequest request, NodeClient client)	Implementers should implement this method as they normally would for BaseRestHandler.prepareRequest(RestRequest, NodeClient) and ensure that all request parameters are consumed prior to returning a value.
List<RestHandler.Route>	routes()

Methods inherited from class org.elasticsearch.xpack.security.rest.action.SecurityBaseRestHandler

checkFeatureAvailable, getSecureString, prepareRequest

Methods inherited from class org.elasticsearch.rest.BaseRestHandler

getUsageCount, handleRequest, responseParams, responseParams, unrecognized

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.rest.RestHandler

allowSystemIndexAccessByDefault, allSupportedParameters, canTripCircuitBreaker, getConcreteRestHandler, getServerlessScope, mediaTypesValid, supportedCapabilities, supportedQueryParameters, supportsContentStream

Methods inherited from interface org.elasticsearch.rest.RestRequestFilter

getFilteredRequest

Constructor Details

RestCloneApiKeyAction

public RestCloneApiKeyAction(Settings settings,
 XPackLicenseState licenseState)

Method Details

routes

public List<RestHandler.Route> routes()

Specified by:

routes in interface RestHandler

Specified by:

routes in class BaseRestHandler

getName

public String getName()

Specified by:

getName in interface RestHandler

Specified by:

getName in class BaseRestHandler

innerPrepareRequest

protected BaseRestHandler.RestChannelConsumer innerPrepareRequest(RestRequest request,
 NodeClient client)
                                                           throws IOException

Description copied from class: SecurityBaseRestHandler

Implementers should implement this method as they normally would for BaseRestHandler.prepareRequest(RestRequest, NodeClient) and ensure that all request parameters are consumed prior to returning a value. This method is executed only if the check from SecurityBaseRestHandler.checkFeatureAvailable(RestRequest) passes.

Specified by:

innerPrepareRequest in class SecurityBaseRestHandler

Throws:

IOException

getFilteredFields

public Set<String> getFilteredFields()

Specified by:

getFilteredFields in interface RestRequestFilter

innerCheckFeatureAvailable

protected Exception innerCheckFeatureAvailable(RestRequest request)

Description copied from class: SecurityBaseRestHandler

Implementers should implement this method when sub-classes have additional license requirements.

Overrides:

innerCheckFeatureAvailable in class SecurityBaseRestHandler