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

Class ClusterProperty

java.lang.Object

org.apache.solr.api.JerseyResource

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

org.apache.solr.handler.admin.api.ClusterProperty

All Implemented Interfaces:

ClusterPropertyApis

public class ClusterProperty
extends AdminAPIBase
implements ClusterPropertyApis

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.solr.common.cloud.ClusterProperties	clusterProperties

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

Method Summary

Modifier and Type	Method	Description
SolrJerseyResponse	createOrUpdateClusterProperty(String propertyName, SetClusterPropertyRequestBody requestBody)	V2 API for setting the value of a single new or existing cluster property.
SolrJerseyResponse	createOrUpdateNestedClusterProperty(Map<String,Object> propertyValuesByName)	V2 API for setting the value of nested cluster properties.
SolrJerseyResponse	deleteClusterProperty(String propertyName)	V2 API for deleting a cluster property.
SolrJerseyResponse	getClusterProperty(String propertyName)	V2 API for returning the value of a cluster property.
ListClusterPropertiesResponse	listClusterProperties()	V2 API for listing cluster properties.

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

Field Detail

clusterProperties

protected final org.apache.solr.common.cloud.ClusterProperties clusterProperties

Constructor Detail

ClusterProperty

@Inject
public ClusterProperty(CoreContainer coreContainer,
                       SolrQueryRequest solrQueryRequest,
                       SolrQueryResponse solrQueryResponse)

Method Detail

listClusterProperties

public ListClusterPropertiesResponse listClusterProperties()

V2 API for listing cluster properties.

This API (GET /api/cluster/properties) has no v1 equivalent.

Specified by:

listClusterProperties in interface ClusterPropertyApis

getClusterProperty

public SolrJerseyResponse getClusterProperty(String propertyName)

V2 API for returning the value of a cluster property.

This API (GET /api/cluster/properties/{propertyName}) has no v1 equivalent.

Specified by:

getClusterProperty in interface ClusterPropertyApis

createOrUpdateClusterProperty

public SolrJerseyResponse createOrUpdateClusterProperty(String propertyName,
                                                        SetClusterPropertyRequestBody requestBody)
                                                 throws IOException

V2 API for setting the value of a single new or existing cluster property.

This API (PUT /api/cluster/properties/{propertyName} with an object listing the value) is equivalent to the v1 GET /solr/admin/collections?action=CLUSTERPROP&name={propertyName}&val={propertyValue} API.

Specified by:

createOrUpdateClusterProperty in interface ClusterPropertyApis

Throws:

IOException

createOrUpdateNestedClusterProperty

public SolrJerseyResponse createOrUpdateNestedClusterProperty(Map<String,Object> propertyValuesByName)

V2 API for setting the value of nested cluster properties.

This API (PUT /api/cluster/properties with an object listing those properties) has no v1 equivalent.

Specified by:

createOrUpdateNestedClusterProperty in interface ClusterPropertyApis

deleteClusterProperty

public SolrJerseyResponse deleteClusterProperty(String propertyName)

V2 API for deleting a cluster property.

This API (DELETE /api/cluster/properties/{propertyName}) is equivalent to the v1 GET /solr/admin/collections?action=CLUSTERPROP&name={propertyName} API.

Specified by:

deleteClusterProperty in interface ClusterPropertyApis