Source for java.security.Principal

   1: /* Principal.java -- A security entity
   2:    Copyright (C) 1998, 2002, 2005  Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package java.security;
  40: 
  41: /**
  42:  * This interface models an entity (such as a user or a certificate authority)
  43:  * for the purposes of applying the Java security model.
  44:  *
  45:  * @author Aaron M. Renn (arenn@urbanophile.com)
  46:  * @see X509Certificate
  47:  * @since 1.1
  48:  * @status updated to 1.4
  49:  */
  50: public interface Principal
  51: {
  52:   /**
  53:    * This method tests another <code>Principal</code> object for equality
  54:    * with this one.
  55:    *
  56:    * @param obj the Object to test for equality
  57:    * @return true if the specified <code>Principal</code> is equal
  58:    */
  59:   boolean equals(Object obj);
  60: 
  61:   /**
  62:    * This method returns a <code>String</code> representation of this
  63:    * <code>Principal</code>.
  64:    *
  65:    * @return this <code>Principal</code> represented as a <code>String</code>
  66:    */
  67:   String toString();
  68: 
  69:   /**
  70:    * This method returns a hash code value for this <code>Principal</code>.
  71:    * Remember the contract of hashCode - two objects which compare as
  72:    * equals() must have the same hashCode().
  73:    *
  74:    * @return a hash value
  75:    */
  76:   int hashCode();
  77: 
  78:   /**
  79:    * This method returns a <code>String</code> that names this
  80:    * <code>Principal</code>.
  81:    *
  82:    * @return the name of this <code>Principal</code>
  83:    */
  84:   String getName();
  85: } // interface Principal