org.jboss.remoting3.security.UserPrincipal Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source.
* Copyright 2011, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.remoting3.security;
import java.security.Principal;
/**
* A principal representing an authenticated user.
*
* @author David M. Lloyd
*/
public final class UserPrincipal implements Principal {
private final String name;
/**
* Construct a new instance.
*
* @param name the name of the user
*/
public UserPrincipal(final String name) {
if (name == null) {
throw new IllegalArgumentException("name is null");
}
this.name = name;
}
/**
* Get the name of this principal.
*
* @return the name
*/
public String getName() {
return name;
}
/**
* Get the hash code.
*
* @return the hash code
*/
public int hashCode() {
return name.hashCode();
}
/**
* Determine whether this object is equal to another.
*
* @param other the other object
* @return {@code true} if they are equal, {@code false} otherwise
*/
public boolean equals(Object other) {
return other instanceof UserPrincipal && equals((UserPrincipal)other);
}
/**
* Determine whether this object is equal to another.
*
* @param other the other object
* @return {@code true} if they are equal, {@code false} otherwise
*/
public boolean equals(UserPrincipal other) {
return this == other || other != null && name.equals(other.name);
}
}