Package org.dspace.xmlworkflow

Class XmlWorkflowServiceImpl

java.lang.Object

org.dspace.xmlworkflow.XmlWorkflowServiceImpl

All Implemented Interfaces:

WorkflowService<XmlWorkflowItem>, XmlWorkflowService

public class XmlWorkflowServiceImpl
extends Object
implements XmlWorkflowService

When an item is submitted and is somewhere in a workflow, it has a row in the WorkflowItem table pointing to it. Once the item has completed the workflow it will be archived

Author:

Bram De Schouwer (bram.deschouwer at dot com), Kevin Van de Velde (kevin at atmire dot com), Ben Bosman (ben at atmire dot com), Mark Diggory (markd at atmire dot com)

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthorizeService	authorizeService
protected BitstreamFormatService	bitstreamFormatService
protected BitstreamService	bitstreamService
protected BundleService	bundleService
protected ClaimedTaskService	claimedTaskService
protected CollectionRoleService	collectionRoleService
protected GroupService	groupService
protected HandleService	handleService
protected InstallItemService	installItemService
protected ItemService	itemService
protected Map<UUID,Boolean>	noEMail
protected PoolTaskService	poolTaskService
protected WorkflowItemRoleService	workflowItemRoleService
protected WorkflowRequirementsService	workflowRequirementsService
protected WorkspaceItemService	workspaceItemService
protected XmlWorkflowFactory	xmlWorkflowFactory
protected XmlWorkflowItemService	xmlWorkflowItemService

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XmlWorkflowServiceImpl()

Method Summary

