UserRole.java

/*
 * Copyright 2020 Global Crop Diversity Trust
 *
 * 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.gringlobal.model.security;

import org.springframework.security.core.GrantedAuthority;

/**
 * System-wide user roles.
 */
public enum UserRole implements GrantedAuthority {

	/** The user. */
	USER("User"),
	/** The web user. */
	WEBUSER("Web user"),
	/** The administrator. */
	ADMINISTRATOR("Administrator"),
	/** Everyone role. */
	EVERYONE("Everyone");

	/** The label. */
	String label;

	/**
	 * Instantiates a new user role.
	 *
	 * @param label the label
	 */
	UserRole(String label) {
		this.label = label;
	}

	/**
	 * Gets the label.
	 *
	 * @return the label
	 */
	public String getLabel() {
		return label;
	}

	/**
	 * Gets the by label.
	 *
	 * @param value the value
	 * @return the by label
	 */
	public static UserRole getByLabel(String value) {
		for (final UserRole userRole : values()) {
			if (userRole.label.equals(value)) {
				return userRole;
			}
		}
		throw new IllegalArgumentException(value);
	}

	/**
	 * Gets the name.
	 *
	 * @return the name
	 */
	public String getName() {
		return name();
	}

	/**
	 * Gets the authority.
	 *
	 * @return the authority
	 */
	@Override
	public String getAuthority() {
		return "ROLE_" + getName();
	}
}