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

Class ListAliases

java.lang.Object

org.apache.solr.api.JerseyResource

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

org.apache.solr.handler.admin.api.ListAliases

All Implemented Interfaces:

ListAliasesApi

public class ListAliases
extends AdminAPIBase
implements ListAliasesApi

V2 API implementation for listing and inspecting collection aliases

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

Method Summary

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

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 Details

ListAliases

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

Method Details

getAliases

public 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.

Specified by:

getAliases in interface ListAliasesApi

Throws:

Exception

getAliasByName

public GetAliasByNameResponse getAliasByName(String aliasName)
                                      throws Exception

Specified by:

getAliasByName in interface ListAliasesApi

Throws:

Exception