| WorkflowInstanceServiceSoap.java |
1 /**
2 * Copyright (c) 2000-2007 Liferay, Inc. All rights reserved.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
21 */
22
23 package com.liferay.portlet.workflow.service.http;
24
25 import com.liferay.portal.kernel.log.Log;
26 import com.liferay.portal.kernel.log.LogFactoryUtil;
27
28 import com.liferay.portlet.workflow.service.WorkflowInstanceServiceUtil;
29
30 import java.rmi.RemoteException;
31
32 /**
33 * <a href="WorkflowInstanceServiceSoap.java.html"><b><i>View Source</i></b></a>
34 *
35 * <p>
36 * ServiceBuilder generated this class. Modifications in this class will be overwritten
37 * the next time is generated.
38 * </p>
39 *
40 * <p>
41 * This class provides a SOAP utility for the <code>com.liferay.portlet.workflow.service.WorkflowInstanceServiceUtil</code>
42 * service utility. The static methods of this class calls the same methods of the
43 * service utility. However, the signatures are different because it is difficult
44 * for SOAP to support certain types.
45 * </p>
46 *
47 * <p>
48 * ServiceBuilder follows certain rules in translating the methods. For example,
49 * if the method in the service utility returns a <code>java.util.List</code>, that
50 * is translated to an array of <code>com.liferay.portlet.workflow.model.WorkflowInstanceSoap</code>.
51 * If the method in the service utility returns a <code>com.liferay.portlet.workflow.model.WorkflowInstance</code>,
52 * that is translated to a <code>com.liferay.portlet.workflow.model.WorkflowInstanceSoap</code>.
53 * Methods that SOAP cannot safely wire are skipped.
54 * </p>
55 *
56 * <p>
57 * The benefits of using the SOAP utility is that it is cross platform compatible.
58 * SOAP allows different languages like Java, .NET, C++, PHP, and even Perl, to
59 * call the generated services. One drawback of SOAP is that it is slow because
60 * it needs to serialize all calls into a text format (XML).
61 * </p>
62 *
63 * <p>
64 * You can see a list of services at http://localhost:8080/tunnel-web/secure/axis.
65 * Set the property <code>tunnel.servlet.hosts.allowed</code> in portal.properties
66 * to configure security.
67 * </p>
68 *
69 * <p>
70 * The SOAP utility is only generated for remote services.
71 * </p>
72 *
73 * @author Brian Wing Shun Chan
74 *
75 * @see com.liferay.portlet.workflow.service.WorkflowInstanceServiceUtil
76 * @see com.liferay.portlet.workflow.service.http.WorkflowInstanceServiceHttp
77 * @see com.liferay.portlet.workflow.service.model.WorkflowInstanceSoap
78 *
79 */
80 public class WorkflowInstanceServiceSoap {
81 public static com.liferay.portlet.workflow.model.WorkflowInstanceSoap addInstance(
82 long definitionId) throws RemoteException {
83 try {
84 com.liferay.portlet.workflow.model.WorkflowInstance returnValue = WorkflowInstanceServiceUtil.addInstance(definitionId);
85
86 return com.liferay.portlet.workflow.model.WorkflowInstanceSoap.toSoapModel(returnValue);
87 }
88 catch (Exception e) {
89 _log.error(e, e);
90 throw new RemoteException(e.getMessage());
91 }
92 }
93
94 public static void signalInstance(long instanceId)
95 throws RemoteException {
96 try {
97 WorkflowInstanceServiceUtil.signalInstance(instanceId);
98 }
99 catch (Exception e) {
100 _log.error(e, e);
101 throw new RemoteException(e.getMessage());
102 }
103 }
104
105 public static void signalToken(long instanceId, long tokenId)
106 throws RemoteException {
107 try {
108 WorkflowInstanceServiceUtil.signalToken(instanceId, tokenId);
109 }
110 catch (Exception e) {
111 _log.error(e, e);
112 throw new RemoteException(e.getMessage());
113 }
114 }
115
116 private static Log _log = LogFactoryUtil.getLog(WorkflowInstanceServiceSoap.class);
117 }