com.atlassian.jira.filestore

Class FileStoreSwitcher<T>

java.lang.Object

com.atlassian.jira.filestore.FileStoreSwitcher<T>

Type Parameters:

T - the FileStoreProvider type that this switcher will return

Direct Known Subclasses:

AttachmentFileStoreSwitcher, AvatarFileStoreSwitcher, BackupFileStoreSwitcher

public abstract class FileStoreSwitcher<T>
extends Object

An abstract class that provides a common implementation for reading S3 configuration from system properties

Since:

9.11

Field Summary

Fields

Modifier and Type	Field and Description
static String	S3_BUCKET_PROPERTY_NAME
static String	S3_ENDPOINT_OVERRIDE_PROPERTY_NAME
static String	S3_MAX_CONCURRENCY
static String	S3_REGION_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileStoreSwitcher(JiraProperties jiraProperties, DataCenterOrDevModeCheck dataCenterOrDevModeCheck, FileStoresConfigurationLoader fileStoresConfigurationLoader, FileStoreAssociationTarget fileStoreAssociationTarget, Class<? extends T> defaultImplementation, Map<FileStoreConfigType,Class<? extends T>> fileStoreConfigTypeToProviderClassMap, Class<? extends T> invalidImplementation)

Method Summary

Modifier and Type	Method and Description
protected io.atlassian.fugue.Either<String,io.atlassian.fugue.Unit>	canUseAlternateFileStore() Only DC installations are licensed to store files in alternative object stores.
Class<? extends T>	getComponentImplementation() This method is used by the Pico ContainerRegistrar to choose which implementation class will be used when providing an instance of type T.
Optional<io.atlassian.fugue.Either<FileStoreLoadingError,FileStoreConfig>>	getFileStoreConfig()
protected boolean	isS3ConfiguredViaSystemProperties() Checks if Jira has been configured to store avatars and attachments in S3 using system properties.

Methods inherited from class java.lang.Object

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

Field Detail

S3_BUCKET_PROPERTY_NAME

public static final String S3_BUCKET_PROPERTY_NAME

See Also:

Constant Field Values

S3_REGION_PROPERTY_NAME

public static final String S3_REGION_PROPERTY_NAME

See Also:

Constant Field Values

S3_MAX_CONCURRENCY

public static final String S3_MAX_CONCURRENCY

See Also:

Constant Field Values

S3_ENDPOINT_OVERRIDE_PROPERTY_NAME

public static final String S3_ENDPOINT_OVERRIDE_PROPERTY_NAME

See Also:

Constant Field Values

Constructor Detail

FileStoreSwitcher

protected FileStoreSwitcher(JiraProperties jiraProperties,
                            DataCenterOrDevModeCheck dataCenterOrDevModeCheck,
                            FileStoresConfigurationLoader fileStoresConfigurationLoader,
                            FileStoreAssociationTarget fileStoreAssociationTarget,
                            Class<? extends T> defaultImplementation,
                            Map<FileStoreConfigType,Class<? extends T>> fileStoreConfigTypeToProviderClassMap,
                            Class<? extends T> invalidImplementation)

Method Detail

getComponentImplementation

public final Class<? extends T> getComponentImplementation()

This method is used by the Pico ContainerRegistrar to choose which implementation class will be used when providing an instance of type T.

Returns:

the class of the FileStoreProvider that should be used.

getFileStoreConfig

public Optional<io.atlassian.fugue.Either<FileStoreLoadingError,FileStoreConfig>> getFileStoreConfig()

isS3ConfiguredViaSystemProperties

protected final boolean isS3ConfiguredViaSystemProperties()

Checks if Jira has been configured to store avatars and attachments in S3 using system properties.

Returns:

true if the both the region and bucket name system properties are set.

canUseAlternateFileStore

protected io.atlassian.fugue.Either<String,io.atlassian.fugue.Unit> canUseAlternateFileStore()

Only DC installations are licensed to store files in alternative object stores. This method checks if the current installation is using a DC license or is in dev mode.

Returns:

either representing whether an alternative object stores can be enabled or an error string