001: /*--
002:
003: Copyright (C) 2002-2005 Adrian Price.
004: All rights reserved.
005:
006: Redistribution and use in source and binary forms, with or without
007: modification, are permitted provided that the following conditions
008: are met:
009:
010: 1. Redistributions of source code must retain the above copyright
011: notice, this list of conditions, and the following disclaimer.
012:
013: 2. Redistributions in binary form must reproduce the above copyright
014: notice, this list of conditions, and the disclaimer that follows
015: these conditions in the documentation and/or other materials
016: provided with the distribution.
017:
018: 3. The names "OBE" and "Open Business Engine" must not be used to
019: endorse or promote products derived from this software without prior
020: written permission. For written permission, please contact
021: adrianprice@sourceforge.net.
022:
023: 4. Products derived from this software may not be called "OBE" or
024: "Open Business Engine", nor may "OBE" or "Open Business Engine"
025: appear in their name, without prior written permission from
026: Adrian Price (adrianprice@users.sourceforge.net).
027:
028: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
029: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
030: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
031: DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
032: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
033: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
034: SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
035: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
036: STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
037: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
038: POSSIBILITY OF SUCH DAMAGE.
039:
040: For more information on OBE, please see
041: <http://obe.sourceforge.net/>.
042:
043: */
044:
045: package org.obe.runtime.tool;
046:
047: import org.apache.commons.logging.Log;
048: import org.apache.commons.logging.LogFactory;
049: import org.obe.XMLException;
050: import org.obe.client.api.repository.RepositoryException;
051: import org.obe.client.api.repository.ScriptMetaData;
052: import org.obe.client.api.tool.ToolInvocation;
053: import org.obe.xpdl.model.data.ParameterMode;
054: import org.python.util.PythonInterpreter;
055:
056: import java.io.IOException;
057: import java.lang.reflect.InvocationTargetException;
058:
059: /**
060: * A tool agent that executes a Python script.
061: *
062: * @author Anthony Eden
063: * @author Adrian Price
064: * @see <a href="http://www.python.org/">The Python Language</a>
065: */
066: public final class PythonScript extends Script {
067: private static final long serialVersionUID = -5756399586551636173L;
068: private static final Log _logger = LogFactory
069: .getLog(PythonScript.class);
070:
071: public PythonScript(ScriptMetaData metadata) {
072: super (metadata);
073: }
074:
075: protected int _invokeApplication(ToolInvocation ti)
076: throws InvocationTargetException {
077:
078: PythonInterpreter interpreter = new PythonInterpreter();
079:
080: // Set up the standard objects.
081: interpreter.set("log", _logger);
082: interpreter.set("obe", getWorkflowContext());
083:
084: // setup the parameters
085: for (int i = 0; i < ti.parameters.length; i++) {
086: if (ti.parameters[i].getMode() != ParameterMode.OUT) {
087: _logger.debug("Putting "
088: + ti.parameters[i].getFormalParm().getId()
089: + " = " + ti.parameters[i].getValue()
090: + " into Jython interpreter");
091:
092: interpreter.set(ti.parameters[i].getFormalParm()
093: .getId(), ti.parameters[i].getValue());
094: }
095: }
096:
097: // Execute the script.
098: String script;
099: try {
100: script = readScript();
101: } catch (IOException e) {
102: throw new InvocationTargetException(e);
103: } catch (XMLException e) {
104: throw new InvocationTargetException(e);
105: } catch (RepositoryException e) {
106: throw new InvocationTargetException(e);
107: }
108: _status = ACTIVE;
109: interpreter.exec(script);
110:
111: // Update INOUT and OUT parameters with results.
112: for (int i = 0; i < ti.parameters.length; i++) {
113: if (ti.parameters[i].getMode() != ParameterMode.IN) {
114: _logger.debug("Getting " + ti.parameters[i].getId()
115: + " from Jython interpreter");
116:
117: // Store the value as a string, because Jython uses weird
118: // classes for numeric results. The AttributeInstance will
119: // convert the value to the correct class.
120: Object value = interpreter.get(ti.parameters[i]
121: .getFormalParm().getId());
122: ti.parameters[i].setValue(value == null ? null : value
123: .toString());
124: }
125: }
126: return 0;
127: }
128: }
|