01 /*
02 * Copyright 1996-1998 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package java.security;
27
28 /**
29 * This interface represents the abstract notion of a principal, which
30 * can be used to represent any entity, such as an individual, a
31 * corporation, and a login id.
32 *
33 * @see java.security.cert.X509Certificate
34 *
35 * @version 1.29, 07/05/05
36 * @author Li Gong
37 */
38 public interface Principal {
39
40 /**
41 * Compares this principal to the specified object. Returns true
42 * if the object passed in matches the principal represented by
43 * the implementation of this interface.
44 *
45 * @param another principal to compare with.
46 *
47 * @return true if the principal passed in is the same as that
48 * encapsulated by this principal, and false otherwise.
49
50 */
51 public boolean equals(Object another);
52
53 /**
54 * Returns a string representation of this principal.
55 *
56 * @return a string representation of this principal.
57 */
58 public String toString();
59
60 /**
61 * Returns a hashcode for this principal.
62 *
63 * @return a hashcode for this principal.
64 */
65 public int hashCode();
66
67 /**
68 * Returns the name of this principal.
69 *
70 * @return the name of this principal.
71 */
72 public String getName();
73 }
|