Package org.apache.solr.handler.admin
Class CollectionsHandler
- java.lang.Object
-
- org.apache.solr.handler.RequestHandlerBase
-
- org.apache.solr.handler.admin.CollectionsHandler
-
- All Implemented Interfaces:
AutoCloseable
,ApiSupport
,SolrInfoBean
,NestedRequestHandler
,SolrMetricProducer
,SolrRequestHandler
,PermissionNameProvider
public class CollectionsHandler extends RequestHandlerBase implements PermissionNameProvider
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CollectionsHandler.CollectionOperation
-
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
coreContainer
static long
DEFAULT_COLLECTION_OP_TIMEOUT
-
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 CollectionsHandler()
CollectionsHandler(CoreContainer coreContainer)
Overloaded ctor to inject CoreContainer into the handler.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected CoreContainer
checkErrors()
Collection<Api>
getApis()
Returns any (non-JAX-RS annotated) APIs associated with this request handler.SolrInfoBean.Category
getCategory()
Category of this componentCoreContainer
getCoreContainer()
The instance of CoreContainer this handler handles.String
getDescription()
Simple one or two line descriptionCollection<Class<? extends JerseyResource>>
getJerseyResources()
Returns any JAX-RS annotated v2 APIs associated with this request handler.PermissionNameProvider.Name
getPermissionName(AuthorizationContext ctx)
void
handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp)
void
init(org.apache.solr.common.util.NamedList<?> args)
Initializes theSolrRequestHandler
by creating threeSolrParams
named.static org.apache.solr.common.params.ModifiableSolrParams
params(String... params)
Boolean
registerV2()
Whether this request handler must be made available at the /v2/ pathorg.apache.solr.client.solrj.SolrResponse
submitCollectionApiCommand(org.apache.solr.common.cloud.ZkNodeProps m, org.apache.solr.common.params.CollectionParams.CollectionAction action)
org.apache.solr.client.solrj.SolrResponse
submitCollectionApiCommand(org.apache.solr.common.cloud.ZkNodeProps m, org.apache.solr.common.params.CollectionParams.CollectionAction action, long timeout)
static org.apache.solr.client.solrj.SolrResponse
submitCollectionApiCommand(CoreContainer coreContainer, Optional<DistributedCollectionConfigSetCommandRunner> distributedCollectionConfigSetCommandRunner, org.apache.solr.common.cloud.ZkNodeProps m, org.apache.solr.common.params.CollectionParams.CollectionAction action, long timeout)
static void
waitForActiveCollection(String collectionName, CoreContainer cc, org.apache.solr.client.solrj.SolrResponse createCollResponse)
-
Methods inherited from class org.apache.solr.handler.RequestHandlerBase
getInitArgs, getMetricsForThisRequest, getName, getPluginInfo, getRequestHandler, getSolrMetricsContext, getSolrParamsFromNamedList, getSubHandler, handleRequest, 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
registerV1
-
Methods inherited from interface org.apache.solr.metrics.SolrMetricProducer
close
-
-
-
-
Field Detail
-
coreContainer
protected final CoreContainer coreContainer
-
DEFAULT_COLLECTION_OP_TIMEOUT
public static long DEFAULT_COLLECTION_OP_TIMEOUT
-
-
Constructor Detail
-
CollectionsHandler
public CollectionsHandler()
-
CollectionsHandler
public CollectionsHandler(CoreContainer coreContainer)
Overloaded ctor to inject CoreContainer into the handler.- Parameters:
coreContainer
- Core Container of the solr webapp installed.
-
-
Method Detail
-
getPermissionName
public PermissionNameProvider.Name getPermissionName(AuthorizationContext ctx)
- Specified by:
getPermissionName
in interfacePermissionNameProvider
-
init
public final void init(org.apache.solr.common.util.NamedList<?> args)
Description copied from class:RequestHandlerBase
Initializes theSolrRequestHandler
by creating threeSolrParams
named.table of parameters Name Description defaults Contains all of the named arguments contained within the list element named "defaults". appends Contains all of the named arguments contained within the list element named "appends". invariants Contains all of the named arguments contained within the list element named "invariants". Example:
<lst name="defaults"> <str name="echoParams">explicit</str> <str name="qf">text^0.5 features^1.0 name^1.2 sku^1.5 id^10.0</str> <str name="mm">2<-1 5<-2 6<90%</str> <str name="bq">incubationdate_dt:[* TO NOW/DAY-1MONTH]^2.2</str> </lst> <lst name="appends"> <str name="fq">inStock:true</str> </lst> <lst name="invariants"> <str name="facet.field">cat</str> <str name="facet.field">manu_exact</str> <str name="facet.query">price:[* TO 500]</str> <str name="facet.query">price:[500 TO *]</str> </lst>
- Specified by:
init
in interfaceSolrRequestHandler
- Overrides:
init
in classRequestHandlerBase
- Parameters:
args
- TheNamedList
to initialize from- See Also:
RequestHandlerBase.handleRequest(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)
,RequestHandlerBase.handleRequestBody(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)
,SolrPluginUtils.setDefaults(org.apache.solr.request.SolrQueryRequest, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams)
,See also the example solrconfig.xml located in the Solr codebase (example/solr/conf).
-
getCoreContainer
public CoreContainer getCoreContainer()
The instance of CoreContainer this handler handles. This should be the CoreContainer instance that created this handler.- Returns:
- a CoreContainer instance
-
handleRequestBody
public void handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp) throws Exception
- Specified by:
handleRequestBody
in classRequestHandlerBase
- Throws:
Exception
-
checkErrors
protected CoreContainer checkErrors()
-
submitCollectionApiCommand
public org.apache.solr.client.solrj.SolrResponse submitCollectionApiCommand(org.apache.solr.common.cloud.ZkNodeProps m, org.apache.solr.common.params.CollectionParams.CollectionAction action) throws org.apache.zookeeper.KeeperException, InterruptedException
- Throws:
org.apache.zookeeper.KeeperException
InterruptedException
-
submitCollectionApiCommand
public static org.apache.solr.client.solrj.SolrResponse submitCollectionApiCommand(CoreContainer coreContainer, Optional<DistributedCollectionConfigSetCommandRunner> distributedCollectionConfigSetCommandRunner, org.apache.solr.common.cloud.ZkNodeProps m, org.apache.solr.common.params.CollectionParams.CollectionAction action, long timeout) throws org.apache.zookeeper.KeeperException, InterruptedException
- Throws:
org.apache.zookeeper.KeeperException
InterruptedException
-
submitCollectionApiCommand
public org.apache.solr.client.solrj.SolrResponse submitCollectionApiCommand(org.apache.solr.common.cloud.ZkNodeProps m, org.apache.solr.common.params.CollectionParams.CollectionAction action, long timeout) throws org.apache.zookeeper.KeeperException, InterruptedException
- Throws:
org.apache.zookeeper.KeeperException
InterruptedException
-
params
public static org.apache.solr.common.params.ModifiableSolrParams params(String... params)
-
getDescription
public String getDescription()
Description copied from interface:SolrInfoBean
Simple one or two line description- Specified by:
getDescription
in interfaceSolrInfoBean
- Specified by:
getDescription
in classRequestHandlerBase
-
getCategory
public SolrInfoBean.Category getCategory()
Description copied from interface:SolrInfoBean
Category of this component- Specified by:
getCategory
in interfaceSolrInfoBean
- Overrides:
getCategory
in classRequestHandlerBase
-
waitForActiveCollection
public static void waitForActiveCollection(String collectionName, CoreContainer cc, org.apache.solr.client.solrj.SolrResponse createCollResponse) throws org.apache.zookeeper.KeeperException, InterruptedException
- Throws:
org.apache.zookeeper.KeeperException
InterruptedException
-
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 interfaceApiSupport
-
getJerseyResources
public Collection<Class<? extends JerseyResource>> getJerseyResources()
Description copied from interface:ApiSupport
Returns any JAX-RS annotated v2 APIs associated with this request handler.- Specified by:
getJerseyResources
in interfaceApiSupport
- See Also:
ApiSupport.getApis()
-
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 interfaceApiSupport
- Overrides:
getApis
in classRequestHandlerBase
- See Also:
ApiSupport.getJerseyResources()
-
-