com.atlassian.jira.filestore

Class S3FileStoreProvider

java.lang.Object

com.atlassian.jira.filestore.S3FileStoreProvider

All Implemented Interfaces:

FileStoreProvider

Direct Known Subclasses:

S3AttachmentFileStoreProvider, S3AvatarFileStoreProvider, S3BackupFileStoreProvider

public abstract class S3FileStoreProvider
extends Object
implements FileStoreProvider

An abstract class that provides a common implementation for file store providers backed by S3.

Since:

9.11

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	S3FileStoreProvider.ConfigAndFileStore

Field Summary

Fields

Modifier and Type	Field and Description
protected io.atlassian.util.concurrent.LazyReference<S3FileStoreProvider.ConfigAndFileStore>	configAndFileStoreLazyReference

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	S3FileStoreProvider(FileStoreAssociationTarget associationTarget, JiraProperties jiraProperties, FileStoresConfigurationLoader fileStoresConfigurationLoader)

Method Summary

Modifier and Type	Method and Description
FileStoreAnalyticInfo	getFileStoreAnalyticInfo() Fetches the Analytic info about file store
FileStoreConfig	getFileStoreConfig()
FileStoreInformation	getInformation() Returns information that describes the file store config.
protected com.atlassian.dc.filestore.api.FileStore	getS3FileStore() Returns the S3 file store used to store attachments.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.filestore.FileStoreProvider

getAssociationTarget, getBasePath, isStoreInJiraHome

Field Detail

configAndFileStoreLazyReference

protected final io.atlassian.util.concurrent.LazyReference<S3FileStoreProvider.ConfigAndFileStore> configAndFileStoreLazyReference

Constructor Detail

S3FileStoreProvider

protected S3FileStoreProvider(FileStoreAssociationTarget associationTarget,
                              JiraProperties jiraProperties,
                              FileStoresConfigurationLoader fileStoresConfigurationLoader)

Method Detail

getFileStoreConfig

public FileStoreConfig getFileStoreConfig()

Returns:

the configuration used to create the S3 file store.

getFileStoreAnalyticInfo

@Nonnull
public FileStoreAnalyticInfo getFileStoreAnalyticInfo()

Description copied from interface: FileStoreProvider

Fetches the Analytic info about file store

Specified by:

getFileStoreAnalyticInfo in interface FileStoreProvider

Returns:

the information about the file store that will be included in the analytics event.

getInformation

public FileStoreInformation getInformation()

Description copied from interface: FileStoreProvider

Returns information that describes the file store config.

Specified by:

getInformation in interface FileStoreProvider

Returns:

a FileStoreInformation instance that can be used by the JIRA.Templates.Admin.Jira.FileStoreInformation.fileStoreInformation soy template to present information about the file store in the admin UI.

getS3FileStore

protected final com.atlassian.dc.filestore.api.FileStore getS3FileStore()

Returns the S3 file store used to store attachments.

Returns:

the FileStore instance.