com.foreach.across.modules.user.business.Group Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of user-module Show documentation
User Module
There is a newer version: 6.0.0
/*
 * Copyright 2014 the original author or authors
 *
 * 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.foreach.across.modules.user.business;

import com.foreach.across.modules.user.config.UserSchemaConfiguration;
import org.apache.commons.lang3.StringUtils;
import org.hibernate.validator.constraints.NotBlank;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.security.core.authority.SimpleGrantedAuthority;

import javax.annotation.concurrent.NotThreadSafe;
import javax.persistence.Column;
import javax.persistence.DiscriminatorValue;
import javax.persistence.Entity;
import javax.persistence.Table;
import javax.validation.constraints.Size;

@NotThreadSafe
@Entity
@DiscriminatorValue("group")
@Table(name = UserSchemaConfiguration.TABLE_GROUP)
public class Group extends BasicSecurityPrincipal implements Comparable
{
	public static final String AUTHORITY_PREFIX = "GROUP_";

	@NotBlank
	@Size(max = 255)
	@Column(name = "name")
	private String name;

	public Group() {
	}

	public Group( String name ) {
		setName( name );
	}

	public String getName() {
		return name;
	}

	public void setName( String name ) {
		this.name = name;
		setPrincipalName( "group:" + name );
	}

	/**
	 * Represents this group as a {@link GrantedAuthority} to be added.
	 *
	 * @return authority for the group
	 */
	public GrantedAuthority asGrantedAuthority() {
		return StringUtils.isBlank( getName() )  ? null : new SimpleGrantedAuthority( authorityString( getName() ) );
	}

	@Override
	public int compareTo( Group other ) {
		return StringUtils.defaultString( getName() ).compareTo( StringUtils.defaultString( other.getName() ) );
	}

	/**
	 * Generate the authority string for a group, applies the prefix if is not yet present.
	 *
	 * @param group name of the group
	 * @return authority string
	 */
	public static String authorityString( String group ) {
		return StringUtils.isBlank( group ) ? null
				: AUTHORITY_PREFIX + StringUtils.removeStartIgnoreCase( group, AUTHORITY_PREFIX );
	}
}