java.lang.Object

org.opensearch.common.component.AbstractLifecycleComponent

org.opensearch.repositories.blobstore.BlobStoreRepository

org.opensearch.repositories.url.URLRepository

All Implemented Interfaces:: java.io.Closeable, java.lang.AutoCloseable, LifecycleComponent, Releasable, 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 Setting<java.util.List<URIPattern>>`	`ALLOWED_URLS_SETTING`
`static Setting<java.net.URL>`	`REPOSITORIES_URL_SETTING`
`static Setting<java.util.List<java.lang.String>>`	`SUPPORTED_PROTOCOLS_SETTING`
`static java.lang.String`	`TYPE`
`static Setting<java.net.URL>`	`URL_SETTING`

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

ALLOW_CONCURRENT_MODIFICATION, BUFFER_SIZE_SETTING, bufferSize, CACHE_REPOSITORY_DATA, GLOBAL_METADATA_FORMAT, INDEX_FILE_PREFIX, INDEX_LATEST_BLOB, INDEX_METADATA_FORMAT, INDEX_SHARD_SNAPSHOT_FORMAT, INDEX_SHARD_SNAPSHOTS_FORMAT, metadata, METADATA_NAME_FORMAT, METADATA_PREFIX, SNAPSHOT_FORMAT, SNAPSHOT_NAME_FORMAT, SNAPSHOT_PREFIX, SUPPORT_URL_REPO, supportURLRepo, threadPool

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

lifecycle

Constructor Summary

Constructors
Constructor	Description
`URLRepository(RepositoryMetadata metadata, Environment environment, 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, cloneShardSnapshot, deleteSnapshots, doClose, doStart, doStop, endVerification, executeConsistentStateUpdate, finalizeSnapshot, getMetadata, getRepositoryData, getRestoreThrottleTimeInNanos, getShardSnapshotStatus, getSnapshotGlobalMetadata, getSnapshotIndexMetaData, getSnapshotInfo, getSnapshotThrottleTimeInNanos, initializeSnapshot, isCompress, loadShardSnapshot, maybeRateLimitRestores, maybeRateLimitSnapshots, restoreShard, shardContainer, snapshotShard, startVerification, stats, threadPool, toString, updateState, verify, writeIndexGen

Methods inherited from class org.opensearch.common.component.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.component.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

Field Details
- TYPE
  
  public static final java.lang.String TYPE
  
  See Also:
  
  Constant Field Values
- SUPPORTED_PROTOCOLS_SETTING
  
  public static final Setting<java.util.List<java.lang.String>> SUPPORTED_PROTOCOLS_SETTING
- ALLOWED_URLS_SETTING
  
  public static final Setting<java.util.List<URIPattern>> ALLOWED_URLS_SETTING
- URL_SETTING
  
  public static final Setting<java.net.URL> URL_SETTING
- REPOSITORIES_URL_SETTING
  
  public static final Setting<java.net.URL> REPOSITORIES_URL_SETTING
Constructor Details
- URLRepository
  
  public URLRepository(RepositoryMetadata metadata, Environment environment, 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

Class URLRepository

Nested Class Summary

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