com.centurylink.mdw.model.user.Workgroup Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2017 CenturyLink, Inc.
 *
 * 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 com.centurylink.mdw.model.user;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;

import com.centurylink.mdw.model.Jsonable;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

@ApiModel(value="Workgroup", description="MDW user workgroup")
public class Workgroup implements Serializable, Comparable, Jsonable {

    public static final String SLACK_CHANNELS = "Slack Channel(s)";

    /**
     * Site admin group is the parent/ancester group for all other groups.
     * If a group has parent null, the site admin group is considered to be its parent.
     */
    public static final String SITE_ADMIN_GROUP = "Site Admin";
    /**
     * Shared group is a virtual group (not really persisted in database) that
     * everyone belongs to. This is specifically useful for backward compatibility,
     * where resources with no association of groups are assumed to belong to this group.
     */
    public static final String COMMON_GROUP = "Common";
    public static final Long COMMON_GROUP_ID = 0L;
    public static final Workgroup getCommonGroup() {
        return new Workgroup(COMMON_GROUP_ID, Workgroup.COMMON_GROUP, null);
    }

    public Workgroup() {
    }

    public Workgroup(Long id, String name, String comment) {
        this.id = id;
        this.name = name;
        this.description = comment;
    }

    public Workgroup(JSONObject json) throws JSONException {
        name = json.getString("name");
        if (json.has("description"))
            description = json.getString("description");
        if (json.has("parent"))
            parentGroup = json.getString("parent");
        if (json.has("attributes")) {
            JSONObject attrs = json.getJSONObject("attributes");
            attributes = new HashMap();
            String[] attrNames = JSONObject.getNames(attrs);
            if (attrNames != null) {
                for (int i = 0; i < attrNames.length; i++) {
                    attributes.put(attrNames[i], attrs.getString(attrNames[i]));
                }
            }
        }
        if (json.has("users")) {
            JSONArray usrs = json.getJSONArray("users");
            users = new User[usrs.length()];
            for (int i = 0; i < usrs.length(); i++) {
                Object usr = usrs.get(i);
                if (usr instanceof String) {
                    users[i] = new User();
                    users[i].setCuid((String)usr);
                }
                else if (usr instanceof JSONObject) {
                    users[i] = new User((JSONObject)usr);
                }
            }
        }
        else {
            users = new User[0];
        }
    }

    private Long id;
    @ApiModelProperty(hidden=true)
    public Long getId() { return id; }
    public void setId(Long id) { this.id = id;}

    private String name;
    @ApiModelProperty(value="Workgroup unique name", required=true)
    public String getName() { return name; }
    public void setName(String groupName) { this.name = groupName; }

    private String description;
    public String getDescription() { return description; }
    public void setDescription(String description) { this.description = description; }

    private List roles; // populated when the group is a member of UserVO
    @ApiModelProperty(hidden=true)
    public void setRoles(List roles) { this.roles = roles; }
    public List getRoles() { return roles; }

    private User[] users;
    public User[] getUsers() { return users; }
    public void setUsers(User[] users) { this.users = users; }

    @ApiModelProperty(hidden=true)
    public String[] getUserCuids() {
        if (users == null)
            return new String[0];
        List userList = new ArrayList();
        for (User user : users) {
            userList.add(user.getCuid());
        }
        return userList.toArray(new String[0]);
    }

    private String parentGroup;
    public String getParentGroup() { return parentGroup; }
    public void setParentGroup(String parentGroup) { this.parentGroup = parentGroup; }

    private String endDate;
    public String getEndDate() { return endDate; }
    public void setEndDate(String endDate) { this.endDate = endDate; }

    public boolean isActive() {
        return endDate == null;
    }

    /**
     * Check whether the group has the specified role.
     */
    public boolean hasRole(String roleName){
        if (roles != null) {
            for (String r : roles) {
                if (r.equals(roleName))
                    return true;
            }
        }
        return false;
    }

    @ApiModelProperty(hidden=true)
    public String getNameAndRolesAsString() {
         StringBuffer buffer = new StringBuffer();
         buffer.append(name);
         if (roles!=null&&roles.size()>0) {
             buffer.append(':');
             for (int i=0; i0) buffer.append('/');
                 buffer.append(roles.get(i));
             }
         }
         return buffer.toString();
    }

    private Map attributes;
    public Map getAttributes() { return attributes; }
    @ApiModelProperty(value="Workgroup attributes, such as group email and slack channel")
    public void setAttributes(Map attributes) { this.attributes = attributes; }
    public String getAttribute(String name) {
      if (attributes == null)
        return null;
      return attributes.get(name);
    }
    public void setAttribute(String name, String value) {
      if (attributes == null)
        attributes = new HashMap();
      attributes.put(name, value);
    }

    public String toString() {
        StringBuffer buffer = new StringBuffer();
        buffer.append("UserGroupVO[");
        buffer.append("groupId = ").append(id);
        buffer.append(" groupName = ").append(name);
        buffer.append(" comment = ").append(description);
        if (users == null) {
            buffer.append(" users = ").append("null");
        }
        else {
            buffer.append(" users = ").append(Arrays.asList(users).toString());
        }
        buffer.append("]");
        return buffer.toString();
    }

    public JSONObject getJson() throws JSONException {
        JSONObject json = create();
        json.put("name", name);
        if (parentGroup != null)
            json.put("parent", parentGroup);
        if (description != null)
            json.put("description", description);
        if (users != null) {
            JSONArray usersJson = new JSONArray();
            for (User user : users) {
                usersJson.put(user.getJson());
            }
            json.put("users", usersJson);
        }
        if (attributes != null) {
            JSONObject attrsJson = create();
            for (String attr : attributes.keySet()) {
                String value = attributes.get(attr);
                attrsJson.put(attr, value == null ? "" : value);
            }
            json.put("attributes", attrsJson);
        }
        return json;
    }

    public int compareTo(Workgroup other) {
        if (this.name == null)
            return 0;
        else
            return this.name.compareToIgnoreCase(other.getName());
    }

    public boolean equals(Object o) {
        if (!(o instanceof Workgroup))
            return false;
        return getId().equals(((Workgroup)o).getId());
    }

    public String getJsonName() { return "Group"; }

    @ApiModelProperty(hidden=true)
    public String getSlackChannels() {
        String chennel = getAttribute(SLACK_CHANNELS);
        return chennel;
    }
    public void setSlackChannels(String s) {
        setAttribute(SLACK_CHANNELS, s);
    }
}