Post Chain Index Writer Module

On this page:

Purpose of this Module Type

The Post Chain Index Writer modules allows you to write your custom data for a build into the index, which allows for future retrieval in your custom Report Module. The Post Chain Index Writer modules will be invoked in three places in Bamboo: when a build completes and it indexes, operations which requires a re-index of a particular chain (result), and when you run the re-index all action under the Administration tab.

The Post Chain Index Writer should always be written in conjunction with a Index Reader Module which will be able to retrieve the data in the index.

構成

The root element for the Post Chain Index Writer module is postChainIndexWriter. It allows the following attributes and child elements for configuration:

属性

Elements

The table summarises the elements. The sections below contain further information.

Interface

Post Chain Index Writer modules must implement the PostChainIndexWriter interface.

例

Here is an example atlassian-plugin.xml file containing a Post Chain Index Writer Action module:

 
<atlassian-plugin name="Hello World" key="example.plugin.helloworld"> 
  <plugin-info> 
    <description>A Post Chain Index Writer module type test</description> 
    <vendor name="Atlassian Software Systems" url="http://www.atlassian.com"/> 
    <version>1.0</version> 
  </plugin-info> 

  <postChainIndexWriter key="myChainIndexWriter" name="Example Post Chain Index Writer"
          class="com.atlassian.example.bamboo.actions.MyChainIndexWriter">
    <description>Writes the My Example Plugin Results to the Lucene index</description>
  </postChainIndexWriter>
</atlassian-plugin>