Modifier and Type	Method	Description
WorkspaceItem	abort(Context c, XmlWorkflowItem wi, EPerson e)	abort() aborts a workflow, completely deleting it (administrator do this) (it will basically do a reject from any state - the item ends up back in the user's PersonalWorkspace
protected void	activateFirstStep(Context context, Workflow wf, Step firstStep, XmlWorkflowItem wfi)
protected void	addGroupPolicyToItem(Context context, Item item, int action, Group group, String policyType)
protected void	addPolicyToItem(Context context, Item item, int action, EPerson epa, String policyType)
void	alertUsersOnTaskActivation(Context c, XmlWorkflowItem wfi, String emailTemplate, List<EPerson> epa, String... arguments)
protected Item	archive(Context context, XmlWorkflowItem wfi)	Commit the contained item to the main archive.
void	createOwnedTask(Context context, XmlWorkflowItem wi, Step step, WorkflowActionConfig action, EPerson e)
void	createPoolTasks(Context context, XmlWorkflowItem wi, RoleMembers assignees, Step step, WorkflowActionConfig action)
Group	createWorkflowRoleGroup(Context context, Collection collection, String roleName)	This method will create the workflowRoleGroup for a collection and the given rolename
void	deleteAllPooledTasks(Context context, XmlWorkflowItem wi)
void	deleteAllTasks(Context context, XmlWorkflowItem wi)	Deletes all tasks from this workflowflowitem
void	deleteClaimedTask(Context c, XmlWorkflowItem wi, ClaimedTask task)
void	deleteCollection(Context context, Collection collection)
void	deletePooledTask(Context context, XmlWorkflowItem wi, PoolTask task)
WorkflowActionConfig	doState(Context c, EPerson user, javax.servlet.http.HttpServletRequest request, int workflowItemId, Workflow workflow, WorkflowActionConfig currentActionConfig)
List<String>	getEPersonDeleteConstraints(Context context, EPerson ePerson)
String	getEPersonName(EPerson ePerson)
List<String>	getFlywayMigrationLocations()
String	getMyDSpaceLink()
Group	getWorkflowRoleGroup(Context context, Collection collection, String roleName, Group roleGroup)
protected void	grantGroupAllItemPolicies(Context context, Item item, Group group, String policyType)
protected void	grantSubmitterReadPolicies(Context context, Item item)
void	grantUserAllItemPolicies(Context context, Item item, EPerson epa, String policyType)
protected void	logWorkflowEvent(Context c, String workflowId, String previousStepId, String previousActionConfigId, XmlWorkflowItem wfi, EPerson actor, Step newStep, WorkflowActionConfig newActionConfig)
protected void	notifyOfArchive(Context context, Item item, Collection coll)	notify the submitter that the item is archived
protected void	notifyOfReject(Context c, XmlWorkflowItem wi, EPerson e, String reason)
protected WorkflowActionConfig	processNextStep(Context c, EPerson user, Workflow workflow, ActionResult currentOutcome, XmlWorkflowItem wfi, Step nextStep)
WorkflowActionConfig	processOutcome(Context c, EPerson user, Workflow workflow, Step currentStep, WorkflowActionConfig currentActionConfig, ActionResult currentOutcome, XmlWorkflowItem wfi, boolean enteredNewStep)
protected void	recordStart(Context context, Item myitem, Action action)
protected void	removeGroupItemPolicies(Context context, Item item, Group e)
void	removeUserItemPolicies(Context context, Item item, EPerson e)
protected WorkspaceItem	returnToWorkspace(Context c, XmlWorkflowItem wfi)	Return the workflow item to the workspace of the submitter.
protected void	revokeReviewerPolicies(Context context, Item item)
WorkspaceItem	sendWorkflowItemBackSubmission(Context context, XmlWorkflowItem wi, EPerson e, String provenance, String rejection_message)
XmlWorkflowItem	start(Context context, WorkspaceItem wsi)	startWorkflow() begins a workflow - in a single transaction do away with the PersonalWorkspace entry and turn it into a WorkflowItem.
XmlWorkflowItem	startWithoutNotify(Context context, WorkspaceItem wsi)	startWithoutNotify() starts the workflow normally, but disables notifications (useful for large imports,) for the first workflow step - subsequent notifications happen normally

Methods inherited from class java.lang.Object

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

Field Detail

noEMail

protected Map<UUID,Boolean> noEMail

authorizeService

@Autowired(required=true)
protected AuthorizeService authorizeService

collectionRoleService

@Autowired(required=true)
protected CollectionRoleService collectionRoleService

claimedTaskService

@Autowired(required=true)
protected ClaimedTaskService claimedTaskService

handleService

@Autowired(required=true)
protected HandleService handleService

installItemService

@Autowired(required=true)
protected InstallItemService installItemService

itemService

@Autowired(required=true)
protected ItemService itemService

poolTaskService

@Autowired(required=true)
protected PoolTaskService poolTaskService

workflowItemRoleService

@Autowired(required=true)
protected WorkflowItemRoleService workflowItemRoleService

workflowRequirementsService

@Autowired(required=true)
protected WorkflowRequirementsService workflowRequirementsService

xmlWorkflowFactory

@Autowired(required=true)
protected XmlWorkflowFactory xmlWorkflowFactory

workspaceItemService

@Autowired(required=true)
protected WorkspaceItemService workspaceItemService

xmlWorkflowItemService

@Autowired(required=true)
protected XmlWorkflowItemService xmlWorkflowItemService

groupService

@Autowired(required=true)
protected GroupService groupService

bundleService

@Autowired(required=true)
protected BundleService bundleService

bitstreamFormatService

@Autowired(required=true)
protected BitstreamFormatService bitstreamFormatService

bitstreamService

@Autowired(required=true)
protected BitstreamService bitstreamService

Constructor Detail

XmlWorkflowServiceImpl

protected XmlWorkflowServiceImpl()

Method Detail

deleteCollection

public void deleteCollection(Context context,
                             Collection collection)
                      throws SQLException,
                             IOException,
                             AuthorizeException

Specified by:

deleteCollection in interface WorkflowService<XmlWorkflowItem>

Throws:

SQLException

IOException

AuthorizeException

getEPersonDeleteConstraints

public List<String> getEPersonDeleteConstraints(Context context,
                                                EPerson ePerson)
                                         throws SQLException

Specified by:

getEPersonDeleteConstraints in interface WorkflowService<XmlWorkflowItem>

Throws:

SQLException

getWorkflowRoleGroup

public Group getWorkflowRoleGroup(Context context,
                                  Collection collection,
                                  String roleName,
                                  Group roleGroup)
                           throws SQLException,
                                  IOException,
                                  WorkflowException,
                                  AuthorizeException

Specified by:

getWorkflowRoleGroup in interface WorkflowService<XmlWorkflowItem>

Throws:

SQLException

IOException

WorkflowException

AuthorizeException

createWorkflowRoleGroup

public Group createWorkflowRoleGroup(Context context,
                                     Collection collection,
                                     String roleName)
                              throws AuthorizeException,
                                     SQLException,
                                     IOException,
                                     WorkflowConfigurationException

Description copied from interface: WorkflowService

This method will create the workflowRoleGroup for a collection and the given rolename

Specified by:

createWorkflowRoleGroup in interface WorkflowService<XmlWorkflowItem>

Parameters:

context - The relevant DSpace context

collection - The collection

roleName - The rolename

Returns:

The created Group

Throws:

AuthorizeException - If something goes wrong

SQLException - If something goes wrong

IOException - If something goes wrong

WorkflowConfigurationException - If something goes wrong

getFlywayMigrationLocations

public List<String> getFlywayMigrationLocations()

Specified by:

getFlywayMigrationLocations in interface WorkflowService<XmlWorkflowItem>

start

public XmlWorkflowItem start(Context context,
                             WorkspaceItem wsi)
                      throws SQLException,
                             AuthorizeException,
                             IOException,
                             WorkflowException

Description copied from interface: WorkflowService

startWorkflow() begins a workflow - in a single transaction do away with the PersonalWorkspace entry and turn it into a WorkflowItem.

Specified by:

start in interface WorkflowService<XmlWorkflowItem>

Parameters:

context - The relevant DSpace Context.

wsi - The WorkspaceItem to convert to a workflow item

Returns:

The resulting workflow item

Throws:

SQLException - An exception that provides information on a database access error or other errors.

AuthorizeException - Exception indicating the current user of the context does not have permission to perform a particular action.

IOException - A general class of exceptions produced by failed or interrupted I/O operations.

WorkflowException - if workflow error

startWithoutNotify

public XmlWorkflowItem startWithoutNotify(Context context,
                                          WorkspaceItem wsi)
                                   throws SQLException,
                                          AuthorizeException,
                                          IOException,
                                          WorkflowException

startWithoutNotify() starts the workflow normally, but disables notifications (useful for large imports,) for the first workflow step - subsequent notifications happen normally

Specified by:

startWithoutNotify in interface WorkflowService<XmlWorkflowItem>

Parameters:

context - The relevant DSpace Context.

wsi - workspace item

Returns:

the resulting workflow item.

Throws:

SQLException - An exception that provides information on a database access error or other errors.

AuthorizeException - Exception indicating the current user of the context does not have permission to perform a particular action.

IOException - A general class of exceptions produced by failed or interrupted I/O operations.

WorkflowException - if workflow error

alertUsersOnTaskActivation

public void alertUsersOnTaskActivation(Context c,
                                       XmlWorkflowItem wfi,
                                       String emailTemplate,
                                       List<EPerson> epa,
                                       String... arguments)
                                throws IOException,
                                       SQLException,
                                       javax.mail.MessagingException

Specified by:

alertUsersOnTaskActivation in interface XmlWorkflowService

Throws:

IOException

SQLException

javax.mail.MessagingException

grantSubmitterReadPolicies

protected void grantSubmitterReadPolicies(Context context,
                                          Item item)
                                   throws SQLException,
                                          AuthorizeException

Throws:

SQLException

AuthorizeException

activateFirstStep

protected void activateFirstStep(Context context,
                                 Workflow wf,
                                 Step firstStep,
                                 XmlWorkflowItem wfi)
                          throws AuthorizeException,
                                 IOException,
                                 SQLException,
                                 WorkflowException,
                                 WorkflowConfigurationException

Throws:

AuthorizeException

IOException

SQLException

WorkflowException

WorkflowConfigurationException

doState

public WorkflowActionConfig doState(Context c,
                                    EPerson user,
                                    javax.servlet.http.HttpServletRequest request,
                                    int workflowItemId,
                                    Workflow workflow,
                                    WorkflowActionConfig currentActionConfig)
                             throws SQLException,
                                    AuthorizeException,
                                    IOException,
                                    WorkflowException

Specified by:

doState in interface XmlWorkflowService

Throws:

SQLException

AuthorizeException

IOException

WorkflowException

processOutcome

public WorkflowActionConfig processOutcome(Context c,
                                           EPerson user,
                                           Workflow workflow,
                                           Step currentStep,
                                           WorkflowActionConfig currentActionConfig,
                                           ActionResult currentOutcome,
                                           XmlWorkflowItem wfi,
                                           boolean enteredNewStep)
                                    throws IOException,
                                           AuthorizeException,
                                           SQLException,
                                           WorkflowException

Specified by:

processOutcome in interface XmlWorkflowService

Throws:

IOException

AuthorizeException

SQLException

WorkflowException

logWorkflowEvent

protected void logWorkflowEvent(Context c,
                                String workflowId,
                                String previousStepId,
                                String previousActionConfigId,
                                XmlWorkflowItem wfi,
                                EPerson actor,
                                Step newStep,
                                WorkflowActionConfig newActionConfig)
                         throws SQLException

Throws:

SQLException

processNextStep

protected WorkflowActionConfig processNextStep(Context c,
                                               EPerson user,
                                               Workflow workflow,
                                               ActionResult currentOutcome,
                                               XmlWorkflowItem wfi,
                                               Step nextStep)
                                        throws SQLException,
                                               IOException,
                                               AuthorizeException,
                                               WorkflowException,
                                               WorkflowConfigurationException

Throws:

SQLException

IOException

AuthorizeException

WorkflowException

WorkflowConfigurationException

archive

protected Item archive(Context context,
                       XmlWorkflowItem wfi)
                throws SQLException,
                       IOException,
                       AuthorizeException

Commit the contained item to the main archive. The item is associated with the relevant collection, added to the search index, and any other tasks such as assigning dates are performed.

Parameters:

context - The relevant DSpace Context.

wfi - workflow item

Returns:

the fully archived item.

Throws:

IOException - A general class of exceptions produced by failed or interrupted I/O operations.

SQLException - An exception that provides information on a database access error or other errors.

AuthorizeException - Exception indicating the current user of the context does not have permission to perform a particular action.

notifyOfArchive

protected void notifyOfArchive(Context context,
                               Item item,
                               Collection coll)
                        throws SQLException,
                               IOException

notify the submitter that the item is archived

Parameters:

context - The relevant DSpace Context.

item - which item was archived

coll - collection name to display in template

Throws:

SQLException - An exception that provides information on a database access error or other errors.

IOException - A general class of exceptions produced by failed or interrupted I/O operations.

deleteAllTasks

public void deleteAllTasks(Context context,
                           XmlWorkflowItem wi)
                    throws SQLException,
                           AuthorizeException

Deletes all tasks from this workflowflowitem

Specified by:

deleteAllTasks in interface XmlWorkflowService

Parameters:

context - the dspace context

wi - the workflow item for which we are to delete the tasks

Throws:

SQLException - An exception that provides information on a database access error or other errors.

AuthorizeException - Exception indicating the current user of the context does not have permission to perform a particular action.

deleteAllPooledTasks

public void deleteAllPooledTasks(Context context,
                                 XmlWorkflowItem wi)
                          throws SQLException,
                                 AuthorizeException

Specified by:

deleteAllPooledTasks in interface XmlWorkflowService

Throws:

SQLException

AuthorizeException

deletePooledTask

public void deletePooledTask(Context context,
                             XmlWorkflowItem wi,
                             PoolTask task)
                      throws SQLException,
                             AuthorizeException

Specified by:

deletePooledTask in interface XmlWorkflowService

Throws:

SQLException

AuthorizeException

deleteClaimedTask

public void deleteClaimedTask(Context c,
                              XmlWorkflowItem wi,
                              ClaimedTask task)
                       throws SQLException,
                              AuthorizeException

Specified by:

deleteClaimedTask in interface XmlWorkflowService

Throws:

SQLException

AuthorizeException

createPoolTasks

public void createPoolTasks(Context context,
                            XmlWorkflowItem wi,
                            RoleMembers assignees,
                            Step step,
                            WorkflowActionConfig action)
                     throws SQLException,
                            AuthorizeException

Specified by:

createPoolTasks in interface XmlWorkflowService

Throws:

SQLException

AuthorizeException

createOwnedTask

public void createOwnedTask(Context context,
                            XmlWorkflowItem wi,
                            Step step,
                            WorkflowActionConfig action,
                            EPerson e)
                     throws SQLException,
                            AuthorizeException

Specified by:

createOwnedTask in interface XmlWorkflowService

Throws:

SQLException

AuthorizeException

grantUserAllItemPolicies

public void grantUserAllItemPolicies(Context context,
                                     Item item,
                                     EPerson epa,
                                     String policyType)
                              throws AuthorizeException,
                                     SQLException

Specified by:

grantUserAllItemPolicies in interface XmlWorkflowService

Throws:

AuthorizeException

SQLException

grantGroupAllItemPolicies

protected void grantGroupAllItemPolicies(Context context,
                                         Item item,
                                         Group group,
                                         String policyType)
                                  throws AuthorizeException,
                                         SQLException

Throws:

AuthorizeException

SQLException

addPolicyToItem

protected void addPolicyToItem(Context context,
                               Item item,
                               int action,
                               EPerson epa,
                               String policyType)
                        throws AuthorizeException,
                               SQLException

Throws:

AuthorizeException

SQLException

addGroupPolicyToItem

protected void addGroupPolicyToItem(Context context,
                                    Item item,
                                    int action,
                                    Group group,
                                    String policyType)
                             throws AuthorizeException,
                                    SQLException

Throws:

AuthorizeException

SQLException

removeUserItemPolicies

public void removeUserItemPolicies(Context context,
                                   Item item,
                                   EPerson e)
                            throws SQLException,
                                   AuthorizeException

Specified by:

removeUserItemPolicies in interface XmlWorkflowService

Throws:

SQLException

AuthorizeException

removeGroupItemPolicies

protected void removeGroupItemPolicies(Context context,
                                       Item item,
                                       Group e)
                                throws SQLException,
                                       AuthorizeException

Throws:

SQLException

AuthorizeException

sendWorkflowItemBackSubmission

public WorkspaceItem sendWorkflowItemBackSubmission(Context context,
                                                    XmlWorkflowItem wi,
                                                    EPerson e,
                                                    String provenance,
                                                    String rejection_message)
                                             throws SQLException,
                                                    AuthorizeException,
                                                    IOException

Specified by:

sendWorkflowItemBackSubmission in interface WorkflowService<XmlWorkflowItem>

Throws:

SQLException

AuthorizeException

IOException

abort

public WorkspaceItem abort(Context c,
                           XmlWorkflowItem wi,
                           EPerson e)
                    throws AuthorizeException,
                           SQLException,
                           IOException

Description copied from interface: WorkflowService

abort() aborts a workflow, completely deleting it (administrator do this) (it will basically do a reject from any state - the item ends up back in the user's PersonalWorkspace

Specified by:

abort in interface WorkflowService<XmlWorkflowItem>

Parameters:

c - The relevant DSpace Context.

wi - WorkflowItem to operate on

e - EPerson doing the operation

Returns:

workspace item returned to workspace

Throws:

AuthorizeException - Exception indicating the current user of the context does not have permission to perform a particular action.

SQLException - An exception that provides information on a database access error or other errors.

IOException - A general class of exceptions produced by failed or interrupted I/O operations.

returnToWorkspace

protected WorkspaceItem returnToWorkspace(Context c,
                                          XmlWorkflowItem wfi)
                                   throws SQLException,
                                          IOException,
                                          AuthorizeException

Return the workflow item to the workspace of the submitter. The workflow item is removed, and a workspace item created.

Parameters:

c - Context

wfi - WorkflowItem to be 'dismantled'

Returns:

the workspace item

Throws:

IOException - ...

SQLException - ...

AuthorizeException - ...

getEPersonName

public String getEPersonName(EPerson ePerson)

Specified by:

getEPersonName in interface XmlWorkflowService

recordStart

protected void recordStart(Context context,
                           Item myitem,
                           Action action)
                    throws SQLException,
                           IOException,
                           AuthorizeException

Throws:

SQLException

IOException

AuthorizeException

notifyOfReject

protected void notifyOfReject(Context c,
                              XmlWorkflowItem wi,
                              EPerson e,
                              String reason)

getMyDSpaceLink

public String getMyDSpaceLink()

Specified by:

getMyDSpaceLink in interface WorkflowService<XmlWorkflowItem>

revokeReviewerPolicies

protected void revokeReviewerPolicies(Context context,
                                      Item item)
                               throws SQLException,
                                      AuthorizeException

Throws:

SQLException

AuthorizeException