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

Class CoreSnapshotAPI

java.lang.Object

org.apache.solr.api.JerseyResource

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

org.apache.solr.handler.admin.api.CoreSnapshotAPI

@Path("/cores/{coreName}/snapshots")
public class CoreSnapshotAPI
extends CoreAdminAPIBase

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CoreSnapshotAPI.CreateSnapshotResponse	The Response for CoreSnapshotAPI's createSnapshot(String, String, String)
static class	CoreSnapshotAPI.DeleteSnapshotResponse	The Response for CoreSnapshotAPI's deleteSnapshot(String, String, String)
static class	CoreSnapshotAPI.ListSnapshotsResponse	The Response for CoreSnapshotAPI's listSnapshots(String)
static class	CoreSnapshotAPI.SnapshotInformation	Contained in CoreSnapshotAPI.ListSnapshotsResponse, this holds information for a given core's Snapshot

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
CoreSnapshotAPI(SolrQueryRequest request, SolrQueryResponse response, CoreContainer coreContainer, CoreAdminHandler.CoreAdminAsyncTracker coreAdminAsyncTracker)

Method Summary

Modifier and Type	Method	Description
CoreSnapshotAPI.CreateSnapshotResponse	createSnapshot(String coreName, String snapshotName, String taskId)	This API is analogous to V1 (POST /solr/admin/cores?action=CREATESNAPSHOT)
CoreSnapshotAPI.DeleteSnapshotResponse	deleteSnapshot(String coreName, String snapshotName, String taskId)	This API is analogous to V1 (DELETE /solr/admin/cores?action=DELETESNAPSHOT)
CoreSnapshotAPI.ListSnapshotsResponse	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

CoreSnapshotAPI

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

Method Detail

createSnapshot

@POST
@Path("/{snapshotName}")
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public CoreSnapshotAPI.CreateSnapshotResponse createSnapshot(@PathParam("coreName")
                                                             String coreName,
                                                             @PathParam("snapshotName")
                                                             String snapshotName,
                                                             @QueryParam("async")
                                                             String taskId)
                                                      throws Exception

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

Throws:

Exception

listSnapshots

@GET
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public CoreSnapshotAPI.ListSnapshotsResponse listSnapshots(@PathParam("coreName")
                                                           String coreName)
                                                    throws Exception

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

Throws:

Exception

deleteSnapshot

@DELETE
@Path("/{snapshotName}")
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public CoreSnapshotAPI.DeleteSnapshotResponse deleteSnapshot(@PathParam("coreName")
                                                             String coreName,
                                                             @PathParam("snapshotName")
                                                             String snapshotName,
                                                             @QueryParam("async")
                                                             String taskId)
                                                      throws Exception

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

Throws:

Exception