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

Class SamlBaseRestHandler

java.lang.Object
org.elasticsearch.rest.BaseRestHandler
org.elasticsearch.xpack.security.rest.action.SecurityBaseRestHandler
org.elasticsearch.xpack.security.rest.action.saml.SamlBaseRestHandler
All Implemented Interfaces:
org.elasticsearch.rest.RestHandler
Direct Known Subclasses:
RestSamlAuthenticateAction, RestSamlCompleteLogoutAction, RestSamlInvalidateSessionAction, RestSamlLogoutAction, RestSamlPrepareAuthenticationAction, RestSamlSpMetadataAction
public abstract class SamlBaseRestHandler extends SecurityBaseRestHandler
An abstract implementation of SecurityBaseRestHandler that performs a license check for the SAML realm type

  • 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
    SamlBaseRestHandler(org.elasticsearch.common.settings.Settings settings, org.elasticsearch.license.XPackLicenseState licenseState)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected Exception
    checkFeatureAvailable(org.elasticsearch.rest.RestRequest request)
    Check whether the given request is allowed within the current license state and setup, and return the name of any unlicensed feature.

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

    innerPrepareRequest, prepareRequest

    Methods inherited from class org.elasticsearch.rest.BaseRestHandler

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

    • SamlBaseRestHandler

      public SamlBaseRestHandler(org.elasticsearch.common.settings.Settings settings, org.elasticsearch.license.XPackLicenseState licenseState)

  • Method Details

    • checkFeatureAvailable

      protected Exception checkFeatureAvailable(org.elasticsearch.rest.RestRequest request)
      Description copied from class: SecurityBaseRestHandler
      Check whether the given request is allowed within the current license state and setup, and return the name of any unlicensed feature. By default this returns an exception if security is not enabled. Sub-classes can override this method if they have additional requirements.
      Overrides:
      checkFeatureAvailable in class SecurityBaseRestHandler
      Returns:
      null if all required features are available, otherwise an exception to be sent to the requestor