org.jboss.remoting3.security.InetAddressPrincipal Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright 2010, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt 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.net.InetAddress;
import java.net.UnknownHostException;
import java.security.Principal;
/**
* A principal representing an IP address.
*/
public final class InetAddressPrincipal implements Principal, Cloneable {
private final InetAddress inetAddress;
/**
* Create a new instance.
*
* @param inetAddress the address
*/
public InetAddressPrincipal(final InetAddress inetAddress) {
if (inetAddress == null) {
throw new IllegalArgumentException("inetAddress is null");
}
try {
this.inetAddress = InetAddress.getByAddress(inetAddress.getHostAddress(), inetAddress.getAddress());
} catch (UnknownHostException e) {
throw new IllegalStateException(e);
}
}
/**
* Get the name of this principal; it will be the string representation of the IP address.
*
* @return the name of this principal
*/
public String getName() {
return inetAddress.getHostAddress();
}
/**
* Get the IP address of this principal.
*
* @return the address
*/
public InetAddress getInetAddress() {
return inetAddress;
}
/**
* Determine whether this instance is equal to another.
*
* @param other the other instance
* @return {@code true} if they are equal, {@code false} otherwise
*/
public boolean equals(final Object other) {
return other instanceof InetAddressPrincipal && equals((InetAddressPrincipal) other);
}
/**
* Determine whether this instance is equal to another.
*
* @param other the other instance
* @return {@code true} if they are equal, {@code false} otherwise
*/
public boolean equals(final InetAddressPrincipal other) {
return other != null && inetAddress.equals(other.inetAddress);
}
/**
* Get the hash code for this instance. It will be equal to the hash code of the {@code InetAddress} object herein.
*
* @return the hash code
*/
public int hashCode() {
return inetAddress.hashCode();
}
/**
* Get a human-readable representation of this principal.
*
* @return the string
*/
public String toString() {
return "InetAddressPrincipal <" + inetAddress.toString() + ">";
}
/**
* Create a clone of this instance.
*
* @return the clone
*/
public InetAddressPrincipal clone() {
try {
return (InetAddressPrincipal) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException(e);
}
}
}