Package 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 TypeMethodDescriptionReturns theFileStoreAssociationTargetthat this provider is associated with.com.atlassian.dc.filestore.api.FileStore.PathFetches the base file store path.Fetches the Analytic info about file storeReturns information that describes the file store config.booleanIndicates whether the file store is somewhere within the Jira home directory.
-
Method Details
-
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
FileStoreInformationinstance 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
Fetches the Analytic info about file store- Returns:
- FileStoreAnalyticInfo
-
getAssociationTarget
Returns theFileStoreAssociationTargetthat this provider is associated with.- Returns:
- FileStoreAssociationTarget
-