Package pro.taskana.workbasket.internal

Class WorkbasketServiceImpl

java.lang.Object

pro.taskana.workbasket.internal.WorkbasketServiceImpl

All Implemented Interfaces:

WorkbasketService

public class WorkbasketServiceImpl
extends Object
implements WorkbasketService

This is the implementation of WorkbasketService.

Constructor Summary

Constructors

Constructor	Description
WorkbasketServiceImpl(InternalTaskanaEngine taskanaEngine, HistoryEventManager historyEventManager, WorkbasketMapper workbasketMapper, DistributionTargetMapper distributionTargetMapper, WorkbasketAccessMapper workbasketAccessMapper)

Method Summary

Modifier and Type	Method	Description
void	addDistributionTarget(String sourceWorkbasketId, String targetWorkbasketId)	Add a distribution target to a Workbasket.
void	checkAuthorization(String workbasketKey, String domain, WorkbasketPermission... requestedPermissions)	This method checks the authorization for the actual User.
void	checkAuthorization(String workbasketId, WorkbasketPermission... requestedPermissions)	This method checks the authorization for the actual User.
void	checkModifiedHasNotChanged(Workbasket oldWorkbasket, WorkbasketImpl workbasketImplToUpdate)	Check if current workbasket is based on the newest (by modified).
Workbasket	createWorkbasket(Workbasket newWorkbasket)	Creates a new Workbasket.
WorkbasketAccessItem	createWorkbasketAccessItem(WorkbasketAccessItem workbasketAccessItem)	Create and insert a new WorkbasketAccessItem with a workbasketId, an accessId and permissions.
WorkbasketAccessItemQuery	createWorkbasketAccessItemQuery()	This method provides a query builder for querying the database.
WorkbasketQuery	createWorkbasketQuery()	This method provides a query builder for querying the database.
boolean	deleteWorkbasket(String workbasketId)	Deletes the Workbasket by the given id.
void	deleteWorkbasketAccessItem(String accessItemId)	Deletes a specific WorkbasketAccessItem.
void	deleteWorkbasketAccessItemsForAccessId(String accessId)	Deletes all WorkbasketAccessItems using the given WorkbasketAccessItem.getAccessId().
BulkOperationResults<String,TaskanaException>	deleteWorkbaskets(List<String> workbasketsIds)	Deletes the list of Workbaskets specified via ids.
List<WorkbasketSummary>	getDistributionSources(String workbasketId)	Returns the distribution sources for a given Workbasket.
List<WorkbasketSummary>	getDistributionSources(String workbasketKey, String domain)	Returns the distribution sources for a given Workbasket.
List<WorkbasketSummary>	getDistributionTargets(String workbasketId)	Returns the distribution targets for a given Workbasket.
List<WorkbasketSummary>	getDistributionTargets(String workbasketKey, String domain)	Returns the distribution targets for a given Workbasket.
List<WorkbasketPermission>	getPermissionsForWorkbasket(String workbasketId)	Returns a set with all permissions of the current user at this Workbasket. If the workbasketId is invalid, an empty List of WorkbasketPermissions is returned since there is no distinction made between the situation that the Workbasket is not found and the caller has no permissions on the Workbasket.
Workbasket	getWorkbasket(String workbasketId)	Get the Workbasket specified by the given id.
Workbasket	getWorkbasket(String workbasketKey, String domain)	Get the Workbasket specified by the given key and domain.
List<WorkbasketAccessItem>	getWorkbasketAccessItems(String workbasketId)	Get all WorkbasketAccessItems for a Workbasket.
Workbasket	newWorkbasket(String key, String domain)	Returns a new Workbasket which is not inserted.
WorkbasketAccessItem	newWorkbasketAccessItem(String workbasketId, String accessId)	Returns a new WorkbasketAccessItem which is not inserted.
void	removeDistributionTarget(String sourceWorkbasketId, String targetWorkbasketId)	Remove a distribution target from a Workbasket.
void	setDistributionTargets(String sourceWorkbasketId, List<String> targetWorkbasketIds)	Set the distribution targets for a Workbasket.
void	setWorkbasketAccessItems(String workbasketId, List<WorkbasketAccessItem> wbAccessItems)	Setting up the new WorkbasketAccessItems for a Workbasket.
Workbasket	updateWorkbasket(Workbasket workbasketToUpdate)	Update the given Workbasket.
WorkbasketAccessItem	updateWorkbasketAccessItem(WorkbasketAccessItem workbasketAccessItem)	This method updates a WorkbasketAccessItem.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkbasketServiceImpl

