com.atlassian.jira.workflow

Class CachingDraftWorkflowStore

java.lang.Object

com.atlassian.jira.workflow.CachingDraftWorkflowStore

All Implemented Interfaces:

DraftWorkflowStore

public class CachingDraftWorkflowStore
extends Object
implements DraftWorkflowStore

Provides a caching implementation of the DraftWorkflowStore.

Since:

v3.13

Constructor Summary

Constructors

Constructor and Description
CachingDraftWorkflowStore(DraftWorkflowStore delegate, com.atlassian.cache.CacheManager cacheManager)

Method Summary

Modifier and Type	Method and Description
JiraWorkflow	createDraftWorkflow(ApplicationUser author, JiraWorkflow parentWorkflow) Creates a temporary workflow linked back to the named active workflow by id.
boolean	deleteDraftWorkflow(String parentWorkflowName) Removes a temporary workflow linked to the workflow name.
JiraWorkflow	getDraftWorkflow(String parentWorkflowName) This will retrieve an draft workflow that is related to the named saved workflow.
void	onClearCache(ClearCacheEvent event)
JiraWorkflow	updateDraftWorkflow(ApplicationUser user, String parentWorkflowName, JiraWorkflow workflow) Updates a temporary workflow with the one provided for the parent workflow name passed in.
JiraWorkflow	updateDraftWorkflowWithoutAudit(String parentWorkflowName, JiraWorkflow workflow) Updates a temporary workflow with the one provided for the parent workflow name passed in.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingDraftWorkflowStore

public CachingDraftWorkflowStore(DraftWorkflowStore delegate,
                                 com.atlassian.cache.CacheManager cacheManager)

Method Detail

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent event)

getDraftWorkflow

public JiraWorkflow getDraftWorkflow(String parentWorkflowName)
                              throws DataAccessException

Description copied from interface: DraftWorkflowStore

This will retrieve an draft workflow that is related to the named saved workflow. If an draft workflow is not associated with the passed in name this will return null.

Specified by:

getDraftWorkflow in interface DraftWorkflowStore

Parameters:

parentWorkflowName - of the saved parent workflow.

Returns:

workflow that represents the draft "copy" of the named active workflow. This will be of type JiraDraftWorkflow.

Throws:

DataAccessException - DataAccessException

createDraftWorkflow

public JiraWorkflow createDraftWorkflow(ApplicationUser author,
                                        JiraWorkflow parentWorkflow)
                                 throws DataAccessException,
                                        IllegalStateException,
                                        IllegalArgumentException

Description copied from interface: DraftWorkflowStore

Creates a temporary workflow linked back to the named active workflow by id. If a temporary workflow already exists, this method will throw an exception.

Specified by:

createDraftWorkflow in interface DraftWorkflowStore

Parameters:

author - The user making the edit

parentWorkflow - The parent workflow to copy for the draft workflow.

Returns:

workflow that represents the draft "copy" of the named active workflow. This will be of type JiraDraftWorkflow.

Throws:

DataAccessException - if there are any db errors

IllegalStateException - thrown if you are adding an draft workflow which already exists for the provided parent workflow

IllegalArgumentException - If the username is null

deleteDraftWorkflow

public boolean deleteDraftWorkflow(String parentWorkflowName)
                            throws DataAccessException,
                                   IllegalArgumentException

Description copied from interface: DraftWorkflowStore

Removes a temporary workflow linked to the workflow name.

Specified by:

deleteDraftWorkflow in interface DraftWorkflowStore

Parameters:

parentWorkflowName - of the saved parent workflow.

Returns:

True if deleted successfully

Throws:

DataAccessException - RuntimeException wrapper around a DB Exception.

IllegalArgumentException

updateDraftWorkflow

public JiraWorkflow updateDraftWorkflow(ApplicationUser user,
                                        String parentWorkflowName,
                                        JiraWorkflow workflow)
                                 throws DataAccessException

Description copied from interface: DraftWorkflowStore

Updates a temporary workflow with the one provided for the parent workflow name passed in. Throws an exception, if no temporary workflow exists for the one being updated.

Specified by:

updateDraftWorkflow in interface DraftWorkflowStore

Parameters:

user - is the user updating this draft workflow.

parentWorkflowName - of the saved parent workflow.

workflow - The JiraWorkflow to use for the update.

Returns:

workflow that represents the draft "copy" of the named active workflow. This will be of type JiraDraftWorkflow.

Throws:

DataAccessException - RuntimeException wrapper around a DB Exception.

updateDraftWorkflowWithoutAudit

public JiraWorkflow updateDraftWorkflowWithoutAudit(String parentWorkflowName,
                                                    JiraWorkflow workflow)
                                             throws DataAccessException

Description copied from interface: DraftWorkflowStore

Updates a temporary workflow with the one provided for the parent workflow name passed in. Throws an exception, if no temporary workflow exists for the one being updated. This will not update the draft author or the draft date.

This method should only be used by upgrade tasks. Use DraftWorkflowStore.updateDraftWorkflow(ApplicationUser, String, JiraWorkflow) instead.

Specified by:

updateDraftWorkflowWithoutAudit in interface DraftWorkflowStore

Parameters:

parentWorkflowName - of the saved parent workflow.

workflow - The JiraWorkflow to use for the update.

Returns:

workflow that represents the draft "copy" of the named active workflow. This will be of type JiraDraftWorkflow.

Throws:

DataAccessException - RuntimeException wrapper around a DB Exception.