Package com.codebarrel.jira.plugin.automation.thirdparty

Class ThirdPartyComponentExecutor

java.lang.Object

com.codebarrel.jira.plugin.automation.thirdparty.ThirdPartyComponentExecutor

All Implemented Interfaces:

ComponentExecutor, TriggerExecutor

public class ThirdPartyComponentExecutor
extends Object
implements ComponentExecutor, TriggerExecutor

Allows for 3rd party components to run inside our app.

Constructor Summary

Constructors

Constructor	Description
ThirdPartyComponentExecutor(ThirdPartyContextHelper contextHelper, ThirdPartyComponentInputsFactory inputsFactory, com.codebarrel.automation.api.config.ComponentType type, com.codebarrel.automation.api.thirdparty.AutomationRuleComponent component)

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(ComponentContext componentContext, ComponentInputs componentInputs)	Checks if a trigger can handle the inputs provided.
ComponentExecutionResult	execute(ComponentContext context, ComponentInputs inputs, AuditComponentChangeBuilder audit)	Executes an action, give the provided context and inputs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ThirdPartyComponentExecutor

public ThirdPartyComponentExecutor(ThirdPartyContextHelper contextHelper,
 ThirdPartyComponentInputsFactory inputsFactory,
 com.codebarrel.automation.api.config.ComponentType type,
 com.codebarrel.automation.api.thirdparty.AutomationRuleComponent component)

Method Details

canHandle

public boolean canHandle(ComponentContext componentContext,
 ComponentInputs componentInputs)

Description copied from interface: TriggerExecutor

Checks if a trigger can handle the inputs provided. This method should return false if no inputs are available that this component can process. Note that this will stop the rule from executing at that point, so if you want to do nothing in the rule, return true and do checks in the execute method.

Specified by:

canHandle in interface TriggerExecutor

Parameters:

componentContext - The context to execute this component

componentInputs - Inputs needed by the component

Returns:

false if this component can't handle the provided inputs.

execute

public ComponentExecutionResult execute(ComponentContext context,
 ComponentInputs inputs,
 AuditComponentChangeBuilder audit)

Description copied from interface: ComponentExecutor

Executes an action, give the provided context and inputs. Implementations can pick and chose what inputs they wish to handle. Implementations can choose if they want to stop execution of the component chain by returning an appropriate execution reuls. Implementations can also add additional inputs for the next component in the chain.

Specified by:

execute in interface ComponentExecutor

Parameters:

context - The context to execute this component

inputs - Inputs needed by the component

Returns:

the outputs of this executor (inputs with additional stuff) and what should happen next.