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

Class RestAuthenticateAction

java.lang.Object
org.elasticsearch.rest.BaseRestHandler
org.elasticsearch.xpack.security.rest.action.SecurityBaseRestHandler
org.elasticsearch.xpack.security.rest.action.RestAuthenticateAction
All Implemented Interfaces:
org.elasticsearch.rest.RestHandler
public class RestAuthenticateAction extends SecurityBaseRestHandler

  • Nested Class Summary

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

    org.elasticsearch.rest.BaseRestHandler.RestChannelConsumer, org.elasticsearch.rest.BaseRestHandler.Wrapper

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

    org.elasticsearch.rest.RestHandler.Route

  • Field Summary

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

    licenseState, settings

    Fields inherited from class org.elasticsearch.rest.BaseRestHandler

    DEFAULT_INCLUDE_TYPE_NAME_POLICY, INCLUDE_TYPE_NAME_PARAMETER, MULTI_ALLOW_EXPLICIT_INDEX

  • Constructor Summary

    Constructors
    Constructor
    Description
    RestAuthenticateAction(org.elasticsearch.common.settings.Settings settings, org.elasticsearch.xpack.core.security.SecurityContext securityContext, org.elasticsearch.license.XPackLicenseState licenseState)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
     
    org.elasticsearch.rest.BaseRestHandler.RestChannelConsumer
    innerPrepareRequest(org.elasticsearch.rest.RestRequest request, org.elasticsearch.client.internal.node.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<org.elasticsearch.rest.RestHandler.Route>
    routes()
     

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

    checkFeatureAvailable, prepareRequest

    Methods inherited from class org.elasticsearch.rest.BaseRestHandler

    getUsageCount, handleRequest, mediaTypesValid, 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

    allowsUnsafeBuffers, allowSystemIndexAccessByDefault, canTripCircuitBreaker, supportsContentStream

  • Constructor Details

    • RestAuthenticateAction

      public RestAuthenticateAction(org.elasticsearch.common.settings.Settings settings, org.elasticsearch.xpack.core.security.SecurityContext securityContext, org.elasticsearch.license.XPackLicenseState licenseState)

  • Method Details

    • routes

      public List<org.elasticsearch.rest.RestHandler.Route> routes()
      Specified by:
      routes in interface org.elasticsearch.rest.RestHandler
      Specified by:
      routes in class org.elasticsearch.rest.BaseRestHandler

    • getName

      public String getName()
      Specified by:
      getName in class org.elasticsearch.rest.BaseRestHandler

    • innerPrepareRequest

      public org.elasticsearch.rest.BaseRestHandler.RestChannelConsumer innerPrepareRequest(org.elasticsearch.rest.RestRequest request, org.elasticsearch.client.internal.node.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. The returned value is not guaranteed to be executed unless security is licensed and all request parameters are known
      Specified by:
      innerPrepareRequest in class SecurityBaseRestHandler
      Throws:
      IOException