SecurityGroup.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2022 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package org.turro.security;
 
import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.io.Reader;
import java.io.Writer;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.turro.string.Strings;
import org.turro.configuration.JsonConfiguration;
import org.turro.util.Comparison;
 
public class SecurityGroup implements Comparable<SecurityGroup> {
 
  private String id, name;
  private boolean inherits;
  private SecurityGroupType type;
  private final Set<String> syndicate = new HashSet<>();
  private final Set<AllowedGroup> allowed = new HashSet<>();
  private final Set<String> roles = new HashSet<>();
  private final Set<String> tags = new HashSet<>();
 
  public String getId() {
    return id;
  }
 
  public void setId(String id) {
    this.id = id;
  }
 
  public String getName() {
    return name;
  }
 
  public void setName(String name) {
    this.name = name;
  }
 
  public boolean isInherits() {
    return inherits;
  }
 
  public void setInherits(boolean inherits) {
    this.inherits = inherits;
  }
 
  public SecurityGroupType getType() {
    return type == null ? SecurityGroupType.SG_EXTERNAL : type;
  }
 
  public void setType(SecurityGroupType type) {
    this.type = type;
  }
 
  public Set<String> getSyndicate() {
    return syndicate;
  }
 
  public Set<AllowedGroup> getAllowed() {
    return allowed;
  }
 
  public Set<String> getRoles() {
    return roles;
  }
 
  public Set<String> getTags() {
    return tags;
  }
 
  /* Configuration */
  
  private void prepareSaving() {
    getSyndicate().removeIf(s -> Strings.isBlank(s));
    getAllowed().removeIf(a -> Strings.isBlank(a.getId()));
  }
 
  public static SecurityGroup loadFrom(File file) {
    try(Reader reader = new FileReader(file)) {
      return JsonConfiguration.read(reader, SecurityGroup.class);
    } catch (IOException ex) {
      Logger.getLogger(SecurityGroup.class.getName()).log(Level.SEVERE, null, ex);
      return null;
    }
  }
  
  public static void saveTo(File file, SecurityGroup socialGroup) {
    try(Writer writer = new FileWriter(file)) {
      socialGroup.prepareSaving();
      JsonConfiguration.write(writer, socialGroup);
    } catch (IOException ex) {
      Logger.getLogger(SecurityGroup.class.getName()).log(Level.SEVERE, null, ex);
    }
  }
  
  /* Standards */
 
  public static final String
    ACCOUNT_AUXILIAR="account_auxiliar",
    ADMIN_AUXILIAR="admin_auxiliar",
    ADMINISTRATION="administration",
    ATTACH_ADMIN="attach_admin",
    BRIGHTSIDE_ADMIN="brightside_admin",
    CLUSTER="cluster",
    COLLABORATOR="collaborator",
    COLLABORATOR_PRIVILEGED="collaborator_privileged",
    COMERCIAL="comercial",
    COMERCIAL_DIR_ASSISTANT="comercial_dir_assistant",
    COMERCIAL_DIRECTION="comercial_direction",
    COMPUTER_MANAGER="computer_manager",
    CONTACTS_ADMIN="contacts_admin",
    CONTENT_ADMIN="content_admin",
    CONSULTANT="consultant",
    COUNSELOR="counselor",
    CUSTOMER="customer",
    CUSTOMER_PRIVILEGED="customer_privileged",
    DIRECTION="direction",
    DIRECTION_ASSISTANT="direction_assistant",
    DIRECTORY="directory",
    DOSSIER_ADMIN="dossier_admin",
    EMPLOYEE="employee",
    EVENT_ASSISTANT="event_assistant",
    FINANCIALS_ADMIN="financials_admin",
    GROUPCOMPANY="groupcompany",
    GUEST="guest",
    INVESTOR="investor",
    HUB="hub",
    HUB_SUPPORT="hub-support",
    MANAGER="manager",
    MARKETING="marketing",
    MARKETPLACE="marketplace",
    OPERATOR="operator",
    PARTNER="partner",
    PATRON="patron",
    PROVIDER="provider",
    PROVIDER_PRIVILEGED="provider_privileged",
    RESEARCHER="researcher",
    STUDENT_ADMIN="student_admin",
    TECHPARTNER="techpartner",
    TESTIMONIAL="testimonial",
    WEB_ADMIN="web_admin";
 
  /* Comparable */
 
  @Override
  public int compareTo(SecurityGroup o) {
    return Comparison.ascendant().compare(id, o.id).get();
  }
  
  /* Utils */
  
  @Override
  public int hashCode() {
    int hash = 5;
    hash = 37 * hash + Objects.hashCode(this.id);
    return hash;
  }
 
  @Override
  public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return false;
    }
    if (getClass() != obj.getClass()) {
      return false;
    }
    final SecurityGroup other = (SecurityGroup) obj;
    return Objects.equals(this.id, other.id);
  }
 
}