Package org.apache.solr.handler.admin

Class LukeRequestHandler

java.lang.Object

org.apache.solr.handler.RequestHandlerBase

org.apache.solr.handler.admin.LukeRequestHandler

All Implemented Interfaces:

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

public class LukeRequestHandler
extends RequestHandlerBase

Exposes the internal lucene index. It's registered at /admin/luke by default.

It is inspired by and modeled on Luke, the Lucene Index Browser that is currently a Lucene module: https://github.com/apache/lucene/tree/main/lucene/luke

Since:

solr 1.2

See Also:

• SegmentsInfoRequestHandler

Nested Class Summary

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
static final int	DEFAULT_COUNT
static final String	DOC_ID
static final String	ID
static final String	INCLUDE_INDEX_FIELD_FLAGS
static final String	NUMTERMS

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
LukeRequestHandler()

Method Summary

Modifier and Type	Method	Description
SolrInfoBean.Category	getCategory()	Category of this component
String	getDescription()	Simple one or two line description
static org.apache.solr.common.util.SimpleOrderedMap<String>	getFieldFlagsKey()
static CoreStatusResponse.IndexDetails	getIndexInfo(org.apache.lucene.index.DirectoryReader reader)
PermissionNameProvider.Name	getPermissionName(AuthorizationContext request)
void	handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp)

Methods inherited from class org.apache.solr.handler.RequestHandlerBase

getApis, 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, registerV2

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

close

Field Details

NUMTERMS

public static final String NUMTERMS

See Also:

• Constant Field Values

INCLUDE_INDEX_FIELD_FLAGS

public static final String INCLUDE_INDEX_FIELD_FLAGS

See Also:

• Constant Field Values

DOC_ID

public static final String DOC_ID

See Also:

• Constant Field Values

ID

public static final String ID

See Also:

• Constant Field Values

DEFAULT_COUNT

public static final int DEFAULT_COUNT

See Also:

• Constant Field Values

Constructor Details

LukeRequestHandler

public LukeRequestHandler()

Method Details

getPermissionName

public PermissionNameProvider.Name getPermissionName(AuthorizationContext request)

handleRequestBody

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

Specified by:

handleRequestBody in class RequestHandlerBase

Throws:

Exception

getFieldFlagsKey

public static org.apache.solr.common.util.SimpleOrderedMap<String> getFieldFlagsKey()

Returns:

a key to what each character means

getIndexInfo

public static CoreStatusResponse.IndexDetails getIndexInfo(org.apache.lucene.index.DirectoryReader reader)
                                                    throws IOException

Throws:

IOException

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