public WorkbasketServiceImpl(InternalTaskanaEngine taskanaEngine,
                             HistoryEventManager historyEventManager,
                             WorkbasketMapper workbasketMapper,
                             DistributionTargetMapper distributionTargetMapper,
                             WorkbasketAccessMapper workbasketAccessMapper)

Method Detail

getWorkbasket

public Workbasket getWorkbasket(String workbasketId)
                         throws WorkbasketNotFoundException,
                                NotAuthorizedOnWorkbasketException

Description copied from interface: WorkbasketService

Get the Workbasket specified by the given id.

Specified by:

getWorkbasket in interface WorkbasketService

Parameters:

workbasketId - the id of the Workbasket requested

Returns:

the requested Workbasket

Throws:

WorkbasketNotFoundException - If the Workbasket with workbasketId is not found

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the requested Workbasket

getWorkbasket

public Workbasket getWorkbasket(String workbasketKey,
                                String domain)
                         throws WorkbasketNotFoundException,
                                NotAuthorizedOnWorkbasketException

Description copied from interface: WorkbasketService

Get the Workbasket specified by the given key and domain.

Specified by:

getWorkbasket in interface WorkbasketService

Parameters:

workbasketKey - the key of the Workbasket requested

domain - the domain of the Workbasket

Returns:

the requested Workbasket

Throws:

WorkbasketNotFoundException - If the Workbasket with workbasketId is not found

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the requested Workbasket

createWorkbasket

public Workbasket createWorkbasket(Workbasket newWorkbasket)
                            throws InvalidArgumentException,
                                   WorkbasketAlreadyExistException,
                                   DomainNotFoundException,
                                   NotAuthorizedException

Description copied from interface: WorkbasketService

Creates a new Workbasket.
The default values are:

• id - generated by IdGenerator

Specified by:

createWorkbasket in interface WorkbasketService

Parameters:

newWorkbasket - The Workbasket to create

Returns:

the created and inserted Workbasket

Throws:

InvalidArgumentException - If a required property of the Workbasket is not set.

WorkbasketAlreadyExistException - if the Workbasket exists already

DomainNotFoundException - if the domain does not exist in the configuration.

NotAuthorizedException - if the current user is not member of role admin or business-admin

updateWorkbasket

public Workbasket updateWorkbasket(Workbasket workbasketToUpdate)
                            throws InvalidArgumentException,
                                   WorkbasketNotFoundException,
                                   ConcurrencyException,
                                   NotAuthorizedException,
                                   NotAuthorizedOnWorkbasketException

Description copied from interface: WorkbasketService

Update the given Workbasket.

Specified by:

updateWorkbasket in interface WorkbasketService

Parameters:

workbasketToUpdate - The Workbasket to update

Returns:

the updated Workbasket

Throws:

InvalidArgumentException - if name or type of the Workbasket is invalid

WorkbasketNotFoundException - if the Workbasket cannot be found.

ConcurrencyException - if an attempt is made to update the Workbasket and another user updated it already; that's the case if the given modified timestamp differs from the one in the database

NotAuthorizedException - if the current user is not member of TaskanaRole.BUSINESS_ADMIN or TaskanaRole.ADMIN

NotAuthorizedOnWorkbasketException - This is never thrown

newWorkbasketAccessItem

public WorkbasketAccessItem newWorkbasketAccessItem(String workbasketId,
                                                    String accessId)

Description copied from interface: WorkbasketService

