/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.apache.commons.scxml2.invoke;
import java.io.IOException;
import java.io.Serializable;
import java.net.URL;
import java.util.Map;
import javax.xml.stream.XMLStreamException;
import org.apache.commons.scxml2.Context;
import org.apache.commons.scxml2.Evaluator;
import org.apache.commons.scxml2.SCXMLExecutor;
import org.apache.commons.scxml2.SCXMLIOProcessor;
import org.apache.commons.scxml2.TriggerEvent;
import org.apache.commons.scxml2.env.SimpleDispatcher;
import org.apache.commons.scxml2.env.SimpleErrorReporter;
import org.apache.commons.scxml2.env.SimpleSCXMLListener;
import org.apache.commons.scxml2.io.SCXMLReader;
import org.apache.commons.scxml2.model.ModelException;
import org.apache.commons.scxml2.model.SCXML;
/**
* A simple {@link Invoker} for SCXML documents. Invoked SCXML document
* may not contain external namespace elements, further invokes etc.
*/
public class SimpleSCXMLInvoker implements Invoker, Serializable {
/** Serial version UID. */
private static final long serialVersionUID = 1L;
/** Parent state ID. */
private String parentStateId;
/** Invoking document's external I/O Processor */
private SCXMLIOProcessor parentIOProcessor;
/** The Evaluator provided by the parent executor */
private Evaluator evaluator;
/** The invoked state machine executor. */
private SCXMLExecutor executor;
/** Cancellation status. */
private boolean cancelled;
/**
* {@inheritDoc}.
*/
public void setInvokeId(final String invokeId) {
this.parentStateId = invokeId;
this.cancelled = false;
}
/**
* {@inheritDoc}.
*/
public void setParentIOProcessor(SCXMLIOProcessor parentIOProcessor) {
this.parentIOProcessor = parentIOProcessor;
}
/**
* {@inheritDoc}.
*/
public void setEvaluator(final Evaluator evaluator) {
this.evaluator = evaluator;
}
/**
* {@inheritDoc}.
*/
public void invoke(final String source, final Map<String, Object> params)
throws InvokerException {
SCXML scxml;
try {
scxml = SCXMLReader.read(new URL(source));
} catch (ModelException me) {
throw new InvokerException(me.getMessage(), me.getCause());
} catch (IOException ioe) {
throw new InvokerException(ioe.getMessage(), ioe.getCause());
} catch (XMLStreamException xse) {
throw new InvokerException(xse.getMessage(), xse.getCause());
}
executor = new SCXMLExecutor(evaluator, new SimpleDispatcher(), new SimpleErrorReporter());
Context rootCtx = evaluator.newContext(null);
for (Map.Entry<String, Object> entry : params.entrySet()) {
rootCtx.setLocal(entry.getKey(), entry.getValue());
}
executor.setRootContext(rootCtx);
try {
executor.setStateMachine(scxml);
}
catch (ModelException me) {
throw new InvokerException(me);
}
executor.addListener(scxml, new SimpleSCXMLListener());
executor.registerInvokerClass("scxml", this.getClass());
try {
executor.go();
} catch (ModelException me) {
throw new InvokerException(me.getMessage(), me.getCause());
}
if (executor.getCurrentStatus().isFinal()) {
TriggerEvent te = new TriggerEvent("done.invoke."+parentStateId, TriggerEvent.SIGNAL_EVENT);
new AsyncTrigger(parentIOProcessor, te).start();
}
}
/**
* {@inheritDoc}.
*/
public void parentEvent(final TriggerEvent evt)
throws InvokerException {
if (cancelled) {
return; // no further processing should take place
}
boolean doneBefore = executor.getCurrentStatus().isFinal();
try {
executor.triggerEvent(evt);
} catch (ModelException me) {
throw new InvokerException(me.getMessage(), me.getCause());
}
if (!doneBefore && executor.getCurrentStatus().isFinal()) {
TriggerEvent te = new TriggerEvent("done.invoke."+parentStateId,TriggerEvent.SIGNAL_EVENT);
new AsyncTrigger(parentIOProcessor, te).start();
}
}
/**
* {@inheritDoc}.
*/
public void cancel()
throws InvokerException {
cancelled = true;
try {
executor.triggerEvent(new TriggerEvent("cancel.invoke."+parentStateId, TriggerEvent.CANCEL_EVENT));
} catch (ModelException me) {
throw new InvokerException(me.getMessage(), me.getCause());
}
}
}