org.camunda.bpm.engine.impl.jobexecutor.historycleanup.HistoryCleanupHelper Maven / Gradle / Ivy
/*
* Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
* under one or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information regarding copyright
* ownership. Camunda licenses this file to you under the Apache License,
* Version 2.0; you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.camunda.bpm.engine.impl.jobexecutor.historycleanup;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.List;
import java.util.Map;
import org.camunda.bpm.engine.impl.cfg.ProcessEngineConfigurationImpl;
import org.camunda.bpm.engine.impl.interceptor.CommandContext;
import org.camunda.bpm.engine.impl.util.ClockUtil;
/**
* @author Svetlana Dorokhova.
*/
public abstract class HistoryCleanupHelper {
private static final SimpleDateFormat TIME_FORMAT_WITHOUT_SECONDS = new SimpleDateFormat("yyyy-MM-ddHH:mm");
private static final SimpleDateFormat TIME_FORMAT_WITHOUT_SECONDS_WITH_TIMEZONE = new SimpleDateFormat("yyyy-MM-ddHH:mmZ");
private static final SimpleDateFormat DATE_FORMAT_WITHOUT_TIME = new SimpleDateFormat("yyyy-MM-dd");
/**
* Checks if given date is within a batch window. Batch window start time is checked inclusively.
* @param date
* @return
*/
public static boolean isWithinBatchWindow(Date date, ProcessEngineConfigurationImpl configuration) {
if (configuration.getBatchWindowManager().isBatchWindowConfigured(configuration)) {
BatchWindow batchWindow = configuration.getBatchWindowManager().getCurrentOrNextBatchWindow(date, configuration);
if (batchWindow == null) {
return false;
}
return batchWindow.isWithin(date);
} else {
return false;
}
}
public static synchronized Date parseTimeConfiguration(String time) throws ParseException {
String today = DATE_FORMAT_WITHOUT_TIME.format(ClockUtil.getCurrentTime());
try {
return TIME_FORMAT_WITHOUT_SECONDS_WITH_TIMEZONE.parse(today+time);
} catch (ParseException ex) {
return TIME_FORMAT_WITHOUT_SECONDS.parse(today+time);
}
}
private static Integer getHistoryCleanupBatchSize(CommandContext commandContext) {
return commandContext.getProcessEngineConfiguration().getHistoryCleanupBatchSize();
}
/**
* Creates next batch object for history cleanup. First searches for historic process instances ready for cleanup. If there is still some place left in batch (configured batch
* size was not reached), searches for historic decision instances and also adds them to the batch. Then if there is still some place left in batch, searches for historic case
* instances and historic batches - and adds them to the batch.
*
* @param commandContext
* @return
*/
public static void prepareNextBatch(HistoryCleanupBatch historyCleanupBatch, CommandContext commandContext) {
final HistoryCleanupJobHandlerConfiguration configuration = historyCleanupBatch.getConfiguration();
final Integer batchSize = getHistoryCleanupBatchSize(commandContext);
ProcessEngineConfigurationImpl processEngineConfiguration = commandContext.getProcessEngineConfiguration();
//add process instance ids
final List historicProcessInstanceIds = commandContext.getHistoricProcessInstanceManager()
.findHistoricProcessInstanceIdsForCleanup(batchSize, configuration.getMinuteFrom(), configuration.getMinuteTo());
if (historicProcessInstanceIds.size() > 0) {
historyCleanupBatch.setHistoricProcessInstanceIds(historicProcessInstanceIds);
}
//if batch is not full, add decision instance ids
if (historyCleanupBatch.size() < batchSize && processEngineConfiguration.isDmnEnabled()) {
final List historicDecisionInstanceIds = commandContext.getHistoricDecisionInstanceManager()
.findHistoricDecisionInstanceIdsForCleanup(batchSize - historyCleanupBatch.size(), configuration.getMinuteFrom(), configuration.getMinuteTo());
if (historicDecisionInstanceIds.size() > 0) {
historyCleanupBatch.setHistoricDecisionInstanceIds(historicDecisionInstanceIds);
}
}
//if batch is not full, add case instance ids
if (historyCleanupBatch.size() < batchSize && processEngineConfiguration.isCmmnEnabled()) {
final List historicCaseInstanceIds = commandContext.getHistoricCaseInstanceManager()
.findHistoricCaseInstanceIdsForCleanup(batchSize - historyCleanupBatch.size(), configuration.getMinuteFrom(), configuration.getMinuteTo());
if (historicCaseInstanceIds.size() > 0) {
historyCleanupBatch.setHistoricCaseInstanceIds(historicCaseInstanceIds);
}
}
//if batch is not full, add batch ids
Map batchOperationsForHistoryCleanup = processEngineConfiguration.getParsedBatchOperationsForHistoryCleanup();
if (historyCleanupBatch.size() < batchSize && batchOperationsForHistoryCleanup != null && !batchOperationsForHistoryCleanup.isEmpty()) {
List historicBatchIds = commandContext
.getHistoricBatchManager()
.findHistoricBatchIdsForCleanup(batchSize - historyCleanupBatch.size(), batchOperationsForHistoryCleanup, configuration.getMinuteFrom(), configuration.getMinuteTo());
if (historicBatchIds.size() > 0) {
historyCleanupBatch.setHistoricBatchIds(historicBatchIds);
}
}
}
public static int[][] listMinuteChunks(int numberOfChunks) {
final int[][] minuteChunks = new int[numberOfChunks][2];
int chunkLength = 60 / numberOfChunks;
for (int i = 0; i < numberOfChunks; i++) {
minuteChunks[i][0] = chunkLength * i;
minuteChunks[i][1] = chunkLength * (i + 1) - 1;
}
minuteChunks[numberOfChunks - 1][1] = 59;
return minuteChunks;
}
public static boolean isBatchWindowConfigured(CommandContext commandContext) {
return commandContext.getProcessEngineConfiguration().getBatchWindowManager().isBatchWindowConfigured(commandContext.getProcessEngineConfiguration());
}
}