Returns a new WorkbasketAccessItem which is not inserted.

Specified by:

newWorkbasketAccessItem in interface WorkbasketService

Parameters:

workbasketId - the id used to identify the referenced Workbasket

accessId - the group id or user id for which access is controlled

Returns:

new WorkbasketAccessItem

createWorkbasketAccessItem

public WorkbasketAccessItem createWorkbasketAccessItem(WorkbasketAccessItem workbasketAccessItem)
                                                throws InvalidArgumentException,
                                                       WorkbasketNotFoundException,
                                                       WorkbasketAccessItemAlreadyExistException,
                                                       NotAuthorizedException

Description copied from interface: WorkbasketService

Create and insert a new WorkbasketAccessItem with a workbasketId, an accessId and permissions.

Specified by:

createWorkbasketAccessItem in interface WorkbasketService

Parameters:

workbasketAccessItem - the new WorkbasketAccessItem

Returns:

the created WorkbasketAccessItem

Throws:

InvalidArgumentException - if the preconditions don't match the required ones.

WorkbasketNotFoundException - if the WorkbasketAccessItem refers to a not existing workbasket

WorkbasketAccessItemAlreadyExistException - if there exists already a WorkbasketAccessItem for the same accessId and Workbasket

NotAuthorizedException - if the current user is not member of role admin or business-admin

updateWorkbasketAccessItem

public WorkbasketAccessItem updateWorkbasketAccessItem(WorkbasketAccessItem workbasketAccessItem)
                                                throws InvalidArgumentException,
                                                       NotAuthorizedException

Description copied from interface: WorkbasketService

This method updates a WorkbasketAccessItem.

Specified by:

updateWorkbasketAccessItem in interface WorkbasketService

Parameters:

workbasketAccessItem - the WorkbasketAccessItem

Returns:

the updated entity

Throws:

InvalidArgumentException - if accessId or workbasketId is changed in the WorkbasketAccessItem

NotAuthorizedException - if the current user is not member of role admin or business-admin

deleteWorkbasketAccessItem

public void deleteWorkbasketAccessItem(String accessItemId)
                                throws NotAuthorizedException

Description copied from interface: WorkbasketService

Deletes a specific WorkbasketAccessItem.

Specified by:

deleteWorkbasketAccessItem in interface WorkbasketService

Parameters:

accessItemId - the id of the WorkbasketAccessItem to be deleted

Throws:

NotAuthorizedException - if the current user is not member of role admin or business-admin

checkAuthorization

public void checkAuthorization(String workbasketId,
                               WorkbasketPermission... requestedPermissions)
                        throws WorkbasketNotFoundException,
                               NotAuthorizedOnWorkbasketException

Description copied from interface: WorkbasketService

This method checks the authorization for the actual User.

Specified by:

checkAuthorization in interface WorkbasketService

Parameters:

workbasketId - the id of the Workbasket we want to access

requestedPermissions - the needed WorkbasketPermission; if more than one permission is specified, the current user needs all of them

Throws:

WorkbasketNotFoundException - if the Workbasket cannot be found for the given id.

NotAuthorizedOnWorkbasketException - if the current user has not the requested authorization for the specified Workbasket

checkAuthorization

public void checkAuthorization(String workbasketKey,
                               String domain,
                               WorkbasketPermission... requestedPermissions)
                        throws WorkbasketNotFoundException,
                               NotAuthorizedOnWorkbasketException

Description copied from interface: WorkbasketService

This method checks the authorization for the actual User.

Specified by:

checkAuthorization in interface WorkbasketService

Parameters:

workbasketKey - the key of the Workbasket we want to access

domain - the domain of the Workbasket we want to access

requestedPermissions - the needed WorkbasketPermission; if more than one permission is specified, the current user needs all of them.

Throws:

WorkbasketNotFoundException - if no Workbasket can be found for the given key and domain values.

NotAuthorizedOnWorkbasketException - if the current user has not the requested permission for the specified Workbasket

getWorkbasketAccessItems

