Skip to content
GitLab
Switch branch/tag
Find file BlameHistoryPermalink
UserApi.java 47.12 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.ImpersonationToken;
18 
import org.gitlab4j.api.models.ImpersonationToken.Scope;
19 
import org.gitlab4j.api.models.SshKey;
20 
import org.gitlab4j.api.models.User;
21
22 
/**
23 
 * This class provides an entry point to all the GitLab API users calls.
24 
 *
25 
 * @see <a href="https://docs.gitlab.com/ce/api/users.html">Users API at GitLab</a>
26 
 */
27 
public class UserApi extends AbstractApi {
28
29 
    private boolean customAttributesEnabled = false;
30
31 
    UserApi(GitLabApi gitLabApi) {
32 
        super(gitLabApi);
33 
    }
34
35 
    /**
36 
     * Enables custom attributes to be returned when fetching User instances.
37 
     */
38 
    public void enableCustomAttributes() {
39 
        customAttributesEnabled = true;
40 
    }
41
42 
    /**
43 
     * Disables custom attributes to be returned when fetching User instances.
44 
     */
45 
    public void disableCustomAttributes() {
46 
        customAttributesEnabled = false;
47 
    }
48
49 
    /**
50 
     * Get a list of users.
51 
     *
52 
     * <pre><code>GitLab Endpoint: GET /users</code></pre>
53 
     *
54 
     * @return a list of Users
55 
     * @throws GitLabApiException if any exception occurs
56 
     */
57 
    public List<User> getUsers() throws GitLabApiException {
58 
        return (getUsers(getDefaultPerPage()).all());
59 
    }
60
61 
    /**
62 
     * Get a list of users using the specified page and per page settings.
63 
     *
64 
     * <pre><code>GitLab Endpoint: GET /users</code></pre>
65 
     *
66 
     * @param page    the page to get
67 
     * @param perPage the number of users per page
68 
     * @return the list of Users in the specified range
69 
     * @throws GitLabApiException if any exception occurs
70 
     */
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
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); Response response = get(Response.Status.OK, formData.asMap(), "users"); return (response.readEntity(new GenericType<List<User>>() {})); } /** * Get a Pager of active users. * * <pre><code>GitLab Endpoint: GET /users?active=true</code></pre> * * @param itemsPerPage the number of active User instances that will be fetched per page * @return a Pager of active User * @throws GitLabApiException if any exception occurs */