/**
 * Copyright 2010 JBoss Inc
 *
 * 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.
 */

package org.jbpm.process.core.context.exception;

import java.util.Arrays;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.Map;
import java.util.Queue;

import org.jbpm.process.core.Context;
import org.jbpm.process.core.ContextContainer;
import org.jbpm.ruleflow.core.RuleFlowProcess;
import org.jbpm.workflow.core.NodeContainer;
import org.jbpm.workflow.core.WorkflowProcess;
import org.jbpm.workflow.core.impl.NodeImpl;
import org.kie.api.definition.process.Node;
import org.kie.api.definition.process.Process;


/**
 * This scope represents the collection of compensation handlers in a (sub)process. 
 * 
 *
 */
public class CompensationScope extends ExceptionScope {

    private static final long serialVersionUID = 510l;

    public static final String COMPENSATION_SCOPE = "CompensationScope";
    public static final String GENERAL_COMPENSATION_PREFIX = "general:";
    
    private String containerId; 
    
    public String getType() {
        return COMPENSATION_SCOPE;
    }

    public void setContextContainer(ContextContainer contextContainer) { 
        assert contextContainer instanceof NodeContainer 
            : "CompensationScope context container instance is NOT an instance of a node container! " +
            "(" + contextContainer.getClass().getSimpleName() + ")";
        super.setContextContainer(contextContainer);
        if( contextContainer instanceof NodeImpl ) { 
            containerId = (String) ((NodeImpl) contextContainer).getMetaData("UniqueId");
        } else if( contextContainer instanceof RuleFlowProcess ) { 
            containerId = (String) ((Process) contextContainer).getId();
        }
    }
    
    public String getContextContainerId() { 
        return containerId;
    }
    
    public ExceptionHandler getExceptionHandler(String exception) {
        return exceptionHandlers.get(exception);
    }
    
    /**
     * Resolves in one of two cases: when the (String) activityRefStr is equal to:
     * 1. the id of an activity that has a compensation handler. 
     *    This could be a task with a compensation boundary event or a sub-process
     *    that contains a compensation event sub-process. 
     * 2. "general:" + the id of the (sub)process that contains the compensation handler. In this 
     *    case, we are signalling the "implicit compensation handler", a.k.a. 
     *    broadcast/general compensation. 
     */
     
    public Context resolveContext(Object activityRefStr) {
        if( activityRefStr == null || ! (activityRefStr instanceof String) ) {
            throw new IllegalArgumentException(
                    "CompensationScope can only resolve based on node id strings: " + activityRefStr);
        }
        String activityRef = (String) activityRefStr;
        if( getExceptionHandler(activityRef) != null ) { 
            return this;
        } 
        if( activityRef.startsWith(GENERAL_COMPENSATION_PREFIX) ) { 
           String containerRef = activityRef.substring(GENERAL_COMPENSATION_PREFIX.length());
           if( containerId.equals(containerRef) ) { 
               return this;
           }
        }
        return null;
    }
    
}
