Plan Deletion Interceptor Action Module

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

Elements

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

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>