Package org.kuali.rice.kew.doctype.service.impl

Class DocumentActionsPermissionBase

java.lang.Object

org.kuali.rice.kew.doctype.service.impl.DocumentActionsPermissionBase

Direct Known Subclasses:

DocumentTypePermissionServiceImpl, KimDocumentTypeAuthorizer

public class DocumentActionsPermissionBase
extends Object

Base class which implements default KIM permission checks for various workflow document actions. This implementation can be used as a base class for a DocumentTypePermissionService or DocumentTypeAuthorizer implementation

Since:

2.1.3

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

• DocumentTypePermissionService
• DocumentTypePermissionServiceImpl
• DocumentTypeAuthorizer
• KimDocumentTypeAuthorizer

Constructor Summary

Constructors

Constructor	Description
DocumentActionsPermissionBase()

Method Summary

Modifier and Type	Method	Description
protected Map<String,String>	buildDocumentRoleQualifiers(DocumentRouteHeaderValue document, String routeNodeName)	Generates role qualifiers for authorization check.
protected Map<String,String>	buildDocumentTypePermissionDetails(DocumentType documentType, String documentStatus, String actionRequestCode, String routeNodeName)	Generates permission details map for KIM permission checks.
protected List<Map<String,String>>	buildDocumentTypePermissionDetailsForNodes(DocumentType documentType, Collection<String> routeNodeNames, String documentStatus, String actionRequestCode)	This method generates the permission details for the given document with current active route nodes.
boolean	canBlanketApprove(String principalId, DocumentRouteHeaderValue document)	Implements DocumentTypePermissionService.canBlanketApprove(String, org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue)
boolean	canCancel(String principalId, DocumentRouteHeaderValue document)	Implements DocumentTypePermissionService.canCancel(String, org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue)
boolean	canInitiate(String principalId, DocumentType documentType)	Implements DocumentTypePermissionService.canInitiate(String, org.kuali.rice.kew.doctype.bo.DocumentType)
boolean	canRecall(String principalId, DocumentRouteHeaderValue document)	Implements DocumentTypePermissionService.canRecall(String, org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue)
boolean	canReturnToPreviousRouteNode(String principalId, DocumentRouteHeaderValue document)
boolean	canRoute(String principalId, DocumentRouteHeaderValue document)	Implements DocumentTypePermissionService.canRoute(String, org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue)
boolean	canSave(String principalId, DocumentRouteHeaderValue document)	Implements DocumentTypePermissionService.canSave(String, org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue)
protected boolean	canSuperUserApproveDocument(String principalId, DocumentType documentType, Collection<String> routeNodeNames, String routeStatusCode)	Implements DocumentTypePermissionService.canSuperUserApproveDocument(String, org.kuali.rice.kew.doctype.bo.DocumentType, java.util.List, String)
protected boolean	canSuperUserApproveSingleActionRequest(String principalId, DocumentType documentType, Collection<String> routeNodeNames, String routeStatusCode)	Provides base implementaiton for DocumentTypePermissionService.canSuperUserApproveSingleActionRequest(String, org.kuali.rice.kew.doctype.bo.DocumentType, java.util.List, String)
protected boolean	canSuperUserDisapproveDocument(String principalId, DocumentType documentType, Collection<String> routeNodeNames, String routeStatusCode)	Implements DocumentTypePermissionService.canSuperUserDisapproveDocument(String, org.kuali.rice.kew.doctype.bo.DocumentType, java.util.List, String)
protected org.kuali.rice.kim.api.permission.PermissionService	getPermissionService()
protected boolean	useKimPermission(String namespace, String permissionTemplateName, Map<String,String> permissionDetails, boolean checkKimPriorityInd)	Returns whether to invoke KIM to perform permission checks.
protected void	validateDocument(DocumentRouteHeaderValue document)	Validates document parameter
protected void	validateDocumentStatus(String documentStatus)	Validates documentStatus parameter
protected void	validateDocumentType(DocumentType documentType)	Validates documenttype parameter
protected void	validatePrincipalId(String principalId)	Validates principal id parameter
protected void	validateRouteNodeNames(List<String> routeNodeNames)	Validates routeNodeNames parameter

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentActionsPermissionBase

public DocumentActionsPermissionBase()

Method Details

canInitiate

public boolean canInitiate(String principalId,
 DocumentType documentType)

Implements DocumentTypePermissionService.canInitiate(String, org.kuali.rice.kew.doctype.bo.DocumentType)

canRoute

public boolean canRoute(String principalId,
 DocumentRouteHeaderValue document)

Implements DocumentTypePermissionService.canRoute(String, org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue)

canSuperUserApproveSingleActionRequest

protected boolean canSuperUserApproveSingleActionRequest(String principalId,
 DocumentType documentType,
 Collection<String> routeNodeNames,
 String routeStatusCode)

Provides base implementaiton for DocumentTypePermissionService.canSuperUserApproveSingleActionRequest(String, org.kuali.rice.kew.doctype.bo.DocumentType, java.util.List, String)

canSuperUserApproveDocument

protected boolean canSuperUserApproveDocument(String principalId,
 DocumentType documentType,
 Collection<String> routeNodeNames,
 String routeStatusCode)

