| PortletServiceSoap.java |
1 /**
2 * Copyright (c) 2000-2009 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.portal.service.http;
24
25 import com.liferay.portal.kernel.log.Log;
26 import com.liferay.portal.kernel.log.LogFactoryUtil;
27 import com.liferay.portal.service.PortletServiceUtil;
28
29 import java.rmi.RemoteException;
30
31 /**
32 * <a href="PortletServiceSoap.java.html"><b><i>View Source</i></b></a>
33 *
34 * <p>
35 * ServiceBuilder generated this class. Modifications in this class will be
36 * overwritten the next time is generated.
37 * </p>
38 *
39 * <p>
40 * This class provides a SOAP utility for the
41 * <code>com.liferay.portal.service.PortletServiceUtil</code> service
42 * utility. The static methods of this class calls the same methods of the
43 * service utility. However, the signatures are different because it is
44 * difficult 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>,
50 * that is translated to an array of
51 * <code>com.liferay.portal.model.PortletSoap</code>. If the method in the
52 * service utility returns a <code>com.liferay.portal.model.Portlet</code>,
53 * that is translated to a <code>com.liferay.portal.model.PortletSoap</code>.
54 * Methods that SOAP cannot safely wire are skipped.
55 * </p>
56 *
57 * <p>
58 * The benefits of using the SOAP utility is that it is cross platform
59 * compatible. SOAP allows different languages like Java, .NET, C++, PHP, and
60 * even Perl, to call the generated services. One drawback of SOAP is that it is
61 * slow because it needs to serialize all calls into a text format (XML).
62 * </p>
63 *
64 * <p>
65 * You can see a list of services at
66 * http://localhost:8080/tunnel-web/secure/axis. Set the property
67 * <code>tunnel.servlet.hosts.allowed</code> in portal.properties to configure
68 * security.
69 * </p>
70 *
71 * <p>
72 * The SOAP utility is only generated for remote services.
73 * </p>
74 *
75 * @author Brian Wing Shun Chan
76 *
77 * @see com.liferay.portal.model.PortletSoap
78 * @see com.liferay.portal.service.PortletServiceUtil
79 * @see com.liferay.portal.service.http.PortletServiceHttp
80 *
81 */
82 public class PortletServiceSoap {
83 public static com.liferay.portal.kernel.json.JSONArray getWARPortlets()
84 throws RemoteException {
85 try {
86 com.liferay.portal.kernel.json.JSONArray returnValue = PortletServiceUtil.getWARPortlets();
87
88 return returnValue;
89 }
90 catch (Exception e) {
91 _log.error(e, e);
92
93 throw new RemoteException(e.getMessage());
94 }
95 }
96
97 public static com.liferay.portal.model.PortletSoap updatePortlet(
98 long companyId, java.lang.String portletId, java.lang.String roles,
99 boolean active) throws RemoteException {
100 try {
101 com.liferay.portal.model.Portlet returnValue = PortletServiceUtil.updatePortlet(companyId,
102 portletId, roles, active);
103
104 return com.liferay.portal.model.PortletSoap.toSoapModel(returnValue);
105 }
106 catch (Exception e) {
107 _log.error(e, e);
108
109 throw new RemoteException(e.getMessage());
110 }
111 }
112
113 private static Log _log = LogFactoryUtil.getLog(PortletServiceSoap.class);
114 }