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 enum	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 final CoreContainer	coreContainer
static long	DEFAULT_COLLECTION_OP_TIMEOUT

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
CollectionsHandler()
CollectionsHandler(CoreContainer coreContainer)	Overloaded ctor to inject CoreContainer into the handler.

Method Summary

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 component
CoreContainer	getCoreContainer()	The instance of CoreContainer this handler handles.
String	getDescription()	Simple one or two line description
Collection<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)
final void	init(org.apache.solr.common.util.NamedList<?> args)	Initializes the SolrRequestHandler by creating three SolrParams named.
static org.apache.solr.common.params.ModifiableSolrParams	params(String... params)
Boolean	registerV2()	Whether this request handler must be made available at the /v2/ path
static org.apache.solr.client.solrj.SolrResponse	submitCollectionApiCommand(ZkController zkController, org.apache.solr.common.cloud.ZkNodeProps m, org.apache.solr.common.params.CollectionParams.CollectionAction action, long timeout)
org.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 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, 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

registerV1

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

close

Field Details

coreContainer

protected final CoreContainer coreContainer

DEFAULT_COLLECTION_OP_TIMEOUT

public static long DEFAULT_COLLECTION_OP_TIMEOUT

Constructor Details

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 Details

getPermissionName

public PermissionNameProvider.Name getPermissionName(AuthorizationContext ctx)

Specified by:

getPermissionName in interface PermissionNameProvider

init

public final void init(org.apache.solr.common.util.NamedList<?> args)

Description copied from class: RequestHandlerBase

Initializes the SolrRequestHandler by creating three SolrParams 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 interface SolrRequestHandler

Overrides:

init in class RequestHandlerBase

Parameters:

args - The NamedList 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 class RequestHandlerBase

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(ZkController zkController,
 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 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

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 interface ApiSupport

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 interface ApiSupport

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 interface ApiSupport

Overrides:

getApis in class RequestHandlerBase

See Also:

• ApiSupport.getJerseyResources()