pro.taskana.impl

Class WorkbasketServiceImpl

java.lang.Object

pro.taskana.impl.WorkbasketServiceImpl

All Implemented Interfaces:

WorkbasketService

public class WorkbasketServiceImpl
extends Object
implements WorkbasketService

This is the implementation of WorkbasketService.

Method Summary

Modifier and Type	Method and 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.
Workbasket	createWorkbasket(Workbasket newWorkbasket) Create a new Workbasket.
WorkbasketAccessItem	createWorkbasketAccessItem(WorkbasketAccessItem workbasketAccessItem) Create and persist 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 of it.
void	deleteWorkbasketAccessItem(String accessItemId) Deletes a specific WorkbasketAccessItem.
void	deleteWorkbasketAccessItemsForAccessId(String accessId) Deletes all WorkbasketAccessItems using the given AccessId of a user.
BulkOperationResults<String,TaskanaException>	deleteWorkbaskets(List<String> workbasketsIds) Deletes a list of workbaskets.
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 permissions 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 Workbasket for a given id.
Workbasket	getWorkbasket(String workbasketKey, String domain) Get Workbasket for a given key.
List<WorkbasketAccessItem>	getWorkbasketAccessItems(String workbasketId) Get all s for a Workbasket.
Workbasket	newWorkbasket(String key, String domain) Returns a new workbasket which is not persisted.
WorkbasketAccessItem	newWorkbasketAccessItem(String workbasketId, String accessId) Returns a new WorkbasketAccessItem which is not persisted.
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 a 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

Method Detail

getWorkbasket

public Workbasket getWorkbasket(String workbasketId)
                         throws WorkbasketNotFoundException,
                                NotAuthorizedException

Description copied from interface: WorkbasketService

Get Workbasket for a 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

NotAuthorizedException - If the current user or group does not have the permissions for interactions.

getWorkbasket

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

Description copied from interface: WorkbasketService

Get Workbasket for a given key.

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

NotAuthorizedException - If the current user or group does not have the permissions for interactions.

createWorkbasket

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

Description copied from interface: WorkbasketService

Create a new Workbasket.

Specified by:

createWorkbasket in interface WorkbasketService

Parameters:

newWorkbasket - The Workbasket to create

Returns:

the created and persisted Workbasket

Throws:

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

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

WorkbasketAlreadyExistException - if the workbasket exists already

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

updateWorkbasket

public Workbasket updateWorkbasket(Workbasket workbasketToUpdate)
                            throws NotAuthorizedException

Description copied from interface: WorkbasketService

Update a Workbasket.

Specified by:

updateWorkbasket in interface WorkbasketService

Parameters:

workbasketToUpdate - The Workbasket to update

Returns:

the updated Workbasket

Throws:

NotAuthorizedException - if the current user is not authorized to update the work basket

newWorkbasketAccessItem

public WorkbasketAccessItem newWorkbasketAccessItem(String workbasketId,
                                                    String accessId)

Description copied from interface: WorkbasketService

Returns a new WorkbasketAccessItem which is not persisted.

Specified by:

newWorkbasketAccessItem in interface WorkbasketService

Parameters:

workbasketId - the workbasket 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,
                                                       NotAuthorizedException,
                                                       WorkbasketNotFoundException

Description copied from interface: WorkbasketService

Create and persist 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 - when the preconditions dont match the required ones.

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

WorkbasketNotFoundException - if the workbasketAccessItem refers to a not existing workbasket

setWorkbasketAccessItems

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

Description copied from interface: WorkbasketService

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

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:

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

NotAuthorizedException - if the current user is not member of role BUSINESS_ADMIN or 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 WorbasketAccessItem to be deleted

Throws:

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

deleteWorkbasketAccessItemsForAccessId

public void deleteWorkbasketAccessItemsForAccessId(String accessId)
                                            throws NotAuthorizedException

Description copied from interface: WorkbasketService

Deletes all WorkbasketAccessItems using the given AccessId of a user.

Specified by:

deleteWorkbasketAccessItemsForAccessId in interface WorkbasketService

Parameters:

accessId - of a taskana-user.

Throws:

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

checkAuthorization

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

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:

NotAuthorizedException - if the current user has not the requested authorization for the specified workbasket

WorkbasketNotFoundException - if the workbasket cannot be found for the given ID.

checkAuthorization

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

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:

NotAuthorizedException - if the current user has not the requested permission for the specified workbasket

WorkbasketNotFoundException - if no workbasket can be found for the given key+domain values.

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 BUSINESS_ADMIN or ADMIN

getWorkbasketAccessItems

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

Description copied from interface: WorkbasketService

Get all s for a Workbasket.

Specified by:

getWorkbasketAccessItems in interface WorkbasketService

Parameters:

workbasketId - the id of the Workbasket

Returns:

List of WorkbasketAccessItems for the Workbasket with workbasketKey

Throws:

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

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 permissions 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.

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

newWorkbasket

public Workbasket newWorkbasket(String key,
                                String domain)

Description copied from interface: WorkbasketService

Returns a new workbasket which is not persisted.

Specified by:

newWorkbasket in interface WorkbasketService

Parameters:

key - the workbasket key used to identify the workbasket

domain - the domain of the new workbasket

Returns:

new Workbasket

getDistributionTargets

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

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:

NotAuthorizedException - if the current user has no read permission for the specified workbasket

WorkbasketNotFoundException - if the workbasket doesn't exist

getDistributionTargets

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

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:

NotAuthorizedException - if the current user has no read permission for the specified workbasket

WorkbasketNotFoundException - if the workbasket doesn't exist

getDistributionSources

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

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:

NotAuthorizedException - if the current user has no read permission for the specified workbasket

WorkbasketNotFoundException - if the workbasket doesn't exist

getDistributionSources

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

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:

NotAuthorizedException - if the current user has no read permission for the specified workbasket

WorkbasketNotFoundException - if the workbasket doesn't exist

setDistributionTargets

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

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 used doesn't have READ permission for the source workbasket

addDistributionTarget

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

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:

NotAuthorizedException - if the current user doesn't have READ permission for the source workbasket

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

removeDistributionTarget

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

Description copied from interface: WorkbasketService

Remove a distribution target from a workbasket. If the 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 doesn't have READ permission for the source workbasket

deleteWorkbasket

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

Description copied from interface: WorkbasketService

Deletes the workbasket by the given ID of it.

Specified by:

deleteWorkbasket in interface WorkbasketService

Parameters:

workbasketId - Id of the workbasket which should be deleted.

Returns:

true if the workbasket is marked for deletion. False in another case.

Throws:

NotAuthorizedException - if the current user got no permissions for this interaction.

WorkbasketNotFoundException - if the workbasket does not exist.

WorkbasketInUseException - if the workbasket does contain task-content.

InvalidArgumentException - if the workbasketId is NULL or EMPTY

deleteWorkbaskets

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

Description copied from interface: WorkbasketService

Deletes a list of workbaskets.

Specified by:

deleteWorkbaskets in interface WorkbasketService

Parameters:

workbasketsIds - the ids of the workbaskets to delete.

Returns:

the result of the operations with Id and Exception for each failed workbasket deletion.

Throws:

InvalidArgumentException - if the WorkbasketId parameter is NULL

NotAuthorizedException

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 BUSINESS_ADMIN or ADMIN