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

Class CreateCollectionBackupAPI

java.lang.Object

org.apache.solr.api.JerseyResource

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

org.apache.solr.handler.admin.api.BackupAPIBase

org.apache.solr.handler.admin.api.CreateCollectionBackupAPI

@Path("/collections/{collectionName}/backups/{backupName}/versions")
public class CreateCollectionBackupAPI
extends BackupAPIBase

V2 API for creating a new "backup" of a specified collection

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateCollectionBackupAPI.CollectionBackupDetails
static class	CreateCollectionBackupAPI.CreateCollectionBackupRequestBody
static class	CreateCollectionBackupAPI.CreateCollectionBackupResponseBody

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

Method Summary

Modifier and Type	Method	Description
SolrJerseyResponse	createCollectionBackup(String collectionName, String backupName, CreateCollectionBackupAPI.CreateCollectionBackupRequestBody requestBody)
static org.apache.solr.common.cloud.ZkNodeProps	createRemoteMessage(String collectionName, String backupName, CreateCollectionBackupAPI.CreateCollectionBackupRequestBody requestBody)
static CreateCollectionBackupAPI.CreateCollectionBackupRequestBody	createRequestBodyFromV1Params(org.apache.solr.common.params.SolrParams params)
static SolrJerseyResponse	invokeFromV1Params(SolrQueryRequest req, SolrQueryResponse rsp, CoreContainer coreContainer)

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

createBackupRepository, getAndValidateBackupLocation, getAndValidateIncrementalBackupLocation

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

CreateCollectionBackupAPI

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

Method Detail

createCollectionBackup

@POST
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public SolrJerseyResponse createCollectionBackup(@PathParam("collectionName")
                                                 String collectionName,
                                                 @PathParam("backupName")
                                                 String backupName,
                                                 CreateCollectionBackupAPI.CreateCollectionBackupRequestBody requestBody)
                                          throws Exception

Throws:

Exception

createRemoteMessage

public static org.apache.solr.common.cloud.ZkNodeProps createRemoteMessage(String collectionName,
                                                                           String backupName,
                                                                           CreateCollectionBackupAPI.CreateCollectionBackupRequestBody requestBody)

createRequestBodyFromV1Params

public static CreateCollectionBackupAPI.CreateCollectionBackupRequestBody createRequestBodyFromV1Params(org.apache.solr.common.params.SolrParams params)

invokeFromV1Params

public static SolrJerseyResponse invokeFromV1Params(SolrQueryRequest req,
                                                    SolrQueryResponse rsp,
                                                    CoreContainer coreContainer)
                                             throws Exception

Throws:

Exception