Package com.atlassian.jira.plugins.webhooks.workflow

Class TriggerWebHookFunctionPluginFactory

java.lang.Object

com.atlassian.jira.plugin.workflow.AbstractWorkflowPluginFactory

com.atlassian.jira.plugins.webhooks.workflow.TriggerWebHookFunctionPluginFactory

All Implemented Interfaces:

WorkflowPluginFactory, WorkflowPluginFunctionFactory

public class TriggerWebHookFunctionPluginFactory
extends AbstractWorkflowPluginFactory
implements WorkflowPluginFunctionFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_FIELD_ID
static final String	SELECTED_WEBHOOK
static final String	TARGET_FIELD_ID
static final String	WEBHOOK_NAME
static final String	WEBHOOKS

Constructor Summary

Constructors

Constructor	Description
TriggerWebHookFunctionPluginFactory(com.atlassian.webhooks.WebhookService webHookService)

Method Summary

Modifier and Type	Method	Description
Map<String,?>	getDescriptorParams(Map<String,Object> formParams)	Given a set of name:value parameters from the plugin configuration page (ie.
protected void	getVelocityParamsForEdit(Map<String,Object> velocityParams, com.opensymphony.workflow.loader.AbstractDescriptor descriptor)	Populates the given map with velocity parameters for 'edit-parameters' velocity template.
protected void	getVelocityParamsForInput(Map<String,Object> velocityParams)	Get velocity parameters for 'input-parameters' velocity template.
protected void	getVelocityParamsForView(Map<String,Object> velocityParams, com.opensymphony.workflow.loader.AbstractDescriptor descriptor)	Populates the given map with velocity parameters for 'view' velocity template.

Methods inherited from class com.atlassian.jira.plugin.workflow.AbstractWorkflowPluginFactory

createMap, extractMultipleParams, extractSingleParam, getVelocityParams

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.plugin.workflow.WorkflowPluginFactory

getVelocityParams

Field Details

PARAM_FIELD_ID

public static final String PARAM_FIELD_ID

See Also:

• Constant Field Values

TARGET_FIELD_ID

public static final String TARGET_FIELD_ID

See Also:

• Constant Field Values

WEBHOOKS

public static final String WEBHOOKS

See Also:

• Constant Field Values

SELECTED_WEBHOOK

public static final String SELECTED_WEBHOOK

See Also:

• Constant Field Values

WEBHOOK_NAME

public static final String WEBHOOK_NAME

See Also:

• Constant Field Values

Constructor Details

TriggerWebHookFunctionPluginFactory

public TriggerWebHookFunctionPluginFactory(com.atlassian.webhooks.WebhookService webHookService)

Method Details

getVelocityParamsForInput

protected void getVelocityParamsForInput(Map<String,Object> velocityParams)

Description copied from class: AbstractWorkflowPluginFactory

Get velocity parameters for 'input-parameters' velocity template.

Specified by:

getVelocityParamsForInput in class AbstractWorkflowPluginFactory

Parameters:

velocityParams - Map to populate.

See Also:

• AbstractWorkflowPluginFactory.getVelocityParams(String, com.opensymphony.workflow.loader.AbstractDescriptor)

getVelocityParamsForEdit

protected void getVelocityParamsForEdit(Map<String,Object> velocityParams,
 com.opensymphony.workflow.loader.AbstractDescriptor descriptor)

Description copied from class: AbstractWorkflowPluginFactory

Populates the given map with velocity parameters for 'edit-parameters' velocity template. Typically an implementation would call descriptor.getArgs() to retrieve the current configuration, and populate velocityParams from that.

Specified by:

getVelocityParamsForEdit in class AbstractWorkflowPluginFactory

Parameters:

velocityParams - Map to populate.

descriptor - Eg. FunctionDescriptor or ConditionDescriptor describing the function/condition and its current configuration.

See Also:

• AbstractWorkflowPluginFactory.getVelocityParams(String, com.opensymphony.workflow.loader.AbstractDescriptor)

getVelocityParamsForView

protected void getVelocityParamsForView(Map<String,Object> velocityParams,
 com.opensymphony.workflow.loader.AbstractDescriptor descriptor)

Description copied from class: AbstractWorkflowPluginFactory

Populates the given map with velocity parameters for 'view' velocity template. Eg. call descriptor.getArgs() to retrieve the current configuration, look up a displayable string for the value and and populate velocityParams with that.

Specified by:

getVelocityParamsForView in class AbstractWorkflowPluginFactory

Parameters:

velocityParams - Map to populate.

descriptor - Eg. a FunctionDescriptor or ConditionDescriptor describing the function/condition and its current configuration.

See Also:

• AbstractWorkflowPluginFactory.getVelocityParams(String, com.opensymphony.workflow.loader.AbstractDescriptor)

getDescriptorParams

public Map<String,?> getDescriptorParams(Map<String,Object> formParams)

Description copied from interface: WorkflowPluginFactory

Given a set of name:value parameters from the plugin configuration page (ie. the 'input-parameters' velocity template) return a map of sanitized parameters which will be passed into workflow plugin instances. For example, the results are passed in the 'arg' parameter of post-functions' execute() or conditions' passesCondition methods. The velocity page often submits values in array form, and this method extracts just the relevant value.

Specified by:

getDescriptorParams in interface WorkflowPluginFactory

Parameters:

formParams - Parameters from the velocity template, eg. {"fieldId" : ["assignee"], "fieldValue":["-1"]}

Returns:

Parameters to be passed into workflow functions via the 'args' map. Eg. {"assignee": "-1"}