| UserGroupServiceSoap.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.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.UserGroupServiceUtil;
28
29 import java.rmi.RemoteException;
30
31 /**
32 * <a href="UserGroupServiceSoap.java.html"><b><i>View Source</i></b></a>
33 *
34 * <p>
35 * ServiceBuilder generated this class. Modifications in this class will be overwritten
36 * the next time is generated.
37 * </p>
38 *
39 * <p>
40 * This class provides a SOAP utility for the <code>com.liferay.portal.service.UserGroupServiceUtil</code>
41 * service utility. The static methods of this class calls the same methods of the
42 * service utility. However, the signatures are different because it is difficult
43 * for SOAP to support certain types.
44 * </p>
45 *
46 * <p>
47 * ServiceBuilder follows certain rules in translating the methods. For example,
48 * if the method in the service utility returns a <code>java.util.List</code>, that
49 * is translated to an array of <code>com.liferay.portal.model.UserGroupSoap</code>.
50 * If the method in the service utility returns a <code>com.liferay.portal.model.UserGroup</code>,
51 * that is translated to a <code>com.liferay.portal.model.UserGroupSoap</code>.
52 * Methods that SOAP cannot safely wire are skipped.
53 * </p>
54 *
55 * <p>
56 * The benefits of using the SOAP utility is that it is cross platform compatible.
57 * SOAP allows different languages like Java, .NET, C++, PHP, and even Perl, to
58 * call the generated services. One drawback of SOAP is that it is slow because
59 * it needs to serialize all calls into a text format (XML).
60 * </p>
61 *
62 * <p>
63 * You can see a list of services at http://localhost:8080/tunnel-web/secure/axis.
64 * Set the property <code>tunnel.servlet.hosts.allowed</code> in portal.properties
65 * to configure security.
66 * </p>
67 *
68 * <p>
69 * The SOAP utility is only generated for remote services.
70 * </p>
71 *
72 * @author Brian Wing Shun Chan
73 *
74 * @see com.liferay.portal.service.UserGroupServiceUtil
75 * @see com.liferay.portal.service.http.UserGroupServiceHttp
76 * @see com.liferay.portal.service.model.UserGroupSoap
77 *
78 */
79 public class UserGroupServiceSoap {
80 public static void addGroupUserGroups(long groupId, long[] userGroupIds)
81 throws RemoteException {
82 try {
83 UserGroupServiceUtil.addGroupUserGroups(groupId, userGroupIds);
84 }
85 catch (Exception e) {
86 _log.error(e, e);
87 throw new RemoteException(e.getMessage());
88 }
89 }
90
91 public static com.liferay.portal.model.UserGroupSoap addUserGroup(
92 java.lang.String name, java.lang.String description)
93 throws RemoteException {
94 try {
95 com.liferay.portal.model.UserGroup returnValue = UserGroupServiceUtil.addUserGroup(name,
96 description);
97
98 return com.liferay.portal.model.UserGroupSoap.toSoapModel(returnValue);
99 }
100 catch (Exception e) {
101 _log.error(e, e);
102 throw new RemoteException(e.getMessage());
103 }
104 }
105
106 public static void deleteUserGroup(long userGroupId)
107 throws RemoteException {
108 try {
109 UserGroupServiceUtil.deleteUserGroup(userGroupId);
110 }
111 catch (Exception e) {
112 _log.error(e, e);
113 throw new RemoteException(e.getMessage());
114 }
115 }
116
117 public static com.liferay.portal.model.UserGroupSoap getUserGroup(
118 long userGroupId) throws RemoteException {
119 try {
120 com.liferay.portal.model.UserGroup returnValue = UserGroupServiceUtil.getUserGroup(userGroupId);
121
122 return com.liferay.portal.model.UserGroupSoap.toSoapModel(returnValue);
123 }
124 catch (Exception e) {
125 _log.error(e, e);
126 throw new RemoteException(e.getMessage());
127 }
128 }
129
130 public static com.liferay.portal.model.UserGroupSoap getUserGroup(
131 java.lang.String name) throws RemoteException {
132 try {
133 com.liferay.portal.model.UserGroup returnValue = UserGroupServiceUtil.getUserGroup(name);
134
135 return com.liferay.portal.model.UserGroupSoap.toSoapModel(returnValue);
136 }
137 catch (Exception e) {
138 _log.error(e, e);
139 throw new RemoteException(e.getMessage());
140 }
141 }
142
143 public static com.liferay.portal.model.UserGroupSoap[] getUserUserGroups(
144 long userId) throws RemoteException {
145 try {
146 java.util.List returnValue = UserGroupServiceUtil.getUserUserGroups(userId);
147
148 return com.liferay.portal.model.UserGroupSoap.toSoapModels(returnValue);
149 }
150 catch (Exception e) {
151 _log.error(e, e);
152 throw new RemoteException(e.getMessage());
153 }
154 }
155
156 public static void unsetGroupUserGroups(long groupId, long[] userGroupIds)
157 throws RemoteException {
158 try {
159 UserGroupServiceUtil.unsetGroupUserGroups(groupId, userGroupIds);
160 }
161 catch (Exception e) {
162 _log.error(e, e);
163 throw new RemoteException(e.getMessage());
164 }
165 }
166
167 public static com.liferay.portal.model.UserGroupSoap updateUserGroup(
168 long userGroupId, java.lang.String name, java.lang.String description)
169 throws RemoteException {
170 try {
171 com.liferay.portal.model.UserGroup returnValue = UserGroupServiceUtil.updateUserGroup(userGroupId,
172 name, description);
173
174 return com.liferay.portal.model.UserGroupSoap.toSoapModel(returnValue);
175 }
176 catch (Exception e) {
177 _log.error(e, e);
178 throw new RemoteException(e.getMessage());
179 }
180 }
181
182 private static Log _log = LogFactoryUtil.getLog(UserGroupServiceSoap.class);
183 }