Package org.opensearch.repositories.s3

Class S3RepositoryPlugin

java.lang.Object

org.opensearch.plugins.Plugin

org.opensearch.repositories.s3.S3RepositoryPlugin

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, ReloadablePlugin, RepositoryPlugin

public class S3RepositoryPlugin
extends Plugin
implements RepositoryPlugin, ReloadablePlugin

A plugin to add a repository type that writes to and from the AWS S3.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.opensearch.repositories.s3.S3Service	service

Constructor Summary

Constructors

Constructor	Description
S3RepositoryPlugin(Settings settings)

Method Summary

Modifier and Type	Method	Description
void	close()
protected org.opensearch.repositories.s3.S3Repository	createRepository(RepositoryMetadata metadata, NamedXContentRegistry registry, ClusterService clusterService, RecoverySettings recoverySettings)
java.util.Map<java.lang.String,Repository.Factory>	getRepositories(Environment env, NamedXContentRegistry registry, ClusterService clusterService, RecoverySettings recoverySettings)
java.util.List<Setting<?>>	getSettings()
void	reload(Settings settings)

Methods inherited from class org.opensearch.plugins.Plugin

additionalSettings, createComponents, createGuiceModules, getAdditionalIndexSettingProviders, getBootstrapChecks, getExecutorBuilders, getFeature, getGuiceServiceClasses, getIndexTemplateMetadataUpgrader, getNamedWriteables, getNamedXContent, getRoles, getSettingsFilter, getSettingUpgraders, onIndexModule

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.plugins.RepositoryPlugin

getInternalRepositories

Field Detail

service

protected final org.opensearch.repositories.s3.S3Service service

Constructor Detail

S3RepositoryPlugin

public S3RepositoryPlugin(Settings settings)

Method Detail

createRepository

protected org.opensearch.repositories.s3.S3Repository createRepository(RepositoryMetadata metadata,
                                                                       NamedXContentRegistry registry,
                                                                       ClusterService clusterService,
                                                                       RecoverySettings recoverySettings)

getRepositories

public java.util.Map<java.lang.String,Repository.Factory> getRepositories(Environment env,
                                                                                NamedXContentRegistry registry,
                                                                                ClusterService clusterService,
                                                                                RecoverySettings recoverySettings)

Specified by:

getRepositories in interface RepositoryPlugin

getSettings

public java.util.List<Setting<?>> getSettings()

Overrides:

getSettings in class Plugin

reload

public void reload(Settings settings)

Specified by:

reload in interface ReloadablePlugin

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Overrides:

close in class Plugin

Throws:

java.io.IOException