Package org.apache.solr.handler

Class GraphHandler

java.lang.Object

org.apache.solr.handler.RequestHandlerBase

org.apache.solr.handler.GraphHandler

All Implemented Interfaces:

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

public class GraphHandler
extends RequestHandlerBase
implements SolrCoreAware, PermissionNameProvider

Solr Request Handler for graph traversal with streaming functions that responds with GraphML markup.

It loads the default set of streaming expression functions via DefaultStreamFactory.

To add additional functions, just define them as plugins in solrconfig.xml via <expressible name="count" class="org.apache.solr.client.solrj.io.stream.RecordCountStream" />

The @deprecated configuration method as of Solr 8.5 is <lst name="streamFunctions"><str name="group">org.apache.solr.client.solrj.io.stream.ReducerStream</str><str name="count">org.apache.solr.client.solrj.io.stream.RecordCountStream</str></lst>

Since:

6.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GraphHandler.DummyErrorStream
static class	GraphHandler.TimerStream

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

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Simple one or two line description
PermissionNameProvider.Name	getPermissionName(AuthorizationContext request)
String	getSource()
void	handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp)
void	inform(SolrCore core)

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

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

Constructor Details

GraphHandler

public GraphHandler()

Method Details

getPermissionName

public PermissionNameProvider.Name getPermissionName(AuthorizationContext request)

Specified by:

getPermissionName in interface PermissionNameProvider

inform

public void inform(SolrCore core)

Specified by:

inform in interface SolrCoreAware

handleRequestBody

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

Specified by:

handleRequestBody in class RequestHandlerBase

Throws:

Exception

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

getSource

public String getSource()