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

Class CreateAlias

java.lang.Object

org.apache.solr.api.JerseyResource

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

org.apache.solr.handler.admin.api.CreateAlias

All Implemented Interfaces:

CreateAliasApi

public class CreateAlias
extends AdminAPIBase
implements CreateAliasApi

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	CreateAlias.CategoryRoutedAliasValidationHelper
static class	CreateAlias.TimeRoutedAliasValidationHelper

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

Method Summary

Modifier and Type	Method	Description
SolrJerseyResponse	createAlias(CreateAliasRequestBody requestBody)
static RoutedAliasProperties	createFromSolrParams(String type, org.apache.solr.common.params.SolrParams params, String propertyPrefix)
static CreateAliasRequestBody	createFromSolrParams(org.apache.solr.common.params.SolrParams params)
static org.apache.solr.common.cloud.ZkNodeProps	createRemoteMessageForRoutedAlias(CreateAliasRequestBody requestBody)
static org.apache.solr.common.cloud.ZkNodeProps	createRemoteMessageForTraditionalAlias(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)
static void	validateRequestBody(CreateAliasRequestBody 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, ensureRequiredRequestBodyProvided, instantiateJerseyResponse, instantiateJerseyResponse

Methods inherited from class java.lang.Object

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

Constructor Details

CreateAlias

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

Method Details

createAlias

public SolrJerseyResponse createAlias(CreateAliasRequestBody requestBody)
                               throws Exception

Specified by:

createAlias in interface CreateAliasApi

Throws:

Exception

createRemoteMessageForTraditionalAlias

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

createRemoteMessageForRoutedAlias

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

createFromSolrParams

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

createFromSolrParams

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

validateRequestBody

public static void validateRequestBody(CreateAliasRequestBody requestBody)

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.