001/* 002 * (C) Copyright 2015-2018 Nuxeo (http://nuxeo.com/) and others. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 * 016 * Contributors: 017 * <a href="mailto:grenard@nuxeo.com">Guillaume Renard</a> 018 * 019 */ 020 021package org.nuxeo.ecm.platform.routing.core.audit; 022 023import java.util.Date; 024import java.util.HashMap; 025import java.util.Iterator; 026import java.util.List; 027import java.util.Map; 028 029import org.apache.commons.lang3.StringUtils; 030import org.nuxeo.ecm.platform.audit.api.BuiltinLogEntryData; 031import org.nuxeo.ecm.platform.audit.api.FilterMapEntry; 032import org.nuxeo.ecm.platform.audit.api.LogEntry; 033import org.nuxeo.ecm.platform.audit.api.Logs; 034import org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants; 035import org.nuxeo.runtime.api.Framework; 036 037/** 038 * Helper method related to Routing Audit. 039 * 040 * @since 7.4 041 */ 042public final class RoutingAuditHelper { 043 044 public static final String TIME_SINCE_WF_STARTED = "timeSinceWfStarted"; 045 046 public static final String TIME_SINCE_TASK_STARTED = "timeSinceTaskStarted"; 047 048 public static final String TASK_ACTOR = "taskActor"; 049 050 public static final String WORKFLOW_INITATIOR = "workflowInitiator"; 051 052 public static final String WORKFLOW_VARIABLES = "workflowVariables"; 053 054 /** 055 * Query the audit for an entry of the Routing category matching the given event and returns the time elapsed since it is recorded. 056 * 057 * @since 7.4 058 */ 059 public static long computeElapsedTime(DocumentRoutingConstants.Events event, String elementId) { 060 Logs logs = Framework.getService(Logs.class); 061 if (logs != null && StringUtils.isNotBlank(elementId)) { 062 Map<String, FilterMapEntry> filterMap = new HashMap<>(); 063 064 FilterMapEntry categoryFilterMapEntry = new FilterMapEntry(); 065 categoryFilterMapEntry.setColumnName(BuiltinLogEntryData.LOG_CATEGORY); 066 categoryFilterMapEntry.setOperator("="); 067 categoryFilterMapEntry.setQueryParameterName(BuiltinLogEntryData.LOG_CATEGORY); 068 categoryFilterMapEntry.setObject(DocumentRoutingConstants.ROUTING_CATEGORY); 069 filterMap.put(BuiltinLogEntryData.LOG_CATEGORY, categoryFilterMapEntry); 070 071 FilterMapEntry eventIdFilterMapEntry = new FilterMapEntry(); 072 eventIdFilterMapEntry.setColumnName(BuiltinLogEntryData.LOG_EVENT_ID); 073 eventIdFilterMapEntry.setOperator("="); 074 eventIdFilterMapEntry.setQueryParameterName(BuiltinLogEntryData.LOG_EVENT_ID); 075 eventIdFilterMapEntry.setObject(event.name()); 076 filterMap.put(BuiltinLogEntryData.LOG_EVENT_ID, eventIdFilterMapEntry); 077 078 List<LogEntry> logEntries = logs.getLogEntriesFor(elementId, filterMap, true); 079 if (logEntries.size() > 0) { 080 LogEntry logEntry = logEntries.get(0); 081 Date start = logEntry.getEventDate(); 082 return new Date().getTime() - start.getTime(); 083 } 084 } 085 return -1; 086 } 087 088 /** 089 * Return the elapsed time since a workflow had started. 090 * 091 * @param workflowInstanceId the workflowInstanceId 092 * @return elapsed time in ms 093 * @since 7.4 094 */ 095 public static long computeDurationSinceWfStarted(String workflowInstanceId) { 096 return RoutingAuditHelper.computeElapsedTime(DocumentRoutingConstants.Events.afterWorkflowStarted, workflowInstanceId); 097 } 098 099 /** 100 * Return the elapsed time since a task had started. 101 * 102 * @param taskId the taskId 103 * @return elapsed time in ms 104 * @since 7.4 105 */ 106 public static long computeDurationSinceTaskStarted(String taskId) { 107 return RoutingAuditHelper.computeElapsedTime(DocumentRoutingConstants.Events.afterWorkflowTaskCreated, taskId); 108 } 109}