001 /* Principal.java -- A security entity
002 Copyright (C) 1998, 2002, 2005 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package java.security;
040
041 /**
042 * This interface models an entity (such as a user or a certificate authority)
043 * for the purposes of applying the Java security model.
044 *
045 * @author Aaron M. Renn (arenn@urbanophile.com)
046 * @see X509Certificate
047 * @since 1.1
048 * @status updated to 1.4
049 */
050 public interface Principal
051 {
052 /**
053 * This method tests another <code>Principal</code> object for equality
054 * with this one.
055 *
056 * @param obj the Object to test for equality
057 * @return true if the specified <code>Principal</code> is equal
058 */
059 boolean equals(Object obj);
060
061 /**
062 * This method returns a <code>String</code> representation of this
063 * <code>Principal</code>.
064 *
065 * @return this <code>Principal</code> represented as a <code>String</code>
066 */
067 String toString();
068
069 /**
070 * This method returns a hash code value for this <code>Principal</code>.
071 * Remember the contract of hashCode - two objects which compare as
072 * equals() must have the same hashCode().
073 *
074 * @return a hash value
075 */
076 int hashCode();
077
078 /**
079 * This method returns a <code>String</code> that names this
080 * <code>Principal</code>.
081 *
082 * @return the name of this <code>Principal</code>
083 */
084 String getName();
085 } // interface Principal