services/self-service/src/main/java/com/epam/dlab/backendapi/roles/UserRole.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.epam.dlab.backendapi.roles;

import com.google.common.base.MoreObjects;
import com.google.common.base.MoreObjects.ToStringHelper;

import javax.annotation.Nonnull;
import java.util.Comparator;
import java.util.Objects;
import java.util.Set;

/**
 * Describe role.
 */
public class UserRole implements Comparable<UserRole> {

	private final String id;
	/**
	 * Type of role.
	 */
	private final RoleType type;

	/**
	 * Name of role.
	 */
	private final String name;

	/**
	 * Names of external groups.
	 */
	private final Set<String> groups;

	/**
	 * Name of DLab's users.
	 */
	private final Set<String> users;

	/**
	 * Instantiate the role.
	 *
	 * @param id
	 * @param type   type of role.
	 * @param name   the name of role.
	 * @param groups the names of external groups.
	 * @param users  the name of DLab's users.
	 */
	UserRole(String id, RoleType type, String name, Set<String> groups, Set<String> users) {
		this.id = id;
		this.type = type;
		this.name = name;
		this.groups = groups;
		this.users = users;
	}

	/**
	 * Return the type of role.
	 */
	public RoleType getType() {
		return type;
	}

	/**
	 * Return the name of role.
	 */
	public String getName() {
		return name;
	}

	/**
	 * Return the names of external groups.
	 */
	public Set<String> getGroups() {
		return groups;
	}

	/**
	 * Return the name of DLab's users.
	 */
	public Set<String> getUsers() {
		return users;
	}

	public String getId() {
		return id;
	}

	@Override
	public int compareTo(@Nonnull UserRole o) {
		return Comparator.comparing(UserRole::getType)
				.thenComparing(UserRole::getName)
				.thenComparing(UserRole::getId, Comparator.nullsLast(String::compareToIgnoreCase))
				.compare(this, o);
	}

	private ToStringHelper toStringHelper(Object self) {
		return MoreObjects.toStringHelper(self)
				.add("type", type)
				.add("name", name)
				.add("groups", groups)
				.add("users", users);
	}

	@Override
	public boolean equals(Object o) {
		if (this == o) return true;
		if (o == null || getClass() != o.getClass()) return false;
		UserRole userRole = (UserRole) o;
		return this.id.equals(userRole.getId()) && this.type.equals(userRole.getType()) && this.name.equals(userRole.getName());
	}

	@Override
	public int hashCode() {
		return Objects.hash(type, name);
	}

	@Override
	public String toString() {
		return toStringHelper(this).toString();
	}
}