Package org.apache.solr.handler.admin

Class ZookeeperReadAPI

java.lang.Object

org.apache.solr.api.JerseyResource

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

org.apache.solr.handler.admin.ZookeeperReadAPI

@Path("/cluster/zookeeper/")
public class ZookeeperReadAPI
extends AdminAPIBase

Exposes the content of the 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ZookeeperReadAPI.AnnotatedStat
static class	ZookeeperReadAPI.ListZkChildrenResponse
static class	ZookeeperReadAPI.ZooKeeperFileResponse

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
ZookeeperReadAPI(CoreContainer coreContainer, SolrQueryRequest req, SolrQueryResponse rsp)

Method Summary

Modifier and Type	Method	Description
ZookeeperReadAPI.ListZkChildrenResponse	listNodes(String zkPath, Boolean includeChildren)	List the children of a certain zookeeper znode
ZookeeperReadAPI.ZooKeeperFileResponse	readNode(String zkPath)	Request contents of a znode, except security.json
ZookeeperReadAPI.ZooKeeperFileResponse	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 Detail

ZookeeperReadAPI

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

Method Detail

readNode

@GET
@Path("/data{zkPath:.+}")
@Produces({"application/vnd.apache.solr.raw","application/json"})
public ZookeeperReadAPI.ZooKeeperFileResponse readNode(@PathParam("zkPath")
                                                       String zkPath)

Request contents of a znode, except security.json

readSecurityJsonNode

@GET
@Path("/data/security.json")
@Produces({"application/vnd.apache.solr.raw","application/json"})
public ZookeeperReadAPI.ZooKeeperFileResponse readSecurityJsonNode()

Request contents of the security.json node

listNodes

@GET
@Path("/children{zkPath:.*}")
@Produces({"application/json","application/javabin"})
public ZookeeperReadAPI.ListZkChildrenResponse listNodes(@PathParam("zkPath")
                                                         String zkPath,
                                                         @QueryParam("children")
                                                         Boolean includeChildren)
                                                  throws Exception

List the children of a certain zookeeper znode

Throws:

Exception