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.apache.xmlrpc.XmlRpcClient;
050: import org.apache.xmlrpc.XmlRpcException;
051: import org.obe.client.api.repository.XMLRPCServiceMetaData;
052: import org.obe.client.api.tool.ToolInvocation;
053: import org.obe.xpdl.model.data.ParameterMode;
054:
055: import java.io.IOException;
056: import java.lang.reflect.InvocationTargetException;
057: import java.util.Hashtable;
058: import java.util.List;
059: import java.util.Map;
060: import java.util.Vector;
061:
062: /**
063: * A tool agent that invokes an XML-RPC service.
064: *
065: * @author Anthony Eden
066: * @author Adrian Price
067: */
068: public class XMLRPCService extends AbstractToolAgent {
069: private static final long serialVersionUID = -7124232454951467546L;
070: private static final Log _logger = LogFactory
071: .getLog(XMLRPCService.class);
072:
073: private final XMLRPCServiceMetaData _metadata;
074:
075: /**
076: * Construct a new XMLRPCService with the given URL.
077: *
078: * @param metadata Describes the location and method to invoke.
079: */
080: public XMLRPCService(XMLRPCServiceMetaData metadata) {
081: _metadata = metadata;
082: }
083:
084: protected int _invokeApplication(ToolInvocation ti)
085: throws InvocationTargetException {
086:
087: _logger.debug("Invoking XMLRPC service: " + _metadata.getUrl());
088:
089: // Set up parameters.
090: Vector xmlRpcParam = new Vector();
091: for (int i = 0; i < ti.parameters.length; i++) {
092: if (ti.parameters[i].getMode() != ParameterMode.OUT)
093: xmlRpcParam.add(ti.parameters[i].getValue());
094: }
095:
096: // Execute the XMLRPC method.
097: XmlRpcClient rpcClient;
098: Object returnValue;
099: try {
100: rpcClient = new XmlRpcClient(_metadata.getUrl());
101: returnValue = rpcClient.execute(_metadata.getMethod(),
102: xmlRpcParam);
103: } catch (XmlRpcException e) {
104: throw new InvocationTargetException(e);
105: } catch (IOException e) {
106: throw new InvocationTargetException(e);
107: }
108:
109: // Handle return values.
110: if (returnValue instanceof Hashtable) {
111: Map returnHash = (Hashtable) returnValue;
112: for (int i = 0; i < ti.parameters.length; i++) {
113: if (ti.parameters[i].getMode() != ParameterMode.IN) {
114: _logger.info("Retrieving "
115: + ti.parameters[i].getFormalParm().getId()
116: + "from XMLRPC results");
117:
118: ti.parameters[i].setValue(returnHash
119: .get(ti.parameters[i].getFormalParm()
120: .getId()));
121: }
122: }
123: } else if (returnValue instanceof Vector) {
124: List returnVector = (Vector) returnValue;
125: for (int i = 0, returnIndex = 0; i < ti.parameters.length; i++) {
126: if (ti.parameters[i].getMode() != ParameterMode.IN) {
127: if (returnIndex == returnVector.size()) {
128: break;
129: } else {
130: ti.parameters[i].setValue(returnVector
131: .get(returnIndex));
132: returnIndex++;
133: }
134: }
135: }
136: } else {
137: for (int i = 0; i < ti.parameters.length; i++) {
138: if (ti.parameters[i].getMode() != ParameterMode.IN) {
139: ti.parameters[i].setValue(returnValue);
140: break;
141: }
142: }
143:
144: }
145: return 0;
146: }
147: }
|