/**
* jira-client - a simple JIRA REST client
* Copyright (c) 2013 Bob Carroll (bob.carroll@alum.rit.edu)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
package net.rcarz.jiraclient;
import net.sf.json.JSON;
import net.sf.json.JSONObject;
import java.util.HashMap;
import java.util.Map;
/**
* Represents a JIRA user.
*/
public class User extends Resource {
private boolean active = false;
private Map<String, String> avatarUrls = null;
private String displayName = null;
private String email = null;
private String name = null;
/**
* Creates a user from a JSON payload.
*
* @param restclient REST client instance
* @param json JSON payload
*/
protected User(RestClient restclient, JSONObject json) {
super(restclient);
if (json != null)
deserialise(json);
}
/**
* Retrieves the given user record.
*
* @param restclient REST client instance
* @param username User logon name
* @return a user instance
* @throws JiraException when the retrieval fails
*/
public static User get(RestClient restclient, String username)
throws JiraException {
JSON result = null;
Map<String, String> params = new HashMap<String, String>();
params.put("username", username);
try {
result = restclient.get(getBaseUri() + "user", params);
} catch (Exception ex) {
throw new JiraException("Failed to retrieve user " + username, ex);
}
if (!(result instanceof JSONObject))
throw new JiraException("JSON payload is malformed");
return new User(restclient, (JSONObject) result);
}
private void deserialise(JSONObject json) {
Map map = json;
self = Field.getString(map.get("self"));
id = Field.getString(map.get("id"));
active = Field.getBoolean(map.get("active"));
avatarUrls = Field.getMap(String.class, String.class, map.get("avatarUrls"));
displayName = Field.getString(map.get("displayName"));
email = getEmailFromMap(map);
name = Field.getString(map.get("name"));
}
/**
* API changes email address might be represented as either "email" or "emailAddress"
*
* @param map JSON object for the User
* @return String email address of the JIRA user.
*/
private String getEmailFromMap(Map map) {
if (map.containsKey("email")) {
return Field.getString(map.get("email"));
} else {
return Field.getString(map.get("emailAddress"));
}
}
@Override
public String toString() {
return getName();
}
public boolean isActive() {
return active;
}
public Map<String, String> getAvatarUrls() {
return avatarUrls;
}
public String getDisplayName() {
return displayName;
}
public String getEmail() {
return email;
}
public String getName() {
return name;
}
}