public List<WorkbasketAccessItem> getWorkbasketAccessItems(String workbasketId)
                                                    throws NotAuthorizedException

Description copied from interface: WorkbasketService

Get all WorkbasketAccessItems for a Workbasket.

Specified by:

getWorkbasketAccessItems in interface WorkbasketService

Parameters:

workbasketId - the id of the Workbasket

Returns:

List of WorkbasketAccessItems for the Workbasket

Throws:

NotAuthorizedException - if the current user is not member of role TaskanaRole.BUSINESS_ADMIN or TaskanaRole.ADMIN

setWorkbasketAccessItems

public void setWorkbasketAccessItems(String workbasketId,
                                     List<WorkbasketAccessItem> wbAccessItems)
                              throws WorkbasketAccessItemAlreadyExistException,
                                     InvalidArgumentException,
                                     WorkbasketNotFoundException,
                                     NotAuthorizedException,
                                     NotAuthorizedOnWorkbasketException

Description copied from interface: WorkbasketService

Setting up the new WorkbasketAccessItems for a Workbasket. Already stored values will be completely replaced by the current ones.

Preconditions for each WorkbasketAccessItem then wbAccessItems:

• WorkbasketAccessItem.getWorkbasketId() is not null
• WorkbasketAccessItem.getWorkbasketId() is equal to workbasketId
• WorkbasketAccessItem.getAccessId() is unique

Specified by:

setWorkbasketAccessItems in interface WorkbasketService

Parameters:

workbasketId - id of the access-target Workbasket.

wbAccessItems - List of WorkbasketAccessItems which does replace all current stored ones.

Throws:

WorkbasketAccessItemAlreadyExistException - if wbAccessItems contains multiple WorkbasketAccessItem with the same accessId.

InvalidArgumentException - will be thrown when the parameter wbAccessItems is NULL or member doesn't match the preconditions

WorkbasketNotFoundException - if the Workbasket cannot be found for the given id.

NotAuthorizedException - if the current user is not member of TaskanaRole.BUSINESS_ADMIN or TaskanaRole.ADMIN

NotAuthorizedOnWorkbasketException - This is never thrown

createWorkbasketQuery

public WorkbasketQuery createWorkbasketQuery()

Description copied from interface: WorkbasketService

This method provides a query builder for querying the database.

Specified by:

createWorkbasketQuery in interface WorkbasketService

Returns:

a WorkbasketQuery

createWorkbasketAccessItemQuery

public WorkbasketAccessItemQuery createWorkbasketAccessItemQuery()
                                                          throws NotAuthorizedException

Description copied from interface: WorkbasketService

This method provides a query builder for querying the database.

Specified by:

createWorkbasketAccessItemQuery in interface WorkbasketService

Returns:

a WorkbasketAccessItemQuery

Throws:

NotAuthorizedException - if the current user is not member of role admin or business-admin

newWorkbasket

public Workbasket newWorkbasket(String key,
                                String domain)

Description copied from interface: WorkbasketService

Returns a new Workbasket which is not inserted.

Specified by:

newWorkbasket in interface WorkbasketService

Parameters:

key - the key used to identify the Workbasket

domain - the domain of the new Workbasket

Returns:

new Workbasket

getPermissionsForWorkbasket

public List<WorkbasketPermission> getPermissionsForWorkbasket(String workbasketId)

Description copied from interface: WorkbasketService

Returns a set with all permissions of the current user at this Workbasket.
If the workbasketId is invalid, an empty List of WorkbasketPermissions is returned since there is no distinction made between the situation that the Workbasket is not found and the caller has no permissions on the Workbasket.

Specified by:

getPermissionsForWorkbasket in interface WorkbasketService

Parameters:

workbasketId - the id of the referenced Workbasket

Returns:

a List with all WorkbasketPermissions of the caller on the requested Workbasket.

getDistributionTargets

public List<WorkbasketSummary> getDistributionTargets(String workbasketId)
                                               throws WorkbasketNotFoundException,
                                                      NotAuthorizedOnWorkbasketException