Implements DocumentTypePermissionService.canSuperUserApproveDocument(String, org.kuali.rice.kew.doctype.bo.DocumentType, java.util.List, String)

canSuperUserDisapproveDocument

protected boolean canSuperUserDisapproveDocument(String principalId,
 DocumentType documentType,
 Collection<String> routeNodeNames,
 String routeStatusCode)

Implements DocumentTypePermissionService.canSuperUserDisapproveDocument(String, org.kuali.rice.kew.doctype.bo.DocumentType, java.util.List, String)

canCancel

public boolean canCancel(String principalId,
 DocumentRouteHeaderValue document)

Implements DocumentTypePermissionService.canCancel(String, org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue)

canReturnToPreviousRouteNode

public boolean canReturnToPreviousRouteNode(String principalId,
 DocumentRouteHeaderValue document)

canRecall

public boolean canRecall(String principalId,
 DocumentRouteHeaderValue document)

Implements DocumentTypePermissionService.canRecall(String, org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue)

canBlanketApprove

public boolean canBlanketApprove(String principalId,
 DocumentRouteHeaderValue document)

Implements DocumentTypePermissionService.canBlanketApprove(String, org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue)

canSave

public boolean canSave(String principalId,
 DocumentRouteHeaderValue document)

Implements DocumentTypePermissionService.canSave(String, org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue)

buildDocumentTypePermissionDetails

protected Map<String,String> buildDocumentTypePermissionDetails(DocumentType documentType,
 String documentStatus,
 String actionRequestCode,
 String routeNodeName)

Generates permission details map for KIM permission checks. Details are derived from document type, status, action request code (if non-null) and routeNode name (if non-null). If the document status is not a routed state, "PreRoute" is used. Note that this has to match the required data defined in krim_typ_attr_t for the krim_typ_t with srvc_nm='documentTypeAndNodeOrStatePermissionTypeService'. TODO: See KULRICE-3490, make assembly of permission details dynamic based on db config

Parameters:

documentType - the KEW DocumentType

documentStatus - the document status

actionRequestCode - action request code if applicable

routeNodeName - routeNode name if applicable

Returns:

map of permission details for permission check

buildDocumentTypePermissionDetailsForNodes

protected List<Map<String,String>> buildDocumentTypePermissionDetailsForNodes(DocumentType documentType,
 Collection<String> routeNodeNames,
 String documentStatus,
 String actionRequestCode)

This method generates the permission details for the given document with current active route nodes. This method simply invokes buildDocumentTypePermissionDetails(org.kuali.rice.kew.doctype.bo.DocumentType, String, String, String) for each node (or once if no node names are provided).

Parameters:

documentType - the DocumentType

routeNodeNames - active route nodes for which to generate permission details

documentStatus - document status

actionRequestCode - action request code if applicable

Returns:

list of permission details maps, one for each route node inspected

buildDocumentRoleQualifiers

protected Map<String,String> buildDocumentRoleQualifiers(DocumentRouteHeaderValue document,
 String routeNodeName)

Generates role qualifiers for authorization check. If the document status is a non-routed status, "PreRoute" is used. The namespaceCode attribute is derived from the KRAD DataDictionary if there is a mapping for the document type.

Parameters:

document - the document instance

routeNodeName - name of the applicable routenode

Returns:

map of role qualifiers

useKimPermission

protected boolean useKimPermission(String namespace,
 String permissionTemplateName,
 Map<String,String> permissionDetails,
 boolean checkKimPriorityInd)

Returns whether to invoke KIM to perform permission checks. First consults the KewApiConstants.KIM_PRIORITY_ON_DOC_TYP_PERMS_IND system parameter to determine whether we should check for permission existence. If this parameter is unset or is true, we proceed to invoke PermissionService.isPermissionDefinedByTemplate(String, String, java.util.Map) to determine whether the given permission is defined anywhere in the system.

Parameters:

namespace - namespace of permission we are querying

permissionTemplateName - template name of permissions we are querying

permissionDetails - details of permissions we are querying

checkKimPriorityInd - whether to consult the KewApiConstants.KIM_PRIORITY_ON_DOC_TYP_PERMS_IND parameter to determine whether the check for permission definition

Returns:

whether there are any permissions defined for the given permission template, or false if we are checking the kim priority indicator and the

invalid @link

{@link KewApiConstants@KIM_PRIORITY_ON_DOC_TYP_PERMS_IND

} system parameter is disabled.

validatePrincipalId

protected void validatePrincipalId(String principalId)

Validates principal id parameter

Parameters:

principalId - the principal id

validateDocument

protected void validateDocument(DocumentRouteHeaderValue document)

Validates document parameter

Parameters:

document - the document

validateDocumentType

protected void validateDocumentType(DocumentType documentType)

Validates documenttype parameter

Parameters:

documentType - the document type

validateRouteNodeNames

protected void validateRouteNodeNames(List<String> routeNodeNames)

Validates routeNodeNames parameter

Parameters:

routeNodeNames - the routeNode names

validateDocumentStatus

protected void validateDocumentStatus(String documentStatus)

Validates documentStatus parameter

Parameters:

documentStatus - the document status

getPermissionService

protected org.kuali.rice.kim.api.permission.PermissionService getPermissionService()