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

Class CreateAliasAPI

java.lang.Object

org.apache.solr.api.JerseyResource

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

org.apache.solr.handler.admin.api.CreateAliasAPI

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

V2 API for creating an alias

This API is analogous to the v1 /admin/collections?action=CREATEALIAS command.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateAliasAPI.CategoryRoutedAliasProperties
static class	CreateAliasAPI.CreateAliasRequestBody
static class	CreateAliasAPI.RoutedAliasProperties
static class	CreateAliasAPI.TimeRoutedAliasProperties

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

Method Summary

Modifier and Type	Method	Description
SolrJerseyResponse	createAlias(CreateAliasAPI.CreateAliasRequestBody requestBody)
static CreateAliasAPI.RoutedAliasProperties	createFromSolrParams(String type, org.apache.solr.common.params.SolrParams params, String propertyPrefix)
static CreateAliasAPI.CreateAliasRequestBody	createFromSolrParams(org.apache.solr.common.params.SolrParams params)
static org.apache.solr.common.cloud.ZkNodeProps	createRemoteMessageForRoutedAlias(CreateAliasAPI.CreateAliasRequestBody requestBody)
static org.apache.solr.common.cloud.ZkNodeProps	createRemoteMessageForTraditionalAlias(CreateAliasAPI.CreateAliasRequestBody requestBody)
static org.apache.solr.common.params.SolrParams	getHierarchicalParametersByPrefix(org.apache.solr.common.params.SolrParams paramSource, String prefix)	Returns a SolrParams object containing only those values whose keys match a specified prefix (with that prefix removed)

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 Detail

CreateAliasAPI

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

Method Detail

createAlias

@POST
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public SolrJerseyResponse createAlias(CreateAliasAPI.CreateAliasRequestBody requestBody)
                               throws Exception

Throws:

Exception

createRemoteMessageForTraditionalAlias

public static org.apache.solr.common.cloud.ZkNodeProps createRemoteMessageForTraditionalAlias(CreateAliasAPI.CreateAliasRequestBody requestBody)

createRemoteMessageForRoutedAlias

public static org.apache.solr.common.cloud.ZkNodeProps createRemoteMessageForRoutedAlias(CreateAliasAPI.CreateAliasRequestBody requestBody)

createFromSolrParams

public static CreateAliasAPI.CreateAliasRequestBody createFromSolrParams(org.apache.solr.common.params.SolrParams params)

createFromSolrParams

public static CreateAliasAPI.RoutedAliasProperties createFromSolrParams(String type,
                                                                        org.apache.solr.common.params.SolrParams params,
                                                                        String propertyPrefix)

getHierarchicalParametersByPrefix

public static org.apache.solr.common.params.SolrParams getHierarchicalParametersByPrefix(org.apache.solr.common.params.SolrParams paramSource,
                                                                                         String prefix)

Returns a SolrParams object containing only those values whose keys match a specified prefix (with that prefix removed)

Query-parameter based v1 APIs often mimic hierarchical parameters by using a prefix in the query-param key to group similar parameters together. This function can be used to identify all of the parameters "nested" in this way, with their prefix removed.