Package org.apache.solr.handler

Class SnapShooter

java.lang.Object

org.apache.solr.handler.SnapShooter

public class SnapShooter
extends Object

Provides functionality equivalent to the snapshooter script This is no longer used in standard replication.

Since:

solr 1.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SnapShooter.CoreSnapshotResponse

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATE_FMT

Constructor Summary

Constructors

Constructor	Description
SnapShooter(BackupRepository backupRepo, SolrCore core, URI location, String snapshotName, String commitName)
SnapShooter(SolrCore core, String location, String snapshotName)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	createSnapAsync(int numberToKeep, Consumer<org.apache.solr.common.util.NamedList<?>> result)
SnapShooter.CoreSnapshotResponse	createSnapshot()
protected SnapShooter.CoreSnapshotResponse	createSnapshot(org.apache.lucene.index.IndexCommit indexCommit)	Handles the logic of creating a snapshot
protected void	deleteNamedSnapshot(ReplicationHandler replicationHandler)
protected void	deleteSnapAsync(ReplicationHandler replicationHandler)
static org.apache.lucene.index.IndexCommit	getAndSaveNamedIndexCommit(SolrCore solrCore, String commitName)
BackupRepository	getBackupRepository()
URI	getLocation()	Gets the parent directory of the snapshots.
void	validateCreateSnapshot()
void	validateDeleteSnapshot()

Methods inherited from class java.lang.Object

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

Field Details

DATE_FMT

public static final String DATE_FMT

See Also:

• Constant Field Values

Constructor Details

SnapShooter

@Deprecated
public SnapShooter(SolrCore core,
 String location,
 String snapshotName)

Deprecated.

SnapShooter

public SnapShooter(BackupRepository backupRepo,
 SolrCore core,
 URI location,
 String snapshotName,
 String commitName)

Method Details

getBackupRepository

public BackupRepository getBackupRepository()

getLocation

public URI getLocation()

Gets the parent directory of the snapshots. This is the location given in the constructor.

validateDeleteSnapshot

public void validateDeleteSnapshot()

deleteSnapAsync

protected void deleteSnapAsync(ReplicationHandler replicationHandler)

validateCreateSnapshot

public void validateCreateSnapshot()
                            throws IOException

Throws:

IOException

createSnapshot

public SnapShooter.CoreSnapshotResponse createSnapshot()
                                                throws Exception

Throws:

Exception

getAndSaveNamedIndexCommit

public static org.apache.lucene.index.IndexCommit getAndSaveNamedIndexCommit(SolrCore solrCore,
 String commitName)
                                                                      throws IOException

Throws:

IOException

createSnapAsync

public void createSnapAsync(int numberToKeep,
 Consumer<org.apache.solr.common.util.NamedList<?>> result)
                     throws IOException

Throws:

IOException

createSnapshot

protected SnapShooter.CoreSnapshotResponse createSnapshot(org.apache.lucene.index.IndexCommit indexCommit)
                                                   throws Exception

Handles the logic of creating a snapshot

NOTE: The caller MUST ensure that the IndexCommit is saved prior to calling this method, and released after calling this method, or there is no no garuntee that the method will function correctly.

Throws:

Exception

See Also:

• IndexDeletionPolicyWrapper.saveCommitPoint(java.lang.Long)
• IndexDeletionPolicyWrapper.releaseCommitPoint(org.apache.lucene.index.IndexCommit)

deleteNamedSnapshot

protected void deleteNamedSnapshot(ReplicationHandler replicationHandler)