Description copied from interface: WorkbasketService

Returns the distribution targets for a given Workbasket.

Specified by:

getDistributionTargets in interface WorkbasketService

Parameters:

workbasketId - the id of the referenced Workbasket

Returns:

the distribution targets of the specified Workbasket

Throws:

WorkbasketNotFoundException - if the Workbasket doesn't exist

NotAuthorizedOnWorkbasketException - if the current user has no READ permission for the specified Workbasket

getDistributionTargets

public List<WorkbasketSummary> getDistributionTargets(String workbasketKey,
                                                      String domain)
                                               throws WorkbasketNotFoundException,
                                                      NotAuthorizedOnWorkbasketException

Description copied from interface: WorkbasketService

Returns the distribution targets for a given Workbasket.

Specified by:

getDistributionTargets in interface WorkbasketService

Parameters:

workbasketKey - the key of the referenced Workbasket

domain - the domain of the referenced Workbasket

Returns:

the distribution targets of the specified Workbasket

Throws:

WorkbasketNotFoundException - if the Workbasket doesn't exist

NotAuthorizedOnWorkbasketException - if the current user has no READ permission for the specified Workbasket

setDistributionTargets

public void setDistributionTargets(String sourceWorkbasketId,
                                   List<String> targetWorkbasketIds)
                            throws WorkbasketNotFoundException,
                                   NotAuthorizedException,
                                   NotAuthorizedOnWorkbasketException

Description copied from interface: WorkbasketService

Set the distribution targets for a Workbasket.

Specified by:

setDistributionTargets in interface WorkbasketService

Parameters:

sourceWorkbasketId - the id of the source Workbasket for which the distribution targets are to be set

targetWorkbasketIds - a list of the ids of the target Workbaskets

Throws:

WorkbasketNotFoundException - if either the source Workbasket or any of the target Workbaskets don't exist

NotAuthorizedException - if the current user is not member of TaskanaRole.BUSINESS_ADMIN or TaskanaRole.ADMIN

NotAuthorizedOnWorkbasketException - This is never thrown

addDistributionTarget

public void addDistributionTarget(String sourceWorkbasketId,
                                  String targetWorkbasketId)
                           throws WorkbasketNotFoundException,
                                  NotAuthorizedException,
                                  NotAuthorizedOnWorkbasketException

Description copied from interface: WorkbasketService

Add a distribution target to a Workbasket. If the specified distribution target exists already, the method silently returns without doing anything.

Specified by:

addDistributionTarget in interface WorkbasketService

Parameters:

sourceWorkbasketId - the id of the source Workbasket

targetWorkbasketId - the id of the target Workbasket

Throws:

WorkbasketNotFoundException - if either the source Workbasket or the target Workbasket doesn't exist

NotAuthorizedException - if the current user is not member of TaskanaRole.BUSINESS_ADMIN or TaskanaRole.ADMIN

NotAuthorizedOnWorkbasketException - if the current user doesn't have READ permission for the source Workbaskets

removeDistributionTarget

public void removeDistributionTarget(String sourceWorkbasketId,
                                     String targetWorkbasketId)
                              throws NotAuthorizedException,
                                     NotAuthorizedOnWorkbasketException

Description copied from interface: WorkbasketService

Remove a distribution target from a Workbasket. If the specified distribution target doesn't exist, the method silently returns without doing anything.

Specified by:

removeDistributionTarget in interface WorkbasketService

Parameters:

sourceWorkbasketId - The id of the source Workbasket

targetWorkbasketId - The id of the target Workbasket

Throws:

NotAuthorizedException - if the current user is not member of TaskanaRole.BUSINESS_ADMIN or TaskanaRole.ADMIN

NotAuthorizedOnWorkbasketException - If the current user doesn't have READ permission for the source Workbasket

deleteWorkbasket

public boolean deleteWorkbasket(String workbasketId)
                         throws WorkbasketNotFoundException,
                                WorkbasketInUseException,
                                InvalidArgumentException,
                                NotAuthorizedException,
                                NotAuthorizedOnWorkbasketException

