Skip to content
GitLab
Switch branch/tag
Find file BlameHistoryPermalink
UserApi.java 54.31 KiB
Open in Web IDE
1 
package org.gitlab4j.api;
2
3 
import java.io.File;
4 
import java.util.Date;
5 
import java.util.List;
6 
import java.util.Objects;
7 
import java.util.Optional;
8 
import java.util.stream.Stream;
9
10 
import javax.ws.rs.core.Form;
11 
import javax.ws.rs.core.GenericType;
12 
import javax.ws.rs.core.Response;
13
14 
import org.gitlab4j.api.GitLabApi.ApiVersion;
15 
import org.gitlab4j.api.models.CustomAttribute;
16 
import org.gitlab4j.api.models.Email;
17 
import org.gitlab4j.api.models.GpgKey;
18 
import org.gitlab4j.api.models.ImpersonationToken;
19 
import org.gitlab4j.api.models.ImpersonationToken.Scope;
20 
import org.gitlab4j.api.models.SshKey;
21 
import org.gitlab4j.api.models.User;
22 
import org.gitlab4j.api.utils.EmailChecker;
23
24 
/**
25 
 * This class provides an entry point to all the GitLab API users calls.
26 
 *
27 
 * @see <a href="https://docs.gitlab.com/ce/api/users.html">Users API at GitLab</a>
28 
 */
29 
public class UserApi extends AbstractApi {
30
31 
    private boolean customAttributesEnabled = false;
32
33 
    public UserApi(GitLabApi gitLabApi) {
34 
        super(gitLabApi);
35 
    }
36
37 
    /**
38 
     * Enables custom attributes to be returned when fetching User instances.
39 
     */
40 
    public void enableCustomAttributes() {
41 
        customAttributesEnabled = true;
42 
    }
43
44 
    /**
45 
     * Disables custom attributes to be returned when fetching User instances.
46 
     */
47 
    public void disableCustomAttributes() {
48 
        customAttributesEnabled = false;
49 
    }
50
51 
    /**
52 
     * <p>Get a list of users.</p>
53 
     *
54 
     * <strong>WARNING:</strong> Do not use this method to fetch users from https://gitlab.com,
55 
     * gitlab.com has many 1,000,000's of users and it will a long time to fetch all of them.
56 
     * Instead use {@link #getUsers(int itemsPerPage)} which will return a Pager of Group instances.
57 
     *
58 
     * <pre><code>GitLab Endpoint: GET /users</code></pre>
59 
     *
60 
     * @return a list of Users
61 
     * @throws GitLabApiException if any exception occurs
62 
     */
63 
    public List<User> getUsers() throws GitLabApiException {
64
65 
        String url = this.gitLabApi.getGitLabServerUrl();
66 
        if (url.startsWith("https://gitlab.com")) {
67 
            GitLabApi.getLogger().warning("Fetching all users from " + url +
68 
                    " may take many minutes to complete, use Pager<User> getUsers(int) instead.");
69 
        }
70
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
return (getUsers(getDefaultPerPage()).all()); } /** * Get a list of users using the specified page and per page settings. * * <pre><code>GitLab Endpoint: GET /users</code></pre> * * @param page the page to get * @param perPage the number of users per page * @return the list of Users in the specified range * @throws GitLabApiException if any exception occurs */ public List<User> getUsers(int page, int perPage) throws GitLabApiException { Response response = get(Response.Status.OK, getPageQueryParams(page, perPage, customAttributesEnabled), "users"); return (response.readEntity(new GenericType<List<User>>() {})); } /** * Get a Pager of users. * * <pre><code>GitLab Endpoint: GET /users</code></pre> * * @param itemsPerPage the number of User instances that will be fetched per page * @return a Pager of User * @throws GitLabApiException if any exception occurs */ public Pager<User> getUsers(int itemsPerPage) throws GitLabApiException { return (new Pager<User>(this, User.class, itemsPerPage, createGitLabApiForm().asMap(), "users")); } /** * Get a Stream of users. * * <pre><code>GitLab Endpoint: GET /users</code></pre> * * @return a Stream of Users. * @throws GitLabApiException if any exception occurs */ public Stream<User> getUsersStream() throws GitLabApiException { return (getUsers(getDefaultPerPage()).stream()); } /** * Get a list of active users * * <pre><code>GitLab Endpoint: GET /users?active=true</code></pre> * * @return a list of active Users * @throws GitLabApiException if any exception occurs */ public List<User> getActiveUsers() throws GitLabApiException { return (getActiveUsers(getDefaultPerPage()).all()); } /** * Get a list of active users using the specified page and per page settings. * * <pre><code>GitLab Endpoint: GET /users?active=true</code></pre> * * @param page the page to get * @param perPage the number of users per page * @return the list of active Users in the specified range * @throws GitLabApiException if any exception occurs */ public List<User> getActiveUsers(int page, int perPage) throws GitLabApiException { GitLabApiForm formData = createGitLabApiForm() .withParam("active", true) .withParam(PAGE_PARAM, page) .withParam(PER_PAGE_PARAM, perPage);