SecurityConfHandlerZk (Solr 9.6.1 core API)

java.lang.Object
- org.apache.solr.handler.RequestHandlerBase
- - org.apache.solr.handler.admin.SecurityConfHandler
  - - org.apache.solr.handler.admin.SecurityConfHandlerZk

All Implemented Interfaces:

AutoCloseable, ApiSupport, SolrInfoBean, NestedRequestHandler, SolrMetricProducer, SolrRequestHandler, PermissionNameProvider
```
public class SecurityConfHandlerZk
extends SecurityConfHandler
```
Security Configuration Handler which works with Zookeeper

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.solr.handler.admin.SecurityConfHandler
  SecurityConfHandler.SecurityConfig
- Nested classes/interfaces inherited from class org.apache.solr.handler.RequestHandlerBase
  RequestHandlerBase.HandlerMetrics
- Nested classes/interfaces inherited from interface org.apache.solr.security.PermissionNameProvider
  PermissionNameProvider.Name
- Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean
  SolrInfoBean.Category, SolrInfoBean.Group

Field Summary
- Fields inherited from class org.apache.solr.handler.admin.SecurityConfHandler
  cores
- Fields inherited from class org.apache.solr.handler.RequestHandlerBase
  aggregateNodeLevelMetricsEnabled, appends, defaults, httpCaching, initArgs, invariants, metrics, solrMetricsContext
- Fields inherited from interface org.apache.solr.security.PermissionNameProvider
  ANY, NULL, values
- Fields inherited from interface org.apache.solr.request.SolrRequestHandler
  TYPE

Constructor Summary

Constructors
Constructor Description

SecurityConfHandlerZk(CoreContainer coreContainer)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`getConf(SolrQueryResponse rsp, String key)`
`String`	`getDescription()`	Simple one or two line description
`SecurityConfHandler.SecurityConfig`	`getSecurityConfig(boolean getFresh)`	Fetches security props from Zookeeper and adds version
`protected boolean`	`persistConf(SecurityConfHandler.SecurityConfig securityConfig)`	Persist security.json to the source, optionally with a version

Methods inherited from class org.apache.solr.handler.admin.SecurityConfHandler
getApis, getCategory, getListValue, getMapValue, getPermissionName, handleRequestBody, registerV2, securityConfEdited

Methods inherited from class org.apache.solr.handler.RequestHandlerBase
getInitArgs, getMetricsForThisRequest, getName, getPluginInfo, getRequestHandler, getSolrMetricsContext, getSolrParamsFromNamedList, getSubHandler, handleRequest, init, initializeMetrics, isInternalShardRequest, normalizeReceivedException, processErrorMetricsOnException, setPluginInfo

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.solr.api.ApiSupport
getJerseyResources, registerV1

Methods inherited from interface org.apache.solr.metrics.SolrMetricProducer
close

- Constructor Detail
  - SecurityConfHandlerZk
```
public SecurityConfHandlerZk(CoreContainer coreContainer)
```
- Method Detail
  - getSecurityConfig
```
public SecurityConfHandler.SecurityConfig getSecurityConfig(boolean getFresh)
```
    Fetches security props from Zookeeper and adds version
    
    Specified by:
    
    getSecurityConfig in class SecurityConfHandler
    
    Parameters:
    
    getFresh - refresh from ZK
    
    Returns:
    
    SecurityConfig whose data property either contains security.json, or an empty map if not found
  - getConf
```
protected void getConf(SolrQueryResponse rsp,
                       String key)
```
    Specified by:
    
    getConf in class SecurityConfHandler
  - persistConf
```
protected boolean persistConf(SecurityConfHandler.SecurityConfig securityConfig)
                       throws IOException
```
    Description copied from class: SecurityConfHandler
    
    Persist security.json to the source, optionally with a version
    
    Specified by:
    
    persistConf in class SecurityConfHandler
    
    Throws:
    
    IOException
  - getDescription
```
public String getDescription()
```
    Description copied from interface: SolrInfoBean
    
    Simple one or two line description
    
    Specified by:
    
    getDescription in interface SolrInfoBean
    
    Overrides:
    
    getDescription in class SecurityConfHandler