org.kuali.rice.kew.framework.document.security

Interface DocumentTypeAuthorizer

public interface DocumentTypeAuthorizer

Framework interface used by DocumentTypePermisionServiceAuthorizerImpl to allow applications to customize document routing permission checks. isActionAuthorized(AuthorizableAction, String, org.kuali.rice.kew.api.doctype.DocumentType, org.kuali.rice.kew.api.document.Document, java.util.Map) is invoked for applicable actions to check authorization. Additional action-specific parameters are enumerated by DocumentTypeAuthorizer.ActionArgument enum and passed in the actionParameters argument

Since:

2.1.3

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DocumentTypeAuthorizer.ActionArgument Type of additional arguments for isActionAuthorized(AuthorizableAction, String, org.kuali.rice.kew.api.doctype.DocumentType, org.kuali.rice.kew.api.document.Document, java.util.Map)

Method Summary

Modifier and Type	Method and Description
Authorization	isActionAuthorized(AuthorizableAction action, String principalId, DocumentType documentType, Document document, Map<DocumentTypeAuthorizer.ActionArgument,Object> actionParameters) Check whether specified action is authorized.

Method Detail

isActionAuthorized

Authorization isActionAuthorized(AuthorizableAction action,
                                 String principalId,
                                 DocumentType documentType,
                                 Document document,
                                 Map<DocumentTypeAuthorizer.ActionArgument,Object> actionParameters)

Check whether specified action is authorized.

Parameters:

action - the AuthorizableAction type, either a document action, initiation, or su approve action request check

principalId - the principal id associated with the action

documentType - the document type

document - the document, if available/applicable (may be null)

actionParameters - additional actionParameters if applicable to the AuthorizableAction check

Returns:

Authorization object specifying whether the action was authorized