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

Class CoreSnapshot

java.lang.Object

org.apache.solr.api.JerseyResource

org.apache.solr.handler.admin.api.CoreAdminAPIBase

org.apache.solr.handler.admin.api.CoreSnapshot

All Implemented Interfaces:

CoreSnapshotApi

public class CoreSnapshot
extends CoreAdminAPIBase
implements CoreSnapshotApi

V2 API for Creating, Listing, and Deleting Core Snapshots.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.handler.admin.api.CoreAdminAPIBase

CoreAdminAPIBase.CoreAdminAPIBaseException

Field Summary

Fields inherited from class org.apache.solr.handler.admin.api.CoreAdminAPIBase

coreAdminAsyncTracker, coreContainer, req, rsp

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

containerRequestContext

Constructor Summary

Constructors

Constructor	Description
CoreSnapshot(SolrQueryRequest request, SolrQueryResponse response, CoreContainer coreContainer, CoreAdminHandler.CoreAdminAsyncTracker coreAdminAsyncTracker)

Method Summary

Modifier and Type	Method	Description
CreateCoreSnapshotResponse	createSnapshot(String coreName, String snapshotName, String taskId)	This API is analogous to V1 (POST /solr/admin/cores?action=CREATESNAPSHOT)
DeleteSnapshotResponse	deleteSnapshot(String coreName, String snapshotName, String taskId)	This API is analogous to V1 (DELETE /solr/admin/cores?action=DELETESNAPSHOT)
ListCoreSnapshotsResponse	listSnapshots(String coreName)	This API is analogous to V1 (GET /solr/admin/cores?action=LISTSNAPSHOTS)

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

handlePotentiallyAsynchronousTask

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

CoreSnapshot

@Inject
public CoreSnapshot(SolrQueryRequest request,
                    SolrQueryResponse response,
                    CoreContainer coreContainer,
                    CoreAdminHandler.CoreAdminAsyncTracker coreAdminAsyncTracker)

Method Detail

createSnapshot

public CreateCoreSnapshotResponse createSnapshot(String coreName,
                                                 String snapshotName,
                                                 String taskId)
                                          throws Exception

This API is analogous to V1 (POST /solr/admin/cores?action=CREATESNAPSHOT)

Specified by:

createSnapshot in interface CoreSnapshotApi

Throws:

Exception

listSnapshots

public ListCoreSnapshotsResponse listSnapshots(String coreName)
                                        throws Exception

This API is analogous to V1 (GET /solr/admin/cores?action=LISTSNAPSHOTS)

Specified by:

listSnapshots in interface CoreSnapshotApi

Throws:

Exception

deleteSnapshot

public DeleteSnapshotResponse deleteSnapshot(String coreName,
                                             String snapshotName,
                                             String taskId)
                                      throws Exception

This API is analogous to V1 (DELETE /solr/admin/cores?action=DELETESNAPSHOT)

Specified by:

deleteSnapshot in interface CoreSnapshotApi

Throws:

Exception