Package org.apache.solr.handler.admin

Class ZookeeperRead

java.lang.Object

org.apache.solr.api.JerseyResource

org.apache.solr.handler.admin.api.AdminAPIBase

org.apache.solr.handler.admin.ZookeeperRead

All Implemented Interfaces:

ZooKeeperReadApis

public class ZookeeperRead
extends AdminAPIBase
implements ZooKeeperReadApis

v2 API definition exposing read-content in Zookeeper.

This is an expert feature that exposes the data inside the back end zookeeper.This API may change or be removed in future versions. This is not a public API. The data that is returned is not guaranteed to remain same across releases, as the data stored in Zookeeper may change from time to time.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary

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

coreContainer, solrQueryRequest, solrQueryResponse

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

containerRequestContext

Constructor Summary

Constructors

Constructor	Description
ZookeeperRead(CoreContainer coreContainer, SolrQueryRequest req, SolrQueryResponse rsp)

Method Summary

Modifier and Type	Method	Description
static ZooKeeperStat	createAnnotatedStatFrom(org.apache.zookeeper.data.Stat stat)
ZooKeeperListChildrenResponse	listNodes(String zkPath, Boolean includeChildren)	List the children of a certain zookeeper znode
jakarta.ws.rs.core.StreamingOutput	readNode(String zkPath)	Request contents of a znode, except security.json
jakarta.ws.rs.core.StreamingOutput	readSecurityJsonNode()	Request contents of the security.json node

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

disableResponseCaching, fetchAndValidateZooKeeperAwareCoreContainer, insertIfNotNull, recordCollectionForLogAndTracing, resolveAndValidateAliasIfEnabled, resolveCollectionName, submitRemoteMessageAndHandleResponse, validateZooKeeperAwareCoreContainer

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

ZookeeperRead

@Inject
public ZookeeperRead(CoreContainer coreContainer,
 SolrQueryRequest req,
 SolrQueryResponse rsp)

Method Details

readNode

public jakarta.ws.rs.core.StreamingOutput readNode(String zkPath)

Request contents of a znode, except security.json

Specified by:

readNode in interface ZooKeeperReadApis

readSecurityJsonNode

public jakarta.ws.rs.core.StreamingOutput readSecurityJsonNode()

Request contents of the security.json node

Specified by:

readSecurityJsonNode in interface ZooKeeperReadApis

listNodes

public ZooKeeperListChildrenResponse listNodes(String zkPath,
 Boolean includeChildren)
                                        throws Exception

List the children of a certain zookeeper znode

Specified by:

listNodes in interface ZooKeeperReadApis

Throws:

Exception

createAnnotatedStatFrom

public static ZooKeeperStat createAnnotatedStatFrom(org.apache.zookeeper.data.Stat stat)