org.broadleafcommerce.core.checkout.service.workflow.DecrementInventoryRollbackHandler Maven / Gradle / Ivy
/*
* #%L
* BroadleafCommerce Framework
* %%
* Copyright (C) 2009 - 2014 Broadleaf Commerce
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* 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.
* #L%
*/
package org.broadleafcommerce.core.checkout.service.workflow;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.broadleafcommerce.core.catalog.domain.Sku;
import org.broadleafcommerce.core.inventory.service.ContextualInventoryService;
import org.broadleafcommerce.core.inventory.service.InventoryUnavailableException;
import org.broadleafcommerce.core.workflow.Activity;
import org.broadleafcommerce.core.workflow.ProcessContext;
import org.broadleafcommerce.core.workflow.state.RollbackFailureException;
import org.broadleafcommerce.core.workflow.state.RollbackHandler;
import org.springframework.stereotype.Component;
import java.util.HashMap;
import java.util.Map;
import javax.annotation.Resource;
/**
* Decrements inventory that was put on by the {@link DecrementInventoryActivity}
*
* @author Phillip Verheyden (phillipuniverse)
*/
@Component("blDecrementInventoryRollbackHandler")
public class DecrementInventoryRollbackHandler implements RollbackHandler{
private static final Log LOG = LogFactory.getLog(DecrementInventoryRollbackHandler.class);
public static final String ROLLBACK_BLC_INVENTORY_DECREMENTED = "ROLLBACK_BLC_INVENTORY_DECREMENTED";
public static final String ROLLBACK_BLC_INVENTORY_INCREMENTED = "ROLLBACK_BLC_INVENTORY_INCREMENTED";
public static final String ROLLBACK_BLC_ORDER_ID = "ROLLBACK_BLC_ORDER_ID";
public static final String EXTENDED_ROLLBACK_STATE = "BLC_EXTENDED_ROLLBACK_STATE";
@Resource(name = "blInventoryService")
protected ContextualInventoryService inventoryService;
@Override
public void rollbackState(Activity> activity, ProcessContext processContext, Map stateConfiguration)
throws RollbackFailureException {
if (shouldExecute(activity, processContext, stateConfiguration)) {
String orderId = "(Not Known)";
if (stateConfiguration.get(ROLLBACK_BLC_ORDER_ID) != null) {
orderId = String.valueOf(stateConfiguration.get(ROLLBACK_BLC_ORDER_ID));
}
@SuppressWarnings("unchecked")
Map inventoryToIncrement = (Map) stateConfiguration.get(ROLLBACK_BLC_INVENTORY_DECREMENTED);
@SuppressWarnings("unchecked")
Map inventoryToDecrement = (Map) stateConfiguration.get(ROLLBACK_BLC_INVENTORY_INCREMENTED);
Map contextualInformation = new HashMap();
contextualInformation.put(ContextualInventoryService.ROLLBACK_STATE_KEY, stateConfiguration.get(EXTENDED_ROLLBACK_STATE));
contextualInformation.put(ContextualInventoryService.ORDER_KEY, processContext.getSeedData().getOrder());
if (inventoryToIncrement != null && !inventoryToIncrement.isEmpty()) {
try {
inventoryService.incrementInventory(inventoryToIncrement, contextualInformation);
} catch (Exception ex) {
RollbackFailureException rfe = new RollbackFailureException("An unexpected error occured in the error handler of the checkout workflow trying to compensate for inventory. This happend for order ID: " +
orderId + ". This should be corrected manually!", ex);
rfe.setActivity(activity);
rfe.setProcessContext(processContext);
rfe.setStateItems(stateConfiguration);
throw rfe;
}
}
if (inventoryToDecrement != null && !inventoryToDecrement.isEmpty()) {
try {
inventoryService.decrementInventory(inventoryToDecrement, contextualInformation);
} catch (InventoryUnavailableException e) {
//This is an awkward, unlikely state. I just added some inventory, but something happened, and I want to remove it, but it's already gone!
RollbackFailureException rfe = new RollbackFailureException("While trying roll back (decrement) inventory, we found that there was none left decrement.", e);
rfe.setActivity(activity);
rfe.setProcessContext(processContext);
rfe.setStateItems(stateConfiguration);
throw rfe;
} catch (RuntimeException ex) {
LOG.error("An unexpected error occured in the error handler of the checkout workflow trying to compensate for inventory. This happend for order ID: " +
orderId + ". This should be corrected manually!", ex);
RollbackFailureException rfe = new RollbackFailureException("An unexpected error occured in the error handler of the checkout workflow " +
"trying to compensate for inventory. This happend for order ID: " +
orderId + ". This should be corrected manually!", ex);
rfe.setActivity(activity);
rfe.setProcessContext(processContext);
rfe.setStateItems(stateConfiguration);
throw rfe;
}
}
}
}
/**
* Returns true if this rollback handler should execute
*/
protected boolean shouldExecute(Activity> activity, ProcessContext processContext, Map stateConfiguration) {
return stateConfiguration != null && (
stateConfiguration.get(ROLLBACK_BLC_INVENTORY_DECREMENTED) != null ||
stateConfiguration.get(ROLLBACK_BLC_INVENTORY_INCREMENTED) != null ||
stateConfiguration.get(EXTENDED_ROLLBACK_STATE) != null
);
}
}