org.labkey.remoteapi.security.GetUsersCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of labkey-client-api Show documentation

The client-side library for Java developers is a separate JAR from the LabKey Server code base. It can be used by any Java program, including another Java web application.

There is a newer version: 6.2.0

Show newest version

/*
 * Copyright (c) 2010-2018 LabKey Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.labkey.remoteapi.security;

import org.json.JSONObject;
import org.labkey.remoteapi.Command;

import java.util.HashMap;
import java.util.Map;

/**
 * Returns a list of users given selection criteria. This may be called by any logged-in user.
 */
public class GetUsersCommand extends Command
{
    private int _groupId = -1;
    private String _name;
    private String _group;
    private Boolean _includeDeactivated;

    public GetUsersCommand()
    {
        super("user", "getUsers");
    }

    /** @return the id of a project group for which you want the members */
    public int getGroupId()
    {
        return _groupId;
    }

    /** @param groupId the id of a project group for which you want the members (specify groupId or group, not both). */
    public void setGroupId(int groupId)
    {
        if (_group != null)
        {
            throw new IllegalStateException("Group and GroupId should not both be specified");
        }
        _groupId = groupId;
    }

    /** @return the name of a project group for which you want the members */
    public String getGroup()
    {
        return _group;
    }

    /** @param group the name of a project group for which you want the members (specify groupId or group, not both). */
    public void setGroup(String group)
    {
        if (_groupId != -1)
        {
            throw new IllegalStateException("Group and GroupId should not both be specified");
        }
        _group = group;
    }

    /** @return the first part of the user name, useful for user name completion */
    public String getName()
    {
        return _name;
    }

    /**
     * @param name The first part of the user name, useful for user name completion. If specified, only users whose
     * email address or display name starts with the value supplied will be returned.
     */
    public void setName(String name)
    {
        _name = name;
    }

    /**
     * @return Flag to request Active user accounts only
     */
    public Boolean includeDeactivated()
    {
        return _includeDeactivated;
    }

    public void setIncludeDeactivated(Boolean active)
    {
        _includeDeactivated = active;
    }

    @Override
    public Map getParameters()
    {
        Map params = new HashMap<>();
        if (_group != null)
        {
            params.put("group", _group);
        }
        if (_groupId != -1)
        {
            params.put("groupId", _groupId);
        }
        if (_name != null)
        {
            params.put("name", _name);
        }
        if (_includeDeactivated != null)
        {
            params.put("active", !includeDeactivated());
        }
        return params;
    }

    @Override
    protected GetUsersResponse createResponse(String text, int status, String contentType, JSONObject json)
    {
        return new GetUsersResponse(text, status, contentType, json, this);
    }
}