Package org.apache.solr.handler.admin.api

Class CoreStatus

java.lang.Object

org.apache.solr.api.JerseyResource

org.apache.solr.handler.admin.api.CoreAdminAPIBase

org.apache.solr.handler.admin.api.CoreStatus

All Implemented Interfaces:

CoreApis.GetStatus

public class CoreStatus
extends CoreAdminAPIBase
implements CoreApis.GetStatus

V2 APIs for getting the status of one or all cores.

This API (GET /v2/cores/coreName is analogous to the v1 /admin/cores?action=status command.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.handler.admin.api.CoreAdminAPIBase

CoreAdminAPIBase.CoreAdminAPIBaseException

Field Summary

Fields inherited from class org.apache.solr.handler.admin.api.CoreAdminAPIBase

coreAdminAsyncTracker, coreContainer, req, rsp

Fields inherited from class org.apache.solr.api.JerseyResource

containerRequestContext

Constructor Summary

Constructors

Constructor	Description
CoreStatus(CoreContainer coreContainer, CoreAdminHandler.CoreAdminAsyncTracker coreAdminAsyncTracker, SolrQueryRequest solrQueryRequest, SolrQueryResponse solrQueryResponse)

Method Summary

Modifier and Type	Method	Description
static CoreStatusResponse	fetchStatusInfo(CoreContainer coreContainer, String coreName, Boolean indexInfo)
CoreStatusResponse	getAllCoreStatus(Boolean indexInfo)
CoreStatusResponse	getCoreStatus(String coreName, Boolean indexInfo)
static CoreStatusResponse.SingleCoreData	getCoreStatus(CoreContainer cores, String cname, boolean isIndexInfoNeeded)	Returns the core status for a particular core.

Methods inherited from class org.apache.solr.handler.admin.api.CoreAdminAPIBase

handlePotentiallyAsynchronousTask

Methods inherited from class org.apache.solr.api.JerseyResource

ensureRequiredParameterProvided, ensureRequiredRequestBodyProvided, instantiateJerseyResponse, instantiateJerseyResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CoreStatus

@Inject
public CoreStatus(CoreContainer coreContainer,
 CoreAdminHandler.CoreAdminAsyncTracker coreAdminAsyncTracker,
 SolrQueryRequest solrQueryRequest,
 SolrQueryResponse solrQueryResponse)

Method Details

getAllCoreStatus

public CoreStatusResponse getAllCoreStatus(Boolean indexInfo)
                                    throws IOException

Specified by:

getAllCoreStatus in interface CoreApis.GetStatus

Throws:

IOException

getCoreStatus

public CoreStatusResponse getCoreStatus(String coreName,
 Boolean indexInfo)
                                 throws IOException

Specified by:

getCoreStatus in interface CoreApis.GetStatus

Throws:

IOException

fetchStatusInfo

public static CoreStatusResponse fetchStatusInfo(CoreContainer coreContainer,
 String coreName,
 Boolean indexInfo)
                                          throws IOException

Throws:

IOException

getCoreStatus

public static CoreStatusResponse.SingleCoreData getCoreStatus(CoreContainer cores,
 String cname,
 boolean isIndexInfoNeeded)
                                                       throws IOException

Returns the core status for a particular core.

Parameters:

cores - - the enclosing core container

cname - - the core to return

isIndexInfoNeeded - - add what may be expensive index information. NOT returned if the core is not loaded

Returns:

- a named list of key/value pairs from the core.

Throws:

IOException - - LukeRequestHandler can throw an I/O exception