Module org.elasticsearch.security
Class RestSetEnabledAction
java.lang.Object
org.elasticsearch.rest.BaseRestHandler
org.elasticsearch.xpack.security.rest.action.SecurityBaseRestHandler
org.elasticsearch.xpack.security.rest.action.user.RestSetEnabledAction
- All Implemented Interfaces:
RestHandler
REST handler for enabling and disabling users. The username is required and we use the path to determine if the user is being
enabled or disabled.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.rest.BaseRestHandler
BaseRestHandler.RequestBodyChunkConsumer, BaseRestHandler.RestChannelConsumerNested 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, settingsFields inherited from class org.elasticsearch.rest.BaseRestHandler
DEFAULT_INCLUDE_TYPE_NAME_POLICY, INCLUDE_TYPE_NAME_PARAMETER, MULTI_ALLOW_EXPLICIT_INDEX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetName()protected ExceptioninnerCheckFeatureAvailable(RestRequest request) Implementers should implement this method when sub-classes have additional license requirements.innerPrepareRequest(RestRequest request, NodeClient client) Implementers should implement this method as they normally would forBaseRestHandler.prepareRequest(RestRequest, NodeClient)and ensure that all request parameters are consumed prior to returning a value.routes()Methods inherited from class org.elasticsearch.xpack.security.rest.action.SecurityBaseRestHandler
checkFeatureAvailable, getSecureString, prepareRequestMethods inherited from class org.elasticsearch.rest.BaseRestHandler
getUsageCount, handleRequest, responseParams, responseParams, unrecognizedMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.rest.RestHandler
allowSystemIndexAccessByDefault, allSupportedParameters, canTripCircuitBreaker, getConcreteRestHandler, getServerlessScope, mediaTypesValid, supportedCapabilities, supportedQueryParameters, supportsBulkContent
-
Constructor Details
-
RestSetEnabledAction
-
-
Method Details
-
routes
- Specified by:
routesin interfaceRestHandler- Specified by:
routesin classBaseRestHandler
-
getName
- Specified by:
getNamein interfaceRestHandler- Specified by:
getNamein classBaseRestHandler
-
innerPrepareRequest
public BaseRestHandler.RestChannelConsumer innerPrepareRequest(RestRequest request, NodeClient client) throws IOException Description copied from class:SecurityBaseRestHandlerImplementers should implement this method as they normally would forBaseRestHandler.prepareRequest(RestRequest, NodeClient)and ensure that all request parameters are consumed prior to returning a value. This method is executed only if the check fromSecurityBaseRestHandler.checkFeatureAvailable(RestRequest)passes.- Specified by:
innerPrepareRequestin classSecurityBaseRestHandler- Throws:
IOException
-
innerCheckFeatureAvailable
Description copied from class:SecurityBaseRestHandlerImplementers should implement this method when sub-classes have additional license requirements.- Overrides:
innerCheckFeatureAvailablein classSecurityBaseRestHandler
-