Class SearchGuardPlugin

  • All Implemented Interfaces:
    Closeable, AutoCloseable, org.elasticsearch.plugins.ActionPlugin, org.elasticsearch.plugins.ClusterPlugin, org.elasticsearch.plugins.MapperPlugin, org.elasticsearch.plugins.NetworkPlugin, org.elasticsearch.plugins.ScriptPlugin

    public final class SearchGuardPlugin
    extends SearchGuardSSLPlugin
    implements org.elasticsearch.plugins.ClusterPlugin, org.elasticsearch.plugins.MapperPlugin, org.elasticsearch.plugins.ScriptPlugin
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SearchGuardPlugin.GuiceHolder  
      static class  SearchGuardPlugin.ProtectedIndices  
      • Nested classes/interfaces inherited from interface org.elasticsearch.plugins.ActionPlugin

        org.elasticsearch.plugins.ActionPlugin.ActionHandler<Request extends org.elasticsearch.action.ActionRequest,​Response extends org.elasticsearch.action.ActionResponse>
    • Constructor Summary

      Constructors 
      Constructor Description
      SearchGuardPlugin​(org.elasticsearch.common.settings.Settings settings, Path configPath)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.elasticsearch.common.settings.Settings additionalSettings()  
      void close()  
      Collection<Object> createComponents​(org.elasticsearch.client.Client localClient, org.elasticsearch.cluster.service.ClusterService clusterService, org.elasticsearch.threadpool.ThreadPool threadPool, org.elasticsearch.watcher.ResourceWatcherService resourceWatcherService, org.elasticsearch.script.ScriptService scriptService, org.elasticsearch.common.xcontent.NamedXContentRegistry xContentRegistry, org.elasticsearch.env.Environment environment, org.elasticsearch.env.NodeEnvironment nodeEnvironment, org.elasticsearch.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, org.elasticsearch.cluster.metadata.IndexNameExpressionResolver indexNameExpressionResolver, Supplier<org.elasticsearch.repositories.RepositoriesService> repositoriesServiceSupplier)  
      List<org.elasticsearch.action.support.ActionFilter> getActionFilters()  
      List<org.elasticsearch.plugins.ActionPlugin.ActionHandler<? extends org.elasticsearch.action.ActionRequest,​? extends org.elasticsearch.action.ActionResponse>> getActions()  
      List<org.elasticsearch.script.ScriptContext<?>> getContexts()  
      Function<String,​Predicate<String>> getFieldFilter()  
      Collection<Class<? extends org.elasticsearch.common.component.LifecycleComponent>> getGuiceServiceClasses()  
      Map<String,​Supplier<org.elasticsearch.http.HttpServerTransport>> getHttpTransports​(org.elasticsearch.common.settings.Settings settings, org.elasticsearch.threadpool.ThreadPool threadPool, org.elasticsearch.common.util.BigArrays bigArrays, org.elasticsearch.common.util.PageCacheRecycler pageCacheRecycler, org.elasticsearch.indices.breaker.CircuitBreakerService circuitBreakerService, org.elasticsearch.common.xcontent.NamedXContentRegistry xContentRegistry, org.elasticsearch.common.network.NetworkService networkService, org.elasticsearch.http.HttpServerTransport.Dispatcher dispatcher, org.elasticsearch.common.settings.ClusterSettings clusterSettings)  
      static SearchGuardPlugin.ProtectedIndices getProtectedIndices()  
      List<org.elasticsearch.rest.RestHandler> getRestHandlers​(org.elasticsearch.common.settings.Settings settings, org.elasticsearch.rest.RestController restController, org.elasticsearch.common.settings.ClusterSettings clusterSettings, org.elasticsearch.common.settings.IndexScopedSettings indexScopedSettings, org.elasticsearch.common.settings.SettingsFilter settingsFilter, org.elasticsearch.cluster.metadata.IndexNameExpressionResolver indexNameExpressionResolver, Supplier<org.elasticsearch.cluster.node.DiscoveryNodes> nodesInCluster)  
      UnaryOperator<org.elasticsearch.rest.RestHandler> getRestHandlerWrapper​(org.elasticsearch.common.util.concurrent.ThreadContext threadContext)  
      List<org.elasticsearch.common.settings.Setting<?>> getSettings()  
      List<String> getSettingsFilter()  
      List<org.elasticsearch.transport.TransportInterceptor> getTransportInterceptors​(org.elasticsearch.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, org.elasticsearch.common.util.concurrent.ThreadContext threadContext)  
      Map<String,​Supplier<org.elasticsearch.transport.Transport>> getTransports​(org.elasticsearch.common.settings.Settings settings, org.elasticsearch.threadpool.ThreadPool threadPool, org.elasticsearch.common.util.PageCacheRecycler pageCacheRecycler, org.elasticsearch.indices.breaker.CircuitBreakerService circuitBreakerService, org.elasticsearch.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, org.elasticsearch.common.network.NetworkService networkService)  
      void onIndexModule​(org.elasticsearch.index.IndexModule indexModule)  
      void onNodeStarted()  
      • Methods inherited from class org.elasticsearch.plugins.Plugin

        createGuiceModules, getBootstrapChecks, getExecutorBuilders, getFeature, getIndexTemplateMetadataUpgrader, getNamedWriteables, getNamedXContent, getRoles, getSettingUpgraders
      • Methods inherited from interface org.elasticsearch.plugins.ActionPlugin

        getClientActions, getRestHeaders, getTaskHeaders, indicesAliasesRequestValidators, mappingRequestValidators
      • Methods inherited from interface org.elasticsearch.plugins.ClusterPlugin

        createAllocationDeciders, getExistingShardsAllocators, getShardsAllocators
      • Methods inherited from interface org.elasticsearch.plugins.MapperPlugin

        getMappers, getMetadataMappers
      • Methods inherited from interface org.elasticsearch.plugins.ScriptPlugin

        getScriptEngine
    • Constructor Detail

      • SearchGuardPlugin

        public SearchGuardPlugin​(org.elasticsearch.common.settings.Settings settings,
                                 Path configPath)
    • Method Detail

      • getRestHandlers

        public List<org.elasticsearch.rest.RestHandler> getRestHandlers​(org.elasticsearch.common.settings.Settings settings,
                                                                        org.elasticsearch.rest.RestController restController,
                                                                        org.elasticsearch.common.settings.ClusterSettings clusterSettings,
                                                                        org.elasticsearch.common.settings.IndexScopedSettings indexScopedSettings,
                                                                        org.elasticsearch.common.settings.SettingsFilter settingsFilter,
                                                                        org.elasticsearch.cluster.metadata.IndexNameExpressionResolver indexNameExpressionResolver,
                                                                        Supplier<org.elasticsearch.cluster.node.DiscoveryNodes> nodesInCluster)
        Specified by:
        getRestHandlers in interface org.elasticsearch.plugins.ActionPlugin
        Overrides:
        getRestHandlers in class SearchGuardSSLPlugin
      • getRestHandlerWrapper

        public UnaryOperator<org.elasticsearch.rest.RestHandler> getRestHandlerWrapper​(org.elasticsearch.common.util.concurrent.ThreadContext threadContext)
        Specified by:
        getRestHandlerWrapper in interface org.elasticsearch.plugins.ActionPlugin
      • getActions

        public List<org.elasticsearch.plugins.ActionPlugin.ActionHandler<? extends org.elasticsearch.action.ActionRequest,​? extends org.elasticsearch.action.ActionResponse>> getActions()
        Specified by:
        getActions in interface org.elasticsearch.plugins.ActionPlugin
      • getContexts

        public List<org.elasticsearch.script.ScriptContext<?>> getContexts()
        Specified by:
        getContexts in interface org.elasticsearch.plugins.ScriptPlugin
      • onIndexModule

        public void onIndexModule​(org.elasticsearch.index.IndexModule indexModule)
        Overrides:
        onIndexModule in class org.elasticsearch.plugins.Plugin
      • getActionFilters

        public List<org.elasticsearch.action.support.ActionFilter> getActionFilters()
        Specified by:
        getActionFilters in interface org.elasticsearch.plugins.ActionPlugin
      • getTransportInterceptors

        public List<org.elasticsearch.transport.TransportInterceptor> getTransportInterceptors​(org.elasticsearch.common.io.stream.NamedWriteableRegistry namedWriteableRegistry,
                                                                                               org.elasticsearch.common.util.concurrent.ThreadContext threadContext)
        Specified by:
        getTransportInterceptors in interface org.elasticsearch.plugins.NetworkPlugin
        Overrides:
        getTransportInterceptors in class SearchGuardSSLPlugin
      • getTransports

        public Map<String,​Supplier<org.elasticsearch.transport.Transport>> getTransports​(org.elasticsearch.common.settings.Settings settings,
                                                                                               org.elasticsearch.threadpool.ThreadPool threadPool,
                                                                                               org.elasticsearch.common.util.PageCacheRecycler pageCacheRecycler,
                                                                                               org.elasticsearch.indices.breaker.CircuitBreakerService circuitBreakerService,
                                                                                               org.elasticsearch.common.io.stream.NamedWriteableRegistry namedWriteableRegistry,
                                                                                               org.elasticsearch.common.network.NetworkService networkService)
        Specified by:
        getTransports in interface org.elasticsearch.plugins.NetworkPlugin
        Overrides:
        getTransports in class SearchGuardSSLPlugin
      • getHttpTransports

        public Map<String,​Supplier<org.elasticsearch.http.HttpServerTransport>> getHttpTransports​(org.elasticsearch.common.settings.Settings settings,
                                                                                                        org.elasticsearch.threadpool.ThreadPool threadPool,
                                                                                                        org.elasticsearch.common.util.BigArrays bigArrays,
                                                                                                        org.elasticsearch.common.util.PageCacheRecycler pageCacheRecycler,
                                                                                                        org.elasticsearch.indices.breaker.CircuitBreakerService circuitBreakerService,
                                                                                                        org.elasticsearch.common.xcontent.NamedXContentRegistry xContentRegistry,
                                                                                                        org.elasticsearch.common.network.NetworkService networkService,
                                                                                                        org.elasticsearch.http.HttpServerTransport.Dispatcher dispatcher,
                                                                                                        org.elasticsearch.common.settings.ClusterSettings clusterSettings)
        Specified by:
        getHttpTransports in interface org.elasticsearch.plugins.NetworkPlugin
        Overrides:
        getHttpTransports in class SearchGuardSSLPlugin
      • createComponents

        public Collection<Object> createComponents​(org.elasticsearch.client.Client localClient,
                                                   org.elasticsearch.cluster.service.ClusterService clusterService,
                                                   org.elasticsearch.threadpool.ThreadPool threadPool,
                                                   org.elasticsearch.watcher.ResourceWatcherService resourceWatcherService,
                                                   org.elasticsearch.script.ScriptService scriptService,
                                                   org.elasticsearch.common.xcontent.NamedXContentRegistry xContentRegistry,
                                                   org.elasticsearch.env.Environment environment,
                                                   org.elasticsearch.env.NodeEnvironment nodeEnvironment,
                                                   org.elasticsearch.common.io.stream.NamedWriteableRegistry namedWriteableRegistry,
                                                   org.elasticsearch.cluster.metadata.IndexNameExpressionResolver indexNameExpressionResolver,
                                                   Supplier<org.elasticsearch.repositories.RepositoriesService> repositoriesServiceSupplier)
        Overrides:
        createComponents in class SearchGuardSSLPlugin
      • onNodeStarted

        public void onNodeStarted()
        Specified by:
        onNodeStarted in interface org.elasticsearch.plugins.ClusterPlugin
      • getGuiceServiceClasses

        public Collection<Class<? extends org.elasticsearch.common.component.LifecycleComponent>> getGuiceServiceClasses()
        Overrides:
        getGuiceServiceClasses in class org.elasticsearch.plugins.Plugin
      • getFieldFilter

        public Function<String,​Predicate<String>> getFieldFilter()
        Specified by:
        getFieldFilter in interface org.elasticsearch.plugins.MapperPlugin