Support for Server products ended Feb. 15, 2024. Learn what this means for you.

File Store Plugin Module

Introduction

The File Store plugin module allows you to provide a custom file store implementation for Bitbucket Data Center. At the time of writing the only usage of the File Store API is for the storage of Git LFS objects. In the future other uses are expected to be added.

Configuration

The root element for the File Store plugin module is <file-store/>. It allows the following configuration attributes:

Attributes

Name	Required	Description	Default
key	Yes	The identifier of the plugin module. This key must be unique amongst all file store implementations since it is how administrators select which file store implementation to use. Third party plugins must use a `key` of the form `company-filestore` to avoid conflicts with Atlassian's own file store implementations, and the implementations of other third party vendors. For example if your company is called "Foo Co." and you are implementing a plugins for an object store named "Bar", then you might use a key of `foo-bar`.	N/A
class	Yes	The fully qualified Java class name of the class that implements the File Store SPI. This class must implement `PluginFileStore`.	N/A

Example

Here is an example for a custom file store implementation:

1
2

<atlassian-plugin key="${project.groupId}.${project.artifactId}" name="${project.name}" plugins-version="2">

    <plugin-info>
        <description>${project.description}</description>
        <version>${project.version}</version>
        <vendor name="${project.organization.name}" url="${project.organization.url}" />
    </plugin-info>
    
    <file-store key="example-filestore" class="com.example.filestore.ExamplePluginFileStore"/>

</atlassian-plugin>