Description copied from interface: WorkbasketService

Deletes the Workbasket by the given id.

Specified by:

deleteWorkbasket in interface WorkbasketService

Parameters:

workbasketId - id of the Workbasket which should be deleted.

Returns:

true if the Workbasket was deleted successfully; false if the Workbasket is marked for deletion

Throws:

WorkbasketNotFoundException - if the Workbasket does not exist

WorkbasketInUseException - if the Workbasket does contain task-content

InvalidArgumentException - if the workbasketId is NULL or EMPTY

NotAuthorizedException - if the current user is not member of TaskanaRole.BUSINESS_ADMIN or TaskanaRole.ADMIN

NotAuthorizedOnWorkbasketException - This is never thrown

deleteWorkbaskets

public BulkOperationResults<String,TaskanaException> deleteWorkbaskets(List<String> workbasketsIds)
                                                                      throws InvalidArgumentException,
                                                                             NotAuthorizedException

Description copied from interface: WorkbasketService

Deletes the list of Workbaskets specified via ids.

Specified by:

deleteWorkbaskets in interface WorkbasketService

Parameters:

workbasketsIds - the ids of the Workbaskets to delete.

Returns:

the result of the operations and an Exception for each failed workbasket deletion

Throws:

InvalidArgumentException - if the WorkbasketIds parameter List is NULL or empty

NotAuthorizedException - if the current user is not member of TaskanaRole.BUSINESS_ADMIN or TaskanaRole.ADMIN

getDistributionSources

public List<WorkbasketSummary> getDistributionSources(String workbasketId)
                                               throws WorkbasketNotFoundException,
                                                      NotAuthorizedOnWorkbasketException

Description copied from interface: WorkbasketService

Returns the distribution sources for a given Workbasket.

Specified by:

getDistributionSources in interface WorkbasketService

Parameters:

workbasketId - the id of the referenced Workbasket

Returns:

the workbaskets that are distribution sources of the specified Workbasket.

Throws:

WorkbasketNotFoundException - if the Workbasket doesn't exist

NotAuthorizedOnWorkbasketException - if the current user has no READ permission for the specified Workbasket

getDistributionSources

public List<WorkbasketSummary> getDistributionSources(String workbasketKey,
                                                      String domain)
                                               throws WorkbasketNotFoundException,
                                                      NotAuthorizedOnWorkbasketException

Description copied from interface: WorkbasketService

Returns the distribution sources for a given Workbasket.

Specified by:

getDistributionSources in interface WorkbasketService

Parameters:

workbasketKey - the key of the referenced Workbasket

domain - the domain of the referenced Workbasket

Returns:

the workbaskets that are distribution sources of the specified Workbasket.

Throws:

WorkbasketNotFoundException - if the Workbasket doesn't exist

NotAuthorizedOnWorkbasketException - if the current user has no READ permission for the specified Workbasket

deleteWorkbasketAccessItemsForAccessId

public void deleteWorkbasketAccessItemsForAccessId(String accessId)
                                            throws NotAuthorizedException

Description copied from interface: WorkbasketService

Deletes all WorkbasketAccessItems using the given WorkbasketAccessItem.getAccessId().

Specified by:

deleteWorkbasketAccessItemsForAccessId in interface WorkbasketService

Parameters:

accessId - id of a taskana-User.

Throws:

NotAuthorizedException - if the current user is not member of role admin or business-admin

checkModifiedHasNotChanged

public void checkModifiedHasNotChanged(Workbasket oldWorkbasket,
                                       WorkbasketImpl workbasketImplToUpdate)
                                throws ConcurrencyException

Check if current workbasket is based on the newest (by modified).

Parameters:

oldWorkbasket - the old workbasket in the system

workbasketImplToUpdate - the workbasket to update

Throws:

ConcurrencyException - if the workbasket has been modified by some other process; that's the case if the given modified timestamp differs from the one in the database