User.java

/*******************************************************************************
 * Copyright 2013
 * Ubiquitous Knowledge Processing (UKP) Lab
 * Technische Universität Darmstadt
 * 
 * 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 de.tudarmstadt.ukp.csniper.webapp.security.model;

import java.io.Serializable;
import java.util.HashSet;
import java.util.Set;

import javax.annotation.Resource;
import javax.persistence.CollectionTable;
import javax.persistence.Column;
import javax.persistence.ElementCollection;
import javax.persistence.Entity;
import javax.persistence.EnumType;
import javax.persistence.Enumerated;
import javax.persistence.FetchType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.Table;
import javax.persistence.Transient;

import org.springframework.context.ApplicationContext;
import org.springframework.security.crypto.password.PasswordEncoder;

import de.tudarmstadt.ukp.csniper.webapp.support.spring.ApplicationContextProvider;

/**
 * User entity corresponding to the Spring standard schema. Conformance to this schema is the reason
 * why a plural is used for the table name.
 * 
 * @author Richard Eckart de Castilho
 * @see <a
 *      href="http://static.springsource.org/spring-security/site/docs/3.0.x/reference/appendix-schema.html">Spring
 *      standard schema</a>
 */
@Entity
@Table(name = "users")
public class User
	implements Serializable
{
	private static final long serialVersionUID = -5668208834434334005L;

	@Resource(name = "passwordEncoder")
	@Transient
	private transient PasswordEncoder passwordEncoder;

	@Id
	@Column(nullable = false, length = 150)
	private String username;

	@Column(nullable = false)
	private String password;

	@Column(nullable = true)
	private String email;

	@Column(nullable = false)
	private boolean enabled = true;

	@ElementCollection(fetch = FetchType.EAGER)
	@CollectionTable(name = "authorities", joinColumns = { @JoinColumn(name = "username", referencedColumnName = "username") })
	@Column(nullable = true, name = "authority")
	@Enumerated(EnumType.STRING)
	private Set<Role> roles = new HashSet<Role>();

	private String encodePassword(String aPassword)
	{
		if (passwordEncoder == null) {
			ApplicationContext context = ApplicationContextProvider.getApplicationContext();
			passwordEncoder = context.getBean("passwordEncoder", PasswordEncoder.class);
		}
		return passwordEncoder.encode(aPassword);
	}

	public String getUsername()
	{
		return username;
	}

	public void setUsername(String aLogin)
	{
		username = aLogin;
	}

	public String getPassword()
	{
		return password;
	}

	public void setPassword(String aPassword)
	{
		password = encodePassword(aPassword);
	}

	public String getEmail()
	{
		return email;
	}

	public void setEmail(String aEmail)
	{
		email = aEmail;
	}

	public boolean isEnabled()
	{
		return enabled;
	}

	public void setEnabled(boolean aEnabled)
	{
		enabled = aEnabled;
	}

	public Set<Role> getRoles()
	{
		return roles;
	}

	public void setRoles(Set<Role> aRoles)
	{
		roles = aRoles;
	}

	@Override
	public int hashCode()
	{
		final int prime = 31;
		int result = 1;
		result = prime * result + ((username == null) ? 0 : username.hashCode());
		return result;
	}

	@Override
	public boolean equals(Object obj)
	{
		if (this == obj) {
			return true;
		}
		if (obj == null) {
			return false;
		}
		if (getClass() != obj.getClass()) {
			return false;
		}
		User other = (User) obj;
		if (username == null) {
			if (other.username != null) {
				return false;
			}
		}
		else if (!username.equals(other.username)) {
			return false;
		}
		return true;
	}

	@Override
	public String toString()
	{
		return "User [username=" + username + ", password=" + password + ", email=" + email
				+ ", enabled=" + enabled + ", roles=" + roles + "]";
	}
}