org.elasticsearch.repositories.uri

Class URLRepository

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.common.component.AbstractLifecycleComponent<Repository>

org.elasticsearch.repositories.blobstore.BlobStoreRepository

org.elasticsearch.repositories.uri.URLRepository

All Implemented Interfaces:

AutoCloseable, LifecycleComponent<Repository>, Releasable, BlobStoreIndexShardRepository.RateLimiterListener, Repository

public class URLRepository
extends BlobStoreRepository

Read-only URL-based implementation of the BlobStoreRepository

This repository supports the following settings

url

URL to the root of repository. This is mandatory parameter.

concurrent_streams

Number of concurrent read/write stream (per repository on each node). Defaults to 5.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALLOWED_URLS_SETTING
static String[]	DEFAULT_SUPPORTED_PROTOCOLS
static String	SUPPORTED_PROTOCOLS_SETTING
static String	TYPE

Fields inherited from class org.elasticsearch.repositories.blobstore.BlobStoreRepository

repositoryName

Fields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

lifecycle

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

componentSettings, logger, settings

Constructor Summary

Constructors

Constructor and Description
URLRepository(RepositoryName name, RepositorySettings repositorySettings, IndexShardRepository indexShardRepository, Environment environment) Constructs new read-only URL-based repository

Method Summary

Modifier and Type	Method and Description
protected BlobPath	basePath() Returns base path of the repository
protected BlobStore	blobStore() Returns initialized and ready to use BlobStore This method is first called in the BlobStoreRepository.doStart() method.
void	endVerification(String seed) Called at the end of repository verification process.
com.google.common.collect.ImmutableList<SnapshotId>	snapshots() Returns the list of snapshots currently stored in the repository
String	startVerification() Verifies repository on the master node and returns the verification token.

Methods inherited from class org.elasticsearch.repositories.blobstore.BlobStoreRepository

chunkSize, deleteSnapshot, doClose, doStart, doStop, finalizeSnapshot, initializeSnapshot, isCompress, onRestorePause, onSnapshotPause, readSnapshot, readSnapshotList, readSnapshotMetaData, restoreThrottleTimeInNanos, snapshotThrottleTimeInNanos, testBlobPrefix, writeSnapshotList

Methods inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

nodeName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.component.LifecycleComponent

addLifecycleListener, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from interface org.elasticsearch.common.lease.Releasable

close

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

DEFAULT_SUPPORTED_PROTOCOLS

public static final String[] DEFAULT_SUPPORTED_PROTOCOLS

SUPPORTED_PROTOCOLS_SETTING

public static final String SUPPORTED_PROTOCOLS_SETTING

See Also:

Constant Field Values

ALLOWED_URLS_SETTING

public static final String ALLOWED_URLS_SETTING

See Also:

Constant Field Values

Constructor Detail

URLRepository

@Inject
public URLRepository(RepositoryName name,
                             RepositorySettings repositorySettings,
                             IndexShardRepository indexShardRepository,
                             Environment environment)
                      throws IOException

Constructs new read-only URL-based repository

Parameters:

name - repository name

repositorySettings - repository settings

indexShardRepository - shard repository

Throws:

IOException

Method Detail

blobStore

protected BlobStore blobStore()

Returns initialized and ready to use BlobStore

This method is first called in the BlobStoreRepository.doStart() method.

Specified by:

blobStore in class BlobStoreRepository

Returns:

blob store

basePath

protected BlobPath basePath()

Description copied from class: BlobStoreRepository

Returns base path of the repository

Specified by:

basePath in class BlobStoreRepository

snapshots

public com.google.common.collect.ImmutableList<SnapshotId> snapshots()

Description copied from class: BlobStoreRepository

Returns the list of snapshots currently stored in the repository

Specified by:

snapshots in interface Repository

Overrides:

snapshots in class BlobStoreRepository

Returns:

snapshot list

startVerification

public String startVerification()

Description copied from interface: Repository

Verifies repository on the master node and returns the verification token. If the verification token is not null, it's passed to all data nodes for verification. If it's null - no additional verification is required

Specified by:

startVerification in interface Repository

Overrides:

startVerification in class BlobStoreRepository

Returns:

verification token that should be passed to all Index Shard Repositories for additional verification or null

endVerification

public void endVerification(String seed)

Description copied from interface: Repository

Called at the end of repository verification process. This method should perform all necessary cleanup of the temporary files created in the repository

Specified by:

endVerification in interface Repository

Overrides:

endVerification in class BlobStoreRepository

Parameters:

seed - verification request generated by Repository.startVerification() command