Package com.atlassian.jira.config.filestore

Class FileStoresConfigHandler

java.lang.Object

com.atlassian.jira.config.filestore.FileStoresConfigHandler

All Implemented Interfaces:

CustomConfigHandler<FileStoresConfig>

@ParametersAreNonnullByDefault
public class FileStoresConfigHandler
extends Object
implements CustomConfigHandler<FileStoresConfig>

Parses filestore configuration. Allows multiple filestores to be defined and associated with one more FileStoreAssociationTarget. The writeTo(org.dom4j.Element, com.atlassian.jira.config.filestore.FileStoresConfig) method has not been implemented. Users are expected to manually edit the configuration.

Since:

9.9

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILESTORE_CANNOT_BE_PARSED_MESSAGE

Constructor Summary

Constructors

Constructor	Description
FileStoresConfigHandler()

Method Summary

Modifier and Type	Method	Description
Class<FileStoresConfig>	getBeanClass()
FileStoresConfig	parse(org.dom4j.Element element)	Tries to parse configuration from an xml file.
void	writeTo(org.dom4j.Element element, FileStoresConfig fileStoresConfig)

Methods inherited from class java.lang.Object

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

Field Details

FILESTORE_CANNOT_BE_PARSED_MESSAGE

public static final String FILESTORE_CANNOT_BE_PARSED_MESSAGE

Constructor Details

FileStoresConfigHandler

public FileStoresConfigHandler()

Method Details

getBeanClass

public Class<FileStoresConfig> getBeanClass()

Specified by:

getBeanClass in interface CustomConfigHandler<FileStoresConfig>

Returns:

the class of the config bean that this class works with

parse

public FileStoresConfig parse(org.dom4j.Element element)

Tries to parse configuration from an xml file. Example configuration xml:

   <?xml version="1.1" ?>
   <filestore-config>
     
       <s3-filestore id="avatarBucket">
         
           <bucket-name>exmple-bucket</bucket-name>
           us-east-1
         
       </s3-filestore>
     
     
       
     
   </filestore-config>
 

Specified by:

parse in interface CustomConfigHandler<FileStoresConfig>

Parameters:

element - the root Element of the xml to parse

Returns:

a FileStoresConfig which represents the parsed config. It may contain errors where parts of the config could not be parsed.

Throws:

ConfigParseException - if the high-level structure of the passed Element is not valid.

writeTo

public void writeTo(org.dom4j.Element element,
 FileStoresConfig fileStoresConfig)

Specified by:

writeTo in interface CustomConfigHandler<FileStoresConfig>