com.atlassian.jira.filestore

Interface FileStoreProvider

All Known Subinterfaces:

AttachmentFileStoreProvider, AvatarFileStoreProvider, BackupFileStoreProvider

All Known Implementing Classes:

FileSystemAttachmentFileStoreProvider, FileSystemAvatarFileStoreProvider, FileSystemBackupFileStoreProvider, NoOpAttachmentFileStoreProvider, NoOpAvatarFileStoreProvider, NoOpBackupFileStoreProvider, S3AttachmentFileStoreProvider, S3AvatarFileStoreProvider, S3BackupFileStoreProvider, S3FileStoreProvider

public interface FileStoreProvider

Provides a FileStore's base path.

Since:

9.11

Method Summary

Modifier and Type	Method and Description
FileStoreAssociationTarget	getAssociationTarget() Returns the FileStoreAssociationTarget that this provider is associated with.
com.atlassian.dc.filestore.api.FileStore.Path	getBasePath() Fetches the base file store path.
FileStoreAnalyticInfo	getFileStoreAnalyticInfo() Fetches the Analytic info about file store
FileStoreInformation	getInformation() Returns information that describes the file store config.
boolean	isStoreInJiraHome() Indicates whether the file store is somewhere within the Jira home directory.

Method Detail

getBasePath

@Nonnull
com.atlassian.dc.filestore.api.FileStore.Path getBasePath()

Fetches the base file store path.

Returns:

see description

Throws:

io.atlassian.util.concurrent.LazyReference.InitializationException - if a FileStore cannot be created

isStoreInJiraHome

boolean isStoreInJiraHome()

Indicates whether the file store is somewhere within the Jira home directory.

Returns:

see description

getInformation

FileStoreInformation getInformation()

Returns information that describes the file store config.

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.

getFileStoreAnalyticInfo

@Nonnull
FileStoreAnalyticInfo getFileStoreAnalyticInfo()

Fetches the Analytic info about file store

Returns:

FileStoreAnalyticInfo

getAssociationTarget

@Nonnull
FileStoreAssociationTarget getAssociationTarget()

Returns the FileStoreAssociationTarget that this provider is associated with.

Returns:

FileStoreAssociationTarget