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

Class ListAliasesAPI

java.lang.Object

org.apache.solr.api.JerseyResource

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

org.apache.solr.handler.admin.api.ListAliasesAPI

@Path("/aliases")
public class ListAliasesAPI
extends AdminAPIBase

V2 APIs for managing and inspecting collection aliases

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListAliasesAPI.GetAliasByNameResponse	Response for getAliasByName(String).
static class	ListAliasesAPI.ListAliasesResponse	Response for getAliases().

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

Method Summary

Modifier and Type	Method	Description
ListAliasesAPI.GetAliasByNameResponse	getAliasByName(String aliasName)
ListAliasesAPI.ListAliasesResponse	getAliases()	V2 API for listing all aliases known by Solr.

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

disableResponseCaching, fetchAndValidateZooKeeperAwareCoreContainer, recordCollectionForLogAndTracing, validateZooKeeperAwareCoreContainer

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

instantiateJerseyResponse, instantiateJerseyResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

ListAliasesAPI

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

Method Detail

getAliases

@GET
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public ListAliasesAPI.ListAliasesResponse getAliases()
                                              throws Exception

V2 API for listing all aliases known by Solr.

This API GET /api/aliases is analogous to the v1 GET /api/cluster/aliases API.

Throws:

Exception

getAliasByName

@GET
@Path("/{aliasName}")
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public ListAliasesAPI.GetAliasByNameResponse getAliasByName(@PathParam("aliasName")
                                                            String aliasName)
                                                     throws Exception

Throws:

Exception