com.dynatrace.diagnostics.pdk
Interface Action

All Superinterfaces:
Plugin

public interface Action
extends Plugin

The interface for Action Plugins.

Action Plugins utilize the ActionEnvironment to retrieve informations about incidents.


Method Summary
 Status execute(ActionEnvironment env)
          Executes the Action Plugin to process incidents.
 Status setup(ActionEnvironment env)
          Initializes the Plugin.
 void teardown(ActionEnvironment env)
          Shuts the Plugin down and frees resources.
 

Method Detail

setup

Status setup(ActionEnvironment env)
             throws java.lang.Exception
Initializes the Plugin. This method is called once for each IncidentRule to be processed.

If the returned status is null or the status code is a non-success code then teardown(ActionEnvironment) will be called next.

Resources like sockets or files can be opened in this method.

Parameters:
env - the configured ActionEnvironment for this Plugin; does not contain any incidents
Returns:
a Status object that describes the result of the method call
Throws:
java.lang.Exception
See Also:
teardown(ActionEnvironment)

execute

Status execute(ActionEnvironment env)
               throws java.lang.Exception
Executes the Action Plugin to process incidents.

This method may be called at the scheduled intervals, but only if incidents occurred in the meantime. If the Plugin execution takes longer than the schedule interval, subsequent calls to execute(ActionEnvironment) will be skipped until this method returns. After the execution duration exceeds the schedule timeout, PluginEnvironment.isStopped() will return true. In this case execution should be stopped as soon as possible. If the Plugin ignores PluginEnvironment.isStopped() or fails to stop execution in a reasonable timeframe, the execution thread will be stopped ungracefully which might lead to resource leaks!

Parameters:
env - a ActionEnvironment object that contains the Plugin configuration and incidents
Returns:
a Status object that describes the result of the method call
Throws:
java.lang.Exception

teardown

void teardown(ActionEnvironment env)
              throws java.lang.Exception
Shuts the Plugin down and frees resources. This method is called in the following cases:

The Plugin methods setup, execute and teardown are called on different threads, but they are called sequentially. This means that the execution of these methods does not overlap, they are executed one after the other.

All by the Plugin allocated resources should be freed in this method. Examples are opened sockets or files.

Throws:
java.lang.Exception
See Also:
setup(ActionEnvironment)


Copyright © 2004-2012 dynaTrace software GmbH