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