org.apache.solr.handler.admin

Class BaseHandlerApiSupport

java.lang.Object

org.apache.solr.handler.admin.BaseHandlerApiSupport

All Implemented Interfaces:

ApiSupport

Direct Known Subclasses:

CollectionHandlerApi, ConfigSetsHandlerApi, CoreAdminHandlerApi

public abstract class BaseHandlerApiSupport
extends Object
implements ApiSupport

This is a utility class to provide an easy mapping of request handlers which support multiple commands to the V2 API format (core admin api, collections api). This helps in automatically mapping paths to actions and old parameter names to new parameter names

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BaseHandlerApiSupport.ApiCommand
static interface	BaseHandlerApiSupport.V2EndPoint

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<SolrRequest.METHOD,Map<BaseHandlerApiSupport.V2EndPoint,List<BaseHandlerApiSupport.ApiCommand>>>	commandsMapping

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseHandlerApiSupport()

Method Summary

Modifier and Type	Method and Description
static void	collectKeyNames(Map<String,Object> map, List<String> result, String prefix)
Collection<Api>	getApis() It is possible to support multiple v2 apis by a single requesthandler
protected abstract List<BaseHandlerApiSupport.ApiCommand>	getCommands()
protected abstract List<BaseHandlerApiSupport.V2EndPoint>	getEndPoints()
static Collection<String>	getParamNames(CommandOperation op, BaseHandlerApiSupport.ApiCommand command)

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

registerV1, registerV2

Field Detail

commandsMapping

protected final Map<SolrRequest.METHOD,Map<BaseHandlerApiSupport.V2EndPoint,List<BaseHandlerApiSupport.ApiCommand>>> commandsMapping

Constructor Detail

BaseHandlerApiSupport

protected BaseHandlerApiSupport()

Method Detail

getApis

public Collection<Api> getApis()

Description copied from interface: ApiSupport

It is possible to support multiple v2 apis by a single requesthandler

Specified by:

getApis in interface ApiSupport

Returns:

the list of v2 api implementations

getParamNames

public static Collection<String> getParamNames(CommandOperation op,
                                               BaseHandlerApiSupport.ApiCommand command)

collectKeyNames

public static void collectKeyNames(Map<String,Object> map,
                                   List<String> result,
                                   String prefix)

getCommands

protected abstract List<BaseHandlerApiSupport.ApiCommand> getCommands()

getEndPoints

protected abstract List<BaseHandlerApiSupport.V2EndPoint> getEndPoints()