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

Class CollectionPropertyAPI

java.lang.Object

org.apache.solr.api.JerseyResource

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

org.apache.solr.handler.admin.api.CollectionPropertyAPI

@Path("/collections/{collName}/properties/{propName}")
public class CollectionPropertyAPI
extends AdminAPIBase

V2 API for modifying collection-level properties.

These APIs (PUT and DELETE /api/collections/collName/properties/propName) are analogous to the v1 /admin/collections?action=COLLECTIONPROP command.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CollectionPropertyAPI.UpdateCollectionPropertyRequestBody

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
CollectionPropertyAPI(CoreContainer coreContainer, SolrQueryRequest solrQueryRequest, SolrQueryResponse solrQueryResponse)

Method Summary

Modifier and Type	Method	Description
SolrJerseyResponse	createOrUpdateCollectionProperty(String collName, String propName, CollectionPropertyAPI.UpdateCollectionPropertyRequestBody requestBody)
SolrJerseyResponse	deleteCollectionProperty(String collName, String propName)

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, instantiateJerseyResponse, instantiateJerseyResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionPropertyAPI

public CollectionPropertyAPI(CoreContainer coreContainer,
                             SolrQueryRequest solrQueryRequest,
                             SolrQueryResponse solrQueryResponse)

Method Detail

createOrUpdateCollectionProperty

@PUT
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public SolrJerseyResponse createOrUpdateCollectionProperty(@PathParam("collName")
                                                           String collName,
                                                           @PathParam("propName")
                                                           String propName,
                                                           CollectionPropertyAPI.UpdateCollectionPropertyRequestBody requestBody)
                                                    throws Exception

Throws:

Exception

deleteCollectionProperty

@DELETE
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public SolrJerseyResponse deleteCollectionProperty(@PathParam("collName")
                                                   String collName,
                                                   @PathParam("propName")
                                                   String propName)
                                            throws Exception

Throws:

Exception