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