1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16 package org.kuali.rice.kew.messaging.exceptionhandling;
17
18 import java.lang.reflect.InvocationTargetException;
19 import java.util.ArrayList;
20 import java.util.Collections;
21 import java.util.List;
22
23 import org.apache.log4j.MDC;
24 import org.kuali.rice.core.api.exception.RiceRuntimeException;
25 import org.kuali.rice.kew.actionitem.ActionItem;
26 import org.kuali.rice.kew.actionrequest.ActionRequestFactory;
27 import org.kuali.rice.kew.actionrequest.ActionRequestValue;
28 import org.kuali.rice.kew.actionrequest.KimGroupRecipient;
29 import org.kuali.rice.kew.api.WorkflowRuntimeException;
30 import org.kuali.rice.kew.api.action.ActionRequestStatus;
31 import org.kuali.rice.kew.api.exception.InvalidActionTakenException;
32 import org.kuali.rice.kew.engine.RouteContext;
33 import org.kuali.rice.kew.engine.node.RouteNodeInstance;
34 import org.kuali.rice.kew.exception.RouteManagerException;
35 import org.kuali.rice.kew.exception.WorkflowDocumentExceptionRoutingService;
36 import org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange;
37 import org.kuali.rice.kew.framework.postprocessor.PostProcessor;
38 import org.kuali.rice.kew.framework.postprocessor.ProcessDocReport;
39 import org.kuali.rice.kew.role.RoleRouteModule;
40 import org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue;
41 import org.kuali.rice.kew.service.KEWServiceLocator;
42 import org.kuali.rice.kew.api.KewApiConstants;
43 import org.kuali.rice.kew.util.PerformanceLogger;
44 import org.kuali.rice.krad.util.KRADConstants;
45 import org.kuali.rice.ksb.messaging.PersistedMessageBO;
46 import org.kuali.rice.ksb.service.KSBServiceLocator;
47
48
49 public class ExceptionRoutingServiceImpl implements WorkflowDocumentExceptionRoutingService {
50
51 private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(ExceptionRoutingServiceImpl.class);
52
53 public void placeInExceptionRouting(String errorMessage, PersistedMessageBO persistedMessage, String documentId) throws Exception {
54 RouteNodeInstance nodeInstance = null;
55 KEWServiceLocator.getRouteHeaderService().lockRouteHeader(documentId, true);
56 DocumentRouteHeaderValue document = KEWServiceLocator.getRouteHeaderService().getRouteHeader(documentId);
57 RouteContext routeContext = establishRouteContext(document, null);
58 List<RouteNodeInstance> activeNodeInstances = KEWServiceLocator.getRouteNodeService().getActiveNodeInstances(documentId);
59 if (!activeNodeInstances.isEmpty()) {
60
61 nodeInstance = activeNodeInstances.get(0);
62 }
63 placeInExceptionRouting(errorMessage, nodeInstance, persistedMessage, routeContext, document, true);
64 }
65
66 public void placeInExceptionRouting(Throwable throwable, PersistedMessageBO persistedMessage, String documentId) throws Exception {
67 placeInExceptionRouting(throwable, persistedMessage, documentId, true);
68 }
69
70
71
72
73
74 public void placeInExceptionRoutingLastDitchEffort(Throwable throwable, PersistedMessageBO persistedMessage, String documentId) throws Exception {
75 placeInExceptionRouting(throwable, persistedMessage, documentId, false);
76 }
77
78 protected void placeInExceptionRouting(Throwable throwable, PersistedMessageBO persistedMessage, String documentId, boolean invokePostProcessor) throws Exception {
79 KEWServiceLocator.getRouteHeaderService().lockRouteHeader(documentId, true);
80 DocumentRouteHeaderValue document = KEWServiceLocator.getRouteHeaderService().getRouteHeader(documentId);
81 throwable = unwrapRouteManagerExceptionIfPossible(throwable);
82 RouteContext routeContext = establishRouteContext(document, throwable);
83 RouteNodeInstance nodeInstance = routeContext.getNodeInstance();
84 Throwable cause = determineActualCause(throwable, 0);
85 String errorMessage = (cause != null && cause.getMessage() != null) ? cause.getMessage() : "";
86 placeInExceptionRouting(errorMessage, nodeInstance, persistedMessage, routeContext, document, invokePostProcessor);
87 }
88
89 protected void placeInExceptionRouting(String errorMessage, RouteNodeInstance nodeInstance, PersistedMessageBO persistedMessage, RouteContext routeContext, DocumentRouteHeaderValue document, boolean invokePostProcessor) throws Exception {
90 String documentId = document.getDocumentId();
91 MDC.put("docId", documentId);
92 PerformanceLogger performanceLogger = new PerformanceLogger(documentId);
93 try {
94
95
96 List<ActionRequestValue> actionRequests = KEWServiceLocator.getActionRequestService().findPendingByDoc(documentId);
97 for (ActionRequestValue actionRequest : actionRequests) {
98 if (actionRequest.isActive()) {
99 actionRequest.setStatus(ActionRequestStatus.INITIALIZED.getCode());
100 for (ActionItem actionItem : actionRequest.getActionItems()) {
101 KEWServiceLocator.getActionListService().deleteActionItem(actionItem);
102 }
103 KEWServiceLocator.getActionRequestService().saveActionRequest(actionRequest);
104 }
105 }
106
107 LOG.debug("Generating exception request for doc : " + documentId);
108 if (errorMessage == null) {
109 errorMessage = "";
110 }
111 if (errorMessage.length() > KewApiConstants.MAX_ANNOTATION_LENGTH) {
112 errorMessage = errorMessage.substring(0, KewApiConstants.MAX_ANNOTATION_LENGTH);
113 }
114 List<ActionRequestValue> exceptionRequests = new ArrayList<ActionRequestValue>();
115 if (nodeInstance.getRouteNode().isExceptionGroupDefined()) {
116 exceptionRequests = generateExceptionGroupRequests(routeContext);
117 } else {
118 exceptionRequests = generateKimExceptionRequests(routeContext);
119 }
120 if (exceptionRequests.isEmpty()) {
121 LOG.warn("Failed to generate exception requests for exception routing!");
122 }
123 activateExceptionRequests(routeContext, exceptionRequests, errorMessage, invokePostProcessor);
124
125 if (persistedMessage == null) {
126 LOG.warn("Attempting to delete null persisted message.");
127 } else {
128 KSBServiceLocator.getMessageQueueService().delete(persistedMessage);
129 }
130 } finally {
131 performanceLogger.log("Time to generate exception request.");
132 MDC.remove("docId");
133 }
134 }
135
136 protected void notifyStatusChange(DocumentRouteHeaderValue routeHeader, String newStatusCode, String oldStatusCode) throws InvalidActionTakenException {
137 DocumentRouteStatusChange statusChangeEvent = new DocumentRouteStatusChange(routeHeader.getDocumentId(), routeHeader.getAppDocId(), oldStatusCode, newStatusCode);
138 try {
139 LOG.debug("Notifying post processor of status change "+oldStatusCode+"->"+newStatusCode);
140 PostProcessor postProcessor = routeHeader.getDocumentType().getPostProcessor();
141 ProcessDocReport report = postProcessor.doRouteStatusChange(statusChangeEvent);
142 if (!report.isSuccess()) {
143 LOG.warn(report.getMessage(), report.getProcessException());
144 throw new InvalidActionTakenException(report.getMessage());
145 }
146 } catch (Exception ex) {
147 LOG.warn(ex, ex);
148 throw new WorkflowRuntimeException(ex);
149 }
150 }
151
152 protected List<ActionRequestValue> generateExceptionGroupRequests(RouteContext routeContext) {
153 RouteNodeInstance nodeInstance = routeContext.getNodeInstance();
154 ActionRequestFactory arFactory = new ActionRequestFactory(routeContext.getDocument(), null);
155 ActionRequestValue exceptionRequest = arFactory.createActionRequest(KewApiConstants.ACTION_REQUEST_COMPLETE_REQ, new Integer(0), new KimGroupRecipient(nodeInstance.getRouteNode().getExceptionWorkgroup()), "Exception Workgroup for route node " + nodeInstance.getName(), KewApiConstants.EXCEPTION_REQUEST_RESPONSIBILITY_ID, Boolean.TRUE, "");
156 return Collections.singletonList(exceptionRequest);
157 }
158
159 protected List<ActionRequestValue> generateKimExceptionRequests(RouteContext routeContext) throws Exception {
160 RoleRouteModule roleRouteModule = new RoleRouteModule();
161 roleRouteModule.setNamespace(KRADConstants.KUALI_RICE_WORKFLOW_NAMESPACE);
162 roleRouteModule.setResponsibilityTemplateName(KewApiConstants.EXCEPTION_ROUTING_RESPONSIBILITY_TEMPLATE_NAME);
163 List<ActionRequestValue> requests = roleRouteModule.findActionRequests(routeContext);
164 processExceptionRequests(requests);
165 return requests;
166 }
167
168
169
170
171
172
173
174 protected void processExceptionRequests(List<ActionRequestValue> exceptionRequests) {
175 if (exceptionRequests != null) {
176 for (ActionRequestValue actionRequest : exceptionRequests) {
177 processExceptionRequest(actionRequest);
178 }
179 }
180 }
181
182
183
184
185
186 protected void processExceptionRequest(ActionRequestValue actionRequest) {
187 actionRequest.setForceAction(true);
188 actionRequest.setNodeInstance(null);
189 processExceptionRequests(actionRequest.getChildrenRequests());
190 }
191
192
193
194
195
196
197
198
199
200 protected void activateExceptionRequests(RouteContext routeContext, List<ActionRequestValue> exceptionRequests, String exceptionMessage, boolean invokePostProcessor) throws Exception {
201 setExceptionAnnotations(exceptionRequests, exceptionMessage);
202
203 DocumentRouteHeaderValue rh = KEWServiceLocator.getRouteHeaderService().getRouteHeader(routeContext.getDocument().getDocumentId());
204 String oldStatus = rh.getDocRouteStatus();
205 rh.setDocRouteStatus(KewApiConstants.ROUTE_HEADER_EXCEPTION_CD);
206 if (invokePostProcessor) {
207 notifyStatusChange(rh, KewApiConstants.ROUTE_HEADER_EXCEPTION_CD, oldStatus);
208 }
209 KEWServiceLocator.getRouteHeaderService().saveRouteHeader(rh);
210 KEWServiceLocator.getActionRequestService().activateRequests(exceptionRequests);
211 }
212
213
214
215
216 protected void setExceptionAnnotations(List<ActionRequestValue> actionRequests, String exceptionMessage) {
217 for (ActionRequestValue actionRequest : actionRequests) {
218 actionRequest.setAnnotation(exceptionMessage);
219 }
220 }
221
222 private Throwable unwrapRouteManagerExceptionIfPossible(Throwable throwable) {
223 if (throwable instanceof InvocationTargetException) {
224 throwable = throwable.getCause();
225 }
226 if (throwable != null && (! (throwable instanceof RouteManagerException)) && throwable.getCause() instanceof RouteManagerException) {
227 throwable = throwable.getCause();
228 }
229 return throwable;
230 }
231
232 protected Throwable determineActualCause(Throwable throwable, int depth) {
233 if (depth >= 10) {
234 return throwable;
235 }
236 if ((throwable instanceof InvocationTargetException) || (throwable instanceof RouteManagerException)) {
237 if (throwable.getCause() != null) {
238 return determineActualCause(throwable.getCause(), ++depth);
239 }
240 }
241 return throwable;
242 }
243
244 protected RouteContext establishRouteContext(DocumentRouteHeaderValue document, Throwable throwable) {
245 RouteContext routeContext = new RouteContext();
246 if (throwable instanceof RouteManagerException) {
247 RouteManagerException rmException = (RouteManagerException) throwable;
248 routeContext = rmException.getRouteContext();
249 } else {
250 routeContext.setDocument(document);
251 List<RouteNodeInstance> activeNodeInstances = KEWServiceLocator.getRouteNodeService().getActiveNodeInstances(document.getDocumentId());
252 if (!activeNodeInstances.isEmpty()) {
253
254 RouteNodeInstance nodeInstance = (RouteNodeInstance) activeNodeInstances.get(0);
255 routeContext.setNodeInstance(nodeInstance);
256 }
257 }
258 if (routeContext.getNodeInstance() == null) {
259
260 routeContext.setNodeInstance((RouteNodeInstance) document.getInitialRouteNodeInstances().get(0));
261 }
262 return routeContext;
263 }
264 }