View Source

Available:	Bamboo 2.7 and later

On this page:

Purpose of this Module Type

Pre-Chain Action modules allow plugins to define custom functionality that runs before the Plan executes. The module provides access to the Chain object and the ChainExecution.

Configuration

The root element for the Pre-Chain Action module is preChainAction. It allows the following attributes and child elements for configuration:

Attributes

Name	Description	Default
class
key		N/A
name	Only used in the plugin's administrative user interface.

Elements

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

Name	Required	Description	Default
description		Use this element to describe the section.

Interface

Pre-Chain Action modules must implement the PreChainAction interface.

Example

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

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

    <preChainAction key="myPreChainAction" class="com.atlassian.example.bamboo.actions.MyPreChainAction">
        <description>Sets up the MyBambooPlugin if the Chain has the plugin enabled</description>
    </preChainAction>
</atlassian-plugin>