001
014
015 package com.liferay.portlet.usersadmin.util;
016
017 import aQute.bnd.annotation.ProviderType;
018
019 import com.liferay.portal.kernel.exception.PortalException;
020 import com.liferay.portal.kernel.search.Hits;
021 import com.liferay.portal.kernel.security.pacl.permission.PortalRuntimePermission;
022 import com.liferay.portal.kernel.util.OrderByComparator;
023 import com.liferay.portal.model.Address;
024 import com.liferay.portal.model.EmailAddress;
025 import com.liferay.portal.model.Group;
026 import com.liferay.portal.model.OrgLabor;
027 import com.liferay.portal.model.Organization;
028 import com.liferay.portal.model.Phone;
029 import com.liferay.portal.model.Role;
030 import com.liferay.portal.model.User;
031 import com.liferay.portal.model.UserGroup;
032 import com.liferay.portal.model.UserGroupRole;
033 import com.liferay.portal.model.Website;
034 import com.liferay.portal.security.permission.PermissionChecker;
035
036 import java.util.List;
037
038 import javax.portlet.ActionRequest;
039 import javax.portlet.PortletRequest;
040 import javax.portlet.RenderResponse;
041
042 import javax.servlet.http.HttpServletRequest;
043
044
049 @ProviderType
050 public class UsersAdminUtil {
051
052
055 @Deprecated
056 public static final String CUSTOM_QUESTION = "write-my-own-question";
057
058 public static void addPortletBreadcrumbEntries(
059 Organization organization, HttpServletRequest request,
060 RenderResponse renderResponse)
061 throws Exception {
062
063 getUsersAdmin().addPortletBreadcrumbEntries(
064 organization, request, renderResponse);
065 }
066
067 public static long[] addRequiredRoles(long userId, long[] roleIds)
068 throws PortalException {
069
070 return getUsersAdmin().addRequiredRoles(userId, roleIds);
071 }
072
073 public static long[] addRequiredRoles(User user, long[] roleIds)
074 throws PortalException {
075
076 return getUsersAdmin().addRequiredRoles(user, roleIds);
077 }
078
079 public static List<Role> filterGroupRoles(
080 PermissionChecker permissionChecker, long groupId, List<Role> roles)
081 throws PortalException {
082
083 return getUsersAdmin().filterGroupRoles(
084 permissionChecker, groupId, roles);
085 }
086
087 public static List<Group> filterGroups(
088 PermissionChecker permissionChecker, List<Group> groups)
089 throws PortalException {
090
091 return getUsersAdmin().filterGroups(permissionChecker, groups);
092 }
093
094 public static List<Organization> filterOrganizations(
095 PermissionChecker permissionChecker,
096 List<Organization> organizations)
097 throws PortalException {
098
099 return getUsersAdmin().filterOrganizations(
100 permissionChecker, organizations);
101 }
102
103 public static List<Role> filterRoles(
104 PermissionChecker permissionChecker, List<Role> roles) {
105
106 return getUsersAdmin().filterRoles(permissionChecker, roles);
107 }
108
109 public static long[] filterUnsetGroupUserIds(
110 PermissionChecker permissionChecker, long groupId, long[] userIds)
111 throws PortalException {
112
113 return getUsersAdmin().filterUnsetGroupUserIds(
114 permissionChecker, groupId, userIds);
115 }
116
117 public static long[] filterUnsetOrganizationUserIds(
118 PermissionChecker permissionChecker, long organizationId,
119 long[] userIds)
120 throws PortalException {
121
122 return getUsersAdmin().filterUnsetOrganizationUserIds(
123 permissionChecker, organizationId, userIds);
124 }
125
126 public static List<UserGroupRole> filterUserGroupRoles(
127 PermissionChecker permissionChecker,
128 List<UserGroupRole> userGroupRoles)
129 throws PortalException {
130
131 return getUsersAdmin().filterUserGroupRoles(
132 permissionChecker, userGroupRoles);
133 }
134
135 public static List<UserGroup> filterUserGroups(
136 PermissionChecker permissionChecker, List<UserGroup> userGroups) {
137
138 return getUsersAdmin().filterUserGroups(permissionChecker, userGroups);
139 }
140
141 public static List<Address> getAddresses(ActionRequest actionRequest) {
142 return getUsersAdmin().getAddresses(actionRequest);
143 }
144
145 public static List<Address> getAddresses(
146 ActionRequest actionRequest, List<Address> defaultAddresses) {
147
148 return getUsersAdmin().getAddresses(actionRequest, defaultAddresses);
149 }
150
151 public static List<EmailAddress> getEmailAddresses(
152 ActionRequest actionRequest) {
153
154 return getUsersAdmin().getEmailAddresses(actionRequest);
155 }
156
157 public static List<EmailAddress> getEmailAddresses(
158 ActionRequest actionRequest, List<EmailAddress> defaultEmailAddresses) {
159
160 return getUsersAdmin().getEmailAddresses(
161 actionRequest, defaultEmailAddresses);
162 }
163
164 public static OrderByComparator<Group> getGroupOrderByComparator(
165 String orderByCol, String orderByType) {
166
167 return getUsersAdmin().getGroupOrderByComparator(
168 orderByCol, orderByType);
169 }
170
171 public static Long[] getOrganizationIds(List<Organization> organizations) {
172 return getUsersAdmin().getOrganizationIds(organizations);
173 }
174
175 public static OrderByComparator<Organization>
176 getOrganizationOrderByComparator(
177 String orderByCol, String orderByType) {
178
179 return getUsersAdmin().getOrganizationOrderByComparator(
180 orderByCol, orderByType);
181 }
182
183 public static List<Organization> getOrganizations(Hits hits)
184 throws PortalException {
185
186 return getUsersAdmin().getOrganizations(hits);
187 }
188
189 public static List<OrgLabor> getOrgLabors(ActionRequest actionRequest) {
190 return getUsersAdmin().getOrgLabors(actionRequest);
191 }
192
193 public static List<Phone> getPhones(ActionRequest actionRequest) {
194 return getUsersAdmin().getPhones(actionRequest);
195 }
196
197 public static List<Phone> getPhones(
198 ActionRequest actionRequest, List<Phone> defaultPhones) {
199
200 return getUsersAdmin().getPhones(actionRequest, defaultPhones);
201 }
202
203 public static OrderByComparator<Role> getRoleOrderByComparator(
204 String orderByCol, String orderByType) {
205
206 return getUsersAdmin().getRoleOrderByComparator(
207 orderByCol, orderByType);
208 }
209
210 public static OrderByComparator<UserGroup> getUserGroupOrderByComparator(
211 String orderByCol, String orderByType) {
212
213 return getUsersAdmin().getUserGroupOrderByComparator(
214 orderByCol, orderByType);
215 }
216
217 public static List<UserGroupRole> getUserGroupRoles(
218 PortletRequest portletRequest)
219 throws PortalException {
220
221 return getUsersAdmin().getUserGroupRoles(portletRequest);
222 }
223
224 public static List<UserGroup> getUserGroups(Hits hits)
225 throws PortalException {
226
227 return getUsersAdmin().getUserGroups(hits);
228 }
229
230 public static OrderByComparator<User> getUserOrderByComparator(
231 String orderByCol, String orderByType) {
232
233 return getUsersAdmin().getUserOrderByComparator(
234 orderByCol, orderByType);
235 }
236
237 public static List<User> getUsers(Hits hits) throws PortalException {
238 return getUsersAdmin().getUsers(hits);
239 }
240
241 public static UsersAdmin getUsersAdmin() {
242 PortalRuntimePermission.checkGetBeanProperty(UsersAdminUtil.class);
243
244 return _usersAdmin;
245 }
246
247 public static List<Website> getWebsites(ActionRequest actionRequest) {
248 return getUsersAdmin().getWebsites(actionRequest);
249 }
250
251 public static List<Website> getWebsites(
252 ActionRequest actionRequest, List<Website> defaultWebsites) {
253
254 return getUsersAdmin().getWebsites(actionRequest, defaultWebsites);
255 }
256
257
262 @Deprecated
263 public static boolean hasUpdateEmailAddress(
264 PermissionChecker permissionChecker, User user)
265 throws PortalException {
266
267 return getUsersAdmin().hasUpdateEmailAddress(permissionChecker, user);
268 }
269
270 public static boolean hasUpdateFieldPermission(
271 PermissionChecker permissionChecker, User updatingUser,
272 User updatedUser, String field)
273 throws PortalException {
274
275 return getUsersAdmin().hasUpdateFieldPermission(
276 permissionChecker, updatingUser, updatedUser, field);
277 }
278
279
284 @Deprecated
285 public static boolean hasUpdateFieldPermission(User user, String field)
286 throws PortalException {
287
288 return getUsersAdmin().hasUpdateFieldPermission(user, field);
289 }
290
291
296 @Deprecated
297 public static boolean hasUpdateScreenName(
298 PermissionChecker permissionChecker, User user)
299 throws PortalException {
300
301 return getUsersAdmin().hasUpdateScreenName(permissionChecker, user);
302 }
303
304 public static long[] removeRequiredRoles(long userId, long[] roleIds)
305 throws PortalException {
306
307 return getUsersAdmin().removeRequiredRoles(userId, roleIds);
308 }
309
310 public static long[] removeRequiredRoles(User user, long[] roleIds)
311 throws PortalException {
312
313 return getUsersAdmin().removeRequiredRoles(user, roleIds);
314 }
315
316 public static void updateAddresses(
317 String className, long classPK, List<Address> addresses)
318 throws PortalException {
319
320 getUsersAdmin().updateAddresses(className, classPK, addresses);
321 }
322
323 public static void updateEmailAddresses(
324 String className, long classPK, List<EmailAddress> emailAddresses)
325 throws PortalException {
326
327 getUsersAdmin().updateEmailAddresses(
328 className, classPK, emailAddresses);
329 }
330
331 public static void updateOrgLabors(long classPK, List<OrgLabor> orgLabors)
332 throws PortalException {
333
334 getUsersAdmin().updateOrgLabors(classPK, orgLabors);
335 }
336
337 public static void updatePhones(
338 String className, long classPK, List<Phone> phones)
339 throws PortalException {
340
341 getUsersAdmin().updatePhones(className, classPK, phones);
342 }
343
344 public static void updateWebsites(
345 String className, long classPK, List<Website> websites)
346 throws PortalException {
347
348 getUsersAdmin().updateWebsites(className, classPK, websites);
349 }
350
351 public void setUsersAdmin(UsersAdmin usersAdmin) {
352 PortalRuntimePermission.checkSetBeanProperty(getClass());
353
354 _usersAdmin = usersAdmin;
355 }
356
357 private static UsersAdmin _usersAdmin;
358
359 }