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

Class AliasPropertyAPI

java.lang.Object

org.apache.solr.api.JerseyResource

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

org.apache.solr.handler.admin.api.AliasPropertyAPI

@Path("/aliases/{aliasName}/properties")
public class AliasPropertyAPI
extends AdminAPIBase

V2 APIs for managing and inspecting properties for collection aliases

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AliasPropertyAPI.GetAliasPropertyResponse
static class	AliasPropertyAPI.GetAllAliasPropertiesResponse
static class	AliasPropertyAPI.UpdateAliasPropertiesRequestBody
static class	AliasPropertyAPI.UpdateAliasPropertyRequestBody

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

Method Summary

Modifier and Type	Method	Description
SolrJerseyResponse	createOrUpdateAliasProperty(String aliasName, String propName, AliasPropertyAPI.UpdateAliasPropertyRequestBody requestBody)
org.apache.solr.common.cloud.ZkNodeProps	createRemoteMessage(String alias, Map<String,Object> properties, String async)
SolrJerseyResponse	deleteAliasProperty(String aliasName, String propName)
AliasPropertyAPI.GetAliasPropertyResponse	getAliasProperty(String aliasName, String propName)
AliasPropertyAPI.GetAllAliasPropertiesResponse	getAllAliasProperties(String aliasName)
SolrJerseyResponse	updateAliasProperties(String aliasName, AliasPropertyAPI.UpdateAliasPropertiesRequestBody requestBody)

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

AliasPropertyAPI

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

Method Detail

getAllAliasProperties

@GET
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public AliasPropertyAPI.GetAllAliasPropertiesResponse getAllAliasProperties(@PathParam("aliasName")
                                                                            String aliasName)
                                                                     throws Exception

Throws:

Exception

getAliasProperty

@GET
@Path("/{propName}")
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public AliasPropertyAPI.GetAliasPropertyResponse getAliasProperty(@PathParam("aliasName")
                                                                  String aliasName,
                                                                  @PathParam("propName")
                                                                  String propName)
                                                           throws Exception

Throws:

Exception

updateAliasProperties

@PUT
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public SolrJerseyResponse updateAliasProperties(@PathParam("aliasName")
                                                String aliasName,
                                                AliasPropertyAPI.UpdateAliasPropertiesRequestBody requestBody)
                                         throws Exception

Throws:

Exception

createOrUpdateAliasProperty

@PUT
@Path("/{propName}")
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public SolrJerseyResponse createOrUpdateAliasProperty(@PathParam("aliasName")
                                                      String aliasName,
                                                      @PathParam("propName")
                                                      String propName,
                                                      AliasPropertyAPI.UpdateAliasPropertyRequestBody requestBody)
                                               throws Exception

Throws:

Exception

deleteAliasProperty

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

Throws:

Exception

createRemoteMessage

public org.apache.solr.common.cloud.ZkNodeProps createRemoteMessage(String alias,
                                                                    Map<String,Object> properties,
                                                                    String async)