Package org.apache.solr.handler.admin

Class SecurityConfHandlerLocal

java.lang.Object

org.apache.solr.handler.RequestHandlerBase

org.apache.solr.handler.admin.SecurityConfHandler

org.apache.solr.handler.admin.SecurityConfHandlerLocal

All Implemented Interfaces:

AutoCloseable, ApiSupport, SolrInfoBean, NestedRequestHandler, SolrMetricProducer, SolrRequestHandler, PermissionNameProvider

public class SecurityConfHandlerLocal
extends SecurityConfHandler

Security Configuration Handler which works on standalone local files

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

Modifier and Type	Field	Description
protected Path	securityJsonPath

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, publishCpuTime, REQUEST_CPU_TIMER_CONTEXT, solrMetricsContext, SOURCE_ATTR

Fields inherited from interface org.apache.solr.security.PermissionNameProvider

ANY, NULL, values

Fields inherited from interface org.apache.solr.metrics.SolrMetricProducer

CATEGORY_ATTR, HANDLER_ATTR, NAME_ATTR, OPERATION_ATTR, PLUGIN_NAME_ATTR, RESULT_ATTR, TYPE_ATTR

Fields inherited from interface org.apache.solr.request.SolrRequestHandler

TYPE

Constructor Summary

Constructors

Constructor	Description
SecurityConfHandlerLocal(CoreContainer coreContainer)

Method Summary

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 SOLR_HOME
protected boolean	persistConf(SecurityConfHandler.SecurityConfig securityConfig)	Persist security.json to the source, optionally with a version
protected void	securityConfEdited()	Hook where you can do stuff after a config has been edited.

Methods inherited from class org.apache.solr.handler.admin.SecurityConfHandler

getApis, getCategory, getListValue, getMapValue, getPermissionName, handleRequestBody, registerV2

Methods inherited from class org.apache.solr.handler.RequestHandlerBase

getInitArgs, getMetricsForThisRequest, getName, getPluginInfo, getRequestHandler, getSolrMetricsContext, getSolrParamsFromNamedList, getSubHandler, handleRequest, init, initializeMetrics, isInternalShardRequest, processErrorMetricsOnException, processReceivedException, 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

Field Details

securityJsonPath

protected Path securityJsonPath

Constructor Details

SecurityConfHandlerLocal

public SecurityConfHandlerLocal(CoreContainer coreContainer)

Method Details

getSecurityConfig

public SecurityConfHandler.SecurityConfig getSecurityConfig(boolean getFresh)

Fetches security props from SOLR_HOME

Specified by:

getSecurityConfig in class SecurityConfHandler

Parameters:

getFresh - NOP

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

securityConfEdited

protected void securityConfEdited()

Description copied from class: SecurityConfHandler

Hook where you can do stuff after a config has been edited. Defaults to NOP

Overrides:

securityConfEdited in class SecurityConfHandler