AbstractDatabaseEventLoggerEventHandler.java

package org.activiti.engine.impl.event.logger.handler;

import java.util.Date;
import java.util.Map;

import org.activiti.engine.delegate.event.ActivitiEntityEvent;
import org.activiti.engine.delegate.event.ActivitiEvent;
import org.activiti.engine.impl.cfg.ProcessEngineConfigurationImpl;
import org.activiti.engine.impl.context.Context;
import org.activiti.engine.impl.identity.Authentication;
import org.activiti.engine.impl.persistence.deploy.DeploymentCache;
import org.activiti.engine.impl.persistence.entity.EventLogEntryEntity;
import org.activiti.engine.impl.persistence.entity.ProcessDefinitionEntity;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.fasterxml.jackson.databind.ObjectMapper;

/**
 * @author Joram Barrez
 */
public abstract class AbstractDatabaseEventLoggerEventHandler implements EventLoggerEventHandler {
	
	private static final Logger logger = LoggerFactory.getLogger(AbstractDatabaseEventLoggerEventHandler.class);

	protected ActivitiEvent event;
	protected Date timeStamp;
	protected ObjectMapper objectMapper;
	
	public AbstractDatabaseEventLoggerEventHandler() {
	}
	
	protected EventLogEntryEntity createEventLogEntry(Map<String, Object> data) {
		return createEventLogEntry(null, null, null, null, data);
	}
	
	protected EventLogEntryEntity createEventLogEntry(String processDefinitionId, String processInstanceId, 
			String executionId, String taskId, Map<String, Object> data) {
		return createEventLogEntry(event.getType().name(), processDefinitionId, processInstanceId, executionId, taskId, data);
	}
	
	protected EventLogEntryEntity createEventLogEntry(String type,
	    String processDefinitionId, String processInstanceId, String executionId,
	    String taskId, Map<String, Object> data) {

		EventLogEntryEntity eventLogEntry = new EventLogEntryEntity();
		eventLogEntry.setProcessDefinitionId(processDefinitionId);
		eventLogEntry.setProcessInstanceId(processInstanceId);
		eventLogEntry.setExecutionId(executionId);
		eventLogEntry.setTaskId(taskId);
		eventLogEntry.setType(type);
		eventLogEntry.setTimeStamp(timeStamp);
		putInMapIfNotNull(data, Fields.TIMESTAMP, timeStamp);

		// Current user
		String userId = Authentication.getAuthenticatedUserId();
		if (userId != null) {
			eventLogEntry.setUserId(userId);
			putInMapIfNotNull(data, "userId", userId);
		}
		
		// Current tenant
		if (!data.containsKey(Fields.TENANT_ID) && processDefinitionId != null) {
			DeploymentCache<ProcessDefinitionEntity> processDefinitionCache = Context.getProcessEngineConfiguration().getProcessDefinitionCache();
			if (processDefinitionCache != null) {
				ProcessDefinitionEntity processDefinitionEntity = processDefinitionCache.get(processDefinitionId);
				if (processDefinitionEntity != null 
						&& !ProcessEngineConfigurationImpl.NO_TENANT_ID.equals(processDefinitionEntity.getTenantId())) {
					putInMapIfNotNull(data, Fields.TENANT_ID, processDefinitionEntity.getTenantId());
				}
			}
		}

		try {
			eventLogEntry.setData(objectMapper.writeValueAsBytes(data));
		} catch (Exception e) {
			logger.warn("Could not serialize event data. Data will not be written to the database", e);
		}

		return eventLogEntry;

	}

	@Override
	public void setEvent(ActivitiEvent event) {
		this.event = event;
	}
	
	@Override
	public void setTimeStamp(Date timeStamp) {
		this.timeStamp = timeStamp;
	}
	
	@Override
  public void setObjectMapper(ObjectMapper objectMapper) {
		this.objectMapper = objectMapper;
  }
	
	// Helper methods //////////////////////////////////////////////////////
	
	@SuppressWarnings("unchecked")
  public <T> T getEntityFromEvent() {
		return (T) ((ActivitiEntityEvent) event).getEntity();
	}
	
	public void putInMapIfNotNull(Map<String, Object> map, String key, Object value) {
		if (value != null) {
			map.put(key, value);
		}
	}
	
}