Plan Deletion Interceptor Action Module

Available:

Bamboo 2.7 and later

On this page:

Purpose of this Module Type

The Plan Deletion Interceptor Action module before the plan and its results have been deleted. Any plugins that implement this interface will be run inline with the methods on DeletionService. If any implementations fail to execute (throw an exception, etc) the plan will be deleted regardless of the success or failure of this module.

Note that all derivatives of Plan, such as Job and Chain, will be passed through this module. You may need to use the Narrow utility to cast to the correct type.

Configuration

The root element for the Plan Deletion Interceptor Action module is planDeletionInterceptorAction. It allows the following attributes and child elements for configuration:

Attributes

Name

Description

class

The class which implements this plugin module. The class you need to provide depends on the module type. For example, Confluence theme, layout and colour-scheme modules can use classes already provided in Confluence. So you can write a theme-plugin without any Java code. But for macro and listener modules you need to write your own implementing class and include it in your plugin. See the plugin framework guide to creating plugin module instances.

Required: yes

Default: -

key

The unique identifier of the plugin module. You refer to this key to use the resource from other contexts in your plugin, such as from the plugin Java code or JavaScript resources.

<component-import key="appProps" interface="com.atlassian.sal.api.ApplicationProperties"/>

In the example, appProps is the key for this particular module declaration, for component-import, in this case.

Required: yes

Default: N/A

name

The human-readable name of the plugin module. Only used in the plugin's administrative user interface.

Required: -

Default: -

Elements

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

Name

Description

description

The description of the plugin module. The 'key' attribute can be specified to declare a localisation key for the value instead of text in the element body. Use this element to describe the section.

Required: -

Default: -

Interface

Plan Deletion Interceptor Action modules must implement the PlanDeletionInterceptorAction interface.

Example

Here is an example atlassian-plugin.xml file containing a Plan Deletion Interceptor Action module:

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

    <planDeletionInterceptorAction key="myPlanDeletionInterceptorAction" class="com.atlassian.example.bamboo.actions.MyPlanDeletionInterceptorAction">
        <description>Removes plugin configuration from the administration configuration before the plan is deleted</description>
    </planDeletionInterceptorAction>
</atlassian-plugin>
Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport