Package org.opensearch.repositories.url

Class URLRepository

java.lang.Object

org.opensearch.common.lifecycle.AbstractLifecycleComponent

org.opensearch.repositories.blobstore.BlobStoreRepository

org.opensearch.repositories.url.URLRepository

All Implemented Interfaces:

Closeable, AutoCloseable, org.opensearch.common.lease.Releasable, org.opensearch.common.lifecycle.LifecycleComponent, 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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.repositories.Repository

Repository.Factory

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting<List<URIPattern>>	ALLOWED_URLS_SETTING
static final Setting<URL>	REPOSITORIES_URL_SETTING
static final Setting<List<String>>	SUPPORTED_PROTOCOLS_SETTING
static final String	TYPE
static final Setting<URL>	URL_SETTING

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

ALLOW_CONCURRENT_MODIFICATION, BUFFER_SIZE_SETTING, bufferSize, CACHE_REPOSITORY_DATA, clusterService, COMPRESS_SETTING, COMPRESSION_TYPE_SETTING, GLOBAL_METADATA_FORMAT, INDEX_FILE_PREFIX, INDEX_LATEST_BLOB, INDEX_METADATA_FORMAT, INDEX_SHARD_SNAPSHOT_FORMAT, INDEX_SHARD_SNAPSHOTS_FORMAT, INDICES_DIR, MAX_SNAPSHOT_SHARD_BLOB_DELETE_BATCH_SIZE, metadata, METADATA_NAME_FORMAT, METADATA_PREFIX, PREFIX_MODE_VERIFICATION_SETTING, READONLY_SETTING, REMOTE_STORE_INDEX_SHALLOW_COPY, REMOTE_STORE_SHARD_SHALLOW_COPY_SNAPSHOT_FORMAT, SHALLOW_SNAPSHOT_NAME_FORMAT, SHALLOW_SNAPSHOT_PREFIX, SHALLOW_SNAPSHOT_V2, SHARD_PATH_TYPE, SNAPSHOT_FORMAT, SNAPSHOT_NAME_FORMAT, SNAPSHOT_PREFIX, SNAPSHOT_SHARD_PATH_PREFIX_SETTING, SNAPSHOT_SHARD_PATHS_FORMAT, SUPPORT_URL_REPO, supportURLRepo, SYSTEM_REPOSITORY_SETTING, threadPool, VIRTUAL_DATA_BLOB_PREFIX

Fields inherited from class org.opensearch.common.lifecycle.AbstractLifecycleComponent

lifecycle

Constructor Summary

Constructors

Constructor	Description
URLRepository(RepositoryMetadata metadata, Environment environment, org.opensearch.core.xcontent.NamedXContentRegistry namedXContentRegistry, ClusterService clusterService, RecoverySettings recoverySettings)	Constructs a read-only URL-based repository

Method Summary

Modifier and Type	Method	Description
BlobPath	basePath()
protected BlobContainer	blobContainer()
protected BlobStore	createBlobStore()
protected BlobStore	getBlobStore()
boolean	isReadOnly()

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

assertSnapshotOrGenericThread, blobStore, chunkSize, cleanup, cloneRemoteStoreIndexShardSnapshot, cloneShardSnapshot, deleteSnapshots, deleteSnapshotsAndReleaseLockFiles, deleteSnapshotsInternal, deleteSnapshotsWithPinnedTimestamp, doClose, doStart, doStop, endVerification, executeConsistentStateUpdate, finalizeSnapshot, finalizeSnapshot, getCompressor, getLowPriorityRemoteUploadThrottleTimeInNanos, getMetadata, getNamedXContentRegistry, getRemoteDownloadThrottleTimeInNanos, getRemoteStoreShallowCopyShardMetadata, getRemoteUploadThrottleTimeInNanos, getRepositoryData, getRestoreThrottleTimeInNanos, getRestrictedSystemRepositorySettings, getShardSnapshotStatus, getShardSnapshotStatus, getSnapshotGlobalMetadata, getSnapshotIndexMetaData, getSnapshotInfo, getSnapshotShardPathBlobContainer, getSnapshotThrottleTimeInNanos, initializeSnapshot, isCompress, isSystemRepository, loadShardSnapshot, loadShardSnapshot, maybeRateLimitLowPriorityRemoteUploadTransfers, maybeRateLimitRemoteDownloadTransfers, maybeRateLimitRemoteUploadTransfers, maybeRateLimitRestores, maybeRateLimitSnapshots, releaseRemoteStoreLockAndCleanup, reload, remoteDirectoryCleanupAsync, restoreShard, rootBlobContainer, shardContainer, snapshotRemoteStoreIndexShard, snapshotShard, snapshotShardPathBlobContainer, startVerification, stats, threadPool, toString, updateState, verify, writeIndexGen

Methods inherited from class org.opensearch.common.lifecycle.AbstractLifecycleComponent

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.common.lifecycle.LifecycleComponent

addLifecycleListener, lifecycleState, removeLifecycleListener, start, stop

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

close

Methods inherited from interface org.opensearch.repositories.Repository

adaptUserMetadata, isReloadable, validateMetadata

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

SUPPORTED_PROTOCOLS_SETTING

public static final Setting<List<String>> SUPPORTED_PROTOCOLS_SETTING

ALLOWED_URLS_SETTING

public static final Setting<List<URIPattern>> ALLOWED_URLS_SETTING

URL_SETTING

public static final Setting<URL> URL_SETTING

REPOSITORIES_URL_SETTING

public static final Setting<URL> REPOSITORIES_URL_SETTING

Constructor Details

URLRepository

public URLRepository(RepositoryMetadata metadata,
 Environment environment,
 org.opensearch.core.xcontent.NamedXContentRegistry namedXContentRegistry,
 ClusterService clusterService,
 RecoverySettings recoverySettings)

Constructs a read-only URL-based repository

Method Details

createBlobStore

protected BlobStore createBlobStore()

Specified by:

createBlobStore in class BlobStoreRepository

blobContainer

protected BlobContainer blobContainer()

Overrides:

blobContainer in class BlobStoreRepository

getBlobStore

protected BlobStore getBlobStore()

Overrides:

getBlobStore in class BlobStoreRepository

basePath

public BlobPath basePath()

Specified by:

basePath in class BlobStoreRepository

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface Repository

Overrides:

isReadOnly in class BlobStoreRepository