001: /*
002: * This file is part of the WfMOpen project.
003: * Copyright (C) 2001-2004 Danet GmbH (www.danet.de), GS-AN.
004: * All rights reserved.
005: *
006: * This program is free software; you can redistribute it and/or modify
007: * it under the terms of the GNU General Public License as published by
008: * the Free Software Foundation; either version 2 of the License, or
009: * (at your option) any later version.
010: *
011: * This program is distributed in the hope that it will be useful,
012: * but WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
014: * GNU General Public License for more details.
015: *
016: * You should have received a copy of the GNU General Public License
017: * along with this program; if not, write to the Free Software
018: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
019: *
020: * The initial version of this code has been contributed by Init AG
021: * (http://www.init-ka.de).
022: *
023: * $Id: AddComment.java,v 1.2 2006/09/29 12:32:07 drmlipp Exp $
024: *
025: * $Log: AddComment.java,v $
026: * Revision 1.2 2006/09/29 12:32:07 drmlipp
027: * Consistently using WfMOpen as projct name now.
028: *
029: * Revision 1.1 2004/09/03 20:00:42 mlipp
030: * Started adding Scarab interface.
031: *
032: */
033: package de.danet.an.workflow.tools.scarab;
034:
035: import java.io.Serializable;
036:
037: import java.util.Map;
038: import java.util.Vector;
039:
040: import java.rmi.RemoteException;
041:
042: import de.danet.an.workflow.omgcore.ProcessData;
043:
044: import de.danet.an.workflow.api.Activity;
045: import de.danet.an.workflow.api.DefaultProcessData;
046: import de.danet.an.workflow.api.FormalParameter;
047:
048: import de.danet.an.workflow.spis.aii.ApplicationNotStoppedException;
049: import de.danet.an.workflow.spis.aii.CannotExecuteException;
050: import de.danet.an.workflow.spis.aii.ResultProvider;
051: import de.danet.an.workflow.spis.aii.ToolAgent;
052:
053: /**
054: * This class provides a tool that adds a comment to an issue.
055: *
056: * @author lgrischancew@init-ka.de
057: * @author <a href="mailto:lipp@danet.de"></a>
058: * @created on 22.03.2004
059: * @version $Revision: 1.2 $
060: */
061: public class AddComment implements ToolAgent, ResultProvider,
062: Serializable {
063:
064: private static final org.apache.commons.logging.Log logger = org.apache.commons.logging.LogFactory
065: .getLog(AddComment.class);
066:
067: private String serverUrl = "http://localhost:12345";
068:
069: /** The result container. */
070: private ThreadLocal result = new ThreadLocal();
071:
072: /**
073: * Set the server URL. Defaults to
074: * <code>http://localhost:12345</code>.
075: *
076: * @param serverUrl the server URL
077: */
078: public void setServerUrl(String serverUrl) {
079: this .serverUrl = serverUrl;
080: }
081:
082: public void invoke(Activity activity, FormalParameter[] formPars,
083: Map map) throws CannotExecuteException, RemoteException {
084: logger.debug("Process will be started");
085:
086: try {
087: String fromIssueId = (String) map.get(formPars[0].id());
088: logger.debug("The original issue id is : " + fromIssueId);
089: String userName = (String) map.get(formPars[1].id());
090: logger.debug("The name of users is : " + userName);
091: String comment = (String) map.get(formPars[2].id());
092: logger.debug("The comment is : " + comment);
093:
094: result.set(addComment(fromIssueId, userName, comment));
095: } finally {
096: if (logger.isDebugEnabled()) {
097: logger.debug("Finished invocation of "
098: + activity.uniqueKey());
099: }
100: }
101: }
102:
103: /**
104: * @return
105: */
106: private ProcessData addComment(String fromIssueId, String userName,
107: String comment) {
108: ProcessData data = new DefaultProcessData();
109: Vector w = (Vector) (XmlRpcCall.rpc(serverUrl,
110: "scm.addComment", new Object[] { fromIssueId, userName,
111: comment }));
112: return data;
113: }
114:
115: /**
116: * Return the result evaluated during {@link ToolAgent#invoke
117: * <code>invoke</code>}. The method will only be called once after
118: * each invoke, i.e. the attribute holding the result be be
119: * cleared in this method.
120: *
121: * @return the result data or <code>null</code> if the invocation
122: * does not return any data.
123: */
124: public Object result() {
125: Map res = (Map) result.get();
126: result.set(null);
127: return res;
128: }
129:
130: public void terminate(Activity activity)
131: throws ApplicationNotStoppedException {
132: throw new ApplicationNotStoppedException(
133: "Terminate not implemented");
134: }
135: }
|