001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portlet.usersadmin.util;
016    
017    import com.liferay.portal.kernel.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.search.Hits;
020    import com.liferay.portal.kernel.security.pacl.permission.PortalRuntimePermission;
021    import com.liferay.portal.kernel.util.Accessor;
022    import com.liferay.portal.kernel.util.OrderByComparator;
023    import com.liferay.portal.kernel.util.Tuple;
024    import com.liferay.portal.model.Address;
025    import com.liferay.portal.model.EmailAddress;
026    import com.liferay.portal.model.Group;
027    import com.liferay.portal.model.OrgLabor;
028    import com.liferay.portal.model.Organization;
029    import com.liferay.portal.model.Phone;
030    import com.liferay.portal.model.Role;
031    import com.liferay.portal.model.User;
032    import com.liferay.portal.model.UserGroup;
033    import com.liferay.portal.model.UserGroupRole;
034    import com.liferay.portal.model.Website;
035    import com.liferay.portal.security.permission.PermissionChecker;
036    
037    import java.util.List;
038    import java.util.Locale;
039    
040    import javax.portlet.ActionRequest;
041    import javax.portlet.PortletRequest;
042    import javax.portlet.RenderResponse;
043    
044    import javax.servlet.http.HttpServletRequest;
045    
046    /**
047     * @author Brian Wing Shun Chan
048     * @author Jorge Ferrer
049     * @author Julio Camarero
050     */
051    public class UsersAdminUtil {
052    
053            /**
054             * @deprecated As of 6.2.0, replaced by {@link UsersAdmin#CUSTOM_QUESTION}
055             */
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, SystemException {
069    
070                    return getUsersAdmin().addRequiredRoles(userId, roleIds);
071            }
072    
073            public static long[] addRequiredRoles(User user, long[] roleIds)
074                    throws PortalException, SystemException {
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, SystemException {
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, SystemException {
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, SystemException {
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, SystemException {
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, SystemException {
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, SystemException {
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 long[] getGroupIds(PortletRequest portletRequest)
165                    throws PortalException, SystemException {
166    
167                    return getUsersAdmin().getGroupIds(portletRequest);
168            }
169    
170            public static OrderByComparator getGroupOrderByComparator(
171                    String orderByCol, String orderByType) {
172    
173                    return getUsersAdmin().getGroupOrderByComparator(
174                            orderByCol, orderByType);
175            }
176    
177            public static Long[] getOrganizationIds(List<Organization> organizations) {
178                    return getUsersAdmin().getOrganizationIds(organizations);
179            }
180    
181            public static long[] getOrganizationIds(PortletRequest portletRequest)
182                    throws PortalException, SystemException {
183    
184                    return getUsersAdmin().getOrganizationIds(portletRequest);
185            }
186    
187            public static OrderByComparator getOrganizationOrderByComparator(
188                    String orderByCol, String orderByType) {
189    
190                    return getUsersAdmin().getOrganizationOrderByComparator(
191                            orderByCol, orderByType);
192            }
193    
194            public static Tuple getOrganizations(Hits hits)
195                    throws PortalException, SystemException {
196    
197                    return getUsersAdmin().getOrganizations(hits);
198            }
199    
200            public static List<OrgLabor> getOrgLabors(ActionRequest actionRequest) {
201                    return getUsersAdmin().getOrgLabors(actionRequest);
202            }
203    
204            public static List<Phone> getPhones(ActionRequest actionRequest) {
205                    return getUsersAdmin().getPhones(actionRequest);
206            }
207    
208            public static List<Phone> getPhones(
209                    ActionRequest actionRequest, List<Phone> defaultPhones) {
210    
211                    return getUsersAdmin().getPhones(actionRequest, defaultPhones);
212            }
213    
214            public static long[] getRoleIds(PortletRequest portletRequest)
215                    throws PortalException, SystemException {
216    
217                    return getUsersAdmin().getRoleIds(portletRequest);
218            }
219    
220            public static OrderByComparator getRoleOrderByComparator(
221                    String orderByCol, String orderByType) {
222    
223                    return getUsersAdmin().getRoleOrderByComparator(
224                            orderByCol, orderByType);
225            }
226    
227            public static <T> String getUserColumnText(
228                    Locale locale, List<T> list, Accessor<T, String> accessor, int count) {
229    
230                    return getUsersAdmin().getUserColumnText(locale, list, accessor, count);
231            }
232    
233            public static long[] getUserGroupIds(PortletRequest portletRequest)
234                    throws PortalException, SystemException {
235    
236                    return getUsersAdmin().getUserGroupIds(portletRequest);
237            }
238    
239            public static OrderByComparator getUserGroupOrderByComparator(
240                    String orderByCol, String orderByType) {
241    
242                    return getUsersAdmin().getUserGroupOrderByComparator(
243                            orderByCol, orderByType);
244            }
245    
246            public static List<UserGroupRole> getUserGroupRoles(
247                            PortletRequest portletRequest)
248                    throws PortalException, SystemException {
249    
250                    return getUsersAdmin().getUserGroupRoles(portletRequest);
251            }
252    
253            public static Tuple getUserGroups(Hits hits)
254                    throws PortalException, SystemException {
255    
256                    return getUsersAdmin().getUserGroups(hits);
257            }
258    
259            public static OrderByComparator getUserOrderByComparator(
260                    String orderByCol, String orderByType) {
261    
262                    return getUsersAdmin().getUserOrderByComparator(
263                            orderByCol, orderByType);
264            }
265    
266            public static Tuple getUsers(Hits hits)
267                    throws PortalException, SystemException {
268    
269                    return getUsersAdmin().getUsers(hits);
270            }
271    
272            public static UsersAdmin getUsersAdmin() {
273                    PortalRuntimePermission.checkGetBeanProperty(UsersAdminUtil.class);
274    
275                    return _usersAdmin;
276            }
277    
278            public static List<Website> getWebsites(ActionRequest actionRequest) {
279                    return getUsersAdmin().getWebsites(actionRequest);
280            }
281    
282            public static List<Website> getWebsites(
283                    ActionRequest actionRequest, List<Website> defaultWebsites) {
284    
285                    return getUsersAdmin().getWebsites(actionRequest, defaultWebsites);
286            }
287    
288            /**
289             * @deprecated As of 6.2.0, replaced by {@link
290             *             #hasUpdateFieldPermission(PermissionChecker, User, User,
291             *             String)}
292             */
293            public static boolean hasUpdateEmailAddress(
294                            PermissionChecker permissionChecker, User user)
295                    throws PortalException, SystemException {
296    
297                    return getUsersAdmin().hasUpdateEmailAddress(permissionChecker, user);
298            }
299    
300            public static boolean hasUpdateFieldPermission(
301                            PermissionChecker permissionChecker, User updatingUser,
302                            User updatedUser, String field)
303                    throws PortalException, SystemException {
304    
305                    return getUsersAdmin().hasUpdateFieldPermission(
306                            permissionChecker, updatingUser, updatedUser, field);
307            }
308    
309            /**
310             * @deprecated As of 6.2.0, replaced by {@link
311             *             #hasUpdateFieldPermission(PermissionChecker, User, User,
312             *             String)}
313             */
314            @Deprecated
315            public static boolean hasUpdateFieldPermission(User user, String field)
316                    throws PortalException, SystemException {
317    
318                    return getUsersAdmin().hasUpdateFieldPermission(user, field);
319            }
320    
321            /**
322             * @deprecated As of 6.2.0, replaced by {@link
323             *             #hasUpdateFieldPermission(PermissionChecker, User, User,
324             *             String)}
325             */
326            public static boolean hasUpdateScreenName(
327                            PermissionChecker permissionChecker, User user)
328                    throws PortalException, SystemException {
329    
330                    return getUsersAdmin().hasUpdateScreenName(permissionChecker, user);
331            }
332    
333            public static long[] removeRequiredRoles(long userId, long[] roleIds)
334                    throws PortalException, SystemException {
335    
336                    return getUsersAdmin().removeRequiredRoles(userId, roleIds);
337            }
338    
339            public static long[] removeRequiredRoles(User user, long[] roleIds)
340                    throws PortalException, SystemException {
341    
342                    return getUsersAdmin().removeRequiredRoles(user, roleIds);
343            }
344    
345            public static void updateAddresses(
346                            String className, long classPK, List<Address> addresses)
347                    throws PortalException, SystemException {
348    
349                    getUsersAdmin().updateAddresses(className, classPK, addresses);
350            }
351    
352            public static void updateEmailAddresses(
353                            String className, long classPK, List<EmailAddress> emailAddresses)
354                    throws PortalException, SystemException {
355    
356                    getUsersAdmin().updateEmailAddresses(
357                            className, classPK, emailAddresses);
358            }
359    
360            public static void updateOrgLabors(long classPK, List<OrgLabor> orgLabors)
361                    throws PortalException, SystemException {
362    
363                    getUsersAdmin().updateOrgLabors(classPK, orgLabors);
364            }
365    
366            public static void updatePhones(
367                            String className, long classPK, List<Phone> phones)
368                    throws PortalException, SystemException {
369    
370                    getUsersAdmin().updatePhones(className, classPK, phones);
371            }
372    
373            public static void updateWebsites(
374                            String className, long classPK, List<Website> websites)
375                    throws PortalException, SystemException {
376    
377                    getUsersAdmin().updateWebsites(className, classPK, websites);
378            }
379    
380            public void setUsersAdmin(UsersAdmin usersAdmin) {
381                    PortalRuntimePermission.checkSetBeanProperty(getClass());
382    
383                    _usersAdmin = usersAdmin;
384            }
385    
386            private static UsersAdmin _usersAdmin;
387    
388    }