Package org.apache.solr.handler.admin

Class SecurityConfHandler

java.lang.Object

org.apache.solr.handler.RequestHandlerBase

org.apache.solr.handler.admin.SecurityConfHandler

All Implemented Interfaces:

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

Direct Known Subclasses:

SecurityConfHandlerLocal, SecurityConfHandlerZk

public abstract class SecurityConfHandler
extends RequestHandlerBase
implements PermissionNameProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SecurityConfHandler.SecurityConfig	Object to hold security.json as nested Map<String,Object> and optionally its version.

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 CoreContainer	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
SecurityConfHandler(CoreContainer coreContainer)

Method Summary

Modifier and Type	Method	Description
Collection<Api>	getApis()	Returns any (non-JAX-RS annotated) APIs associated with this request handler.
SolrInfoBean.Category	getCategory()	Category of this component
protected abstract void	getConf(SolrQueryResponse rsp, String key)
String	getDescription()	Simple one or two line description
static List	getListValue(Map<String,Object> lookupMap, String key)
static Map<String,Object>	getMapValue(Map<String,Object> lookupMap, String key)
PermissionNameProvider.Name	getPermissionName(AuthorizationContext ctx)
abstract SecurityConfHandler.SecurityConfig	getSecurityConfig(boolean getFresh)	Gets security.json from source
void	handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp)
protected abstract boolean	persistConf(SecurityConfHandler.SecurityConfig securityConfig)	Persist security.json to the source, optionally with a version
Boolean	registerV2()	Whether this request handler must be made available at the /v2/ path
protected void	securityConfEdited()	Hook where you can do stuff after a config has been edited.

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

cores

protected CoreContainer cores

Constructor Details

SecurityConfHandler

public SecurityConfHandler(CoreContainer coreContainer)

Method Details

getPermissionName

public PermissionNameProvider.Name getPermissionName(AuthorizationContext ctx)

Specified by:

getPermissionName in interface PermissionNameProvider

handleRequestBody

public void handleRequestBody(SolrQueryRequest req,
 SolrQueryResponse rsp)
                       throws Exception

Specified by:

handleRequestBody in class RequestHandlerBase

Throws:

Exception

securityConfEdited

protected void securityConfEdited()

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

getConf

protected abstract void getConf(SolrQueryResponse rsp,
 String key)

getMapValue

public static Map<String,Object> getMapValue(Map<String,Object> lookupMap,
 String key)

getListValue

public static List getListValue(Map<String,Object> lookupMap,
 String key)

getDescription

public String getDescription()

Description copied from interface: SolrInfoBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoBean

Specified by:

getDescription in class RequestHandlerBase

getCategory

public SolrInfoBean.Category getCategory()

Description copied from interface: SolrInfoBean

Category of this component

Specified by:

getCategory in interface SolrInfoBean

Overrides:

getCategory in class RequestHandlerBase

getSecurityConfig

public abstract SecurityConfHandler.SecurityConfig getSecurityConfig(boolean getFresh)

Gets security.json from source

persistConf

protected abstract boolean persistConf(SecurityConfHandler.SecurityConfig securityConfig)
                                throws IOException

Persist security.json to the source, optionally with a version

Throws:

IOException

getApis

public Collection<Api> getApis()

Description copied from interface: ApiSupport

Returns any (non-JAX-RS annotated) APIs associated with this request handler.

Specified by:

getApis in interface ApiSupport

Overrides:

getApis in class RequestHandlerBase

See Also:

• ApiSupport.getJerseyResources()

registerV2

public Boolean registerV2()

Description copied from interface: ApiSupport

Whether this request handler must be made available at the /v2/ path

Specified by:

registerV2 in interface ApiSupport