KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > geronimo > security > realm > providers > GeronimoUserPrincipal


1 /**
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 package org.apache.geronimo.security.realm.providers;
18
19 import java.io.Serializable JavaDoc;
20 import java.security.Principal JavaDoc;
21
22 /**
23  * A principal that represents a user for the login modules distributed
24  * with Geronimo. Custom login modules may use this if convenient or provide
25  * their own Principal implementations -- it doesn't matter.
26  *
27  * @version $Rev: 476049 $ $Date: 2006-11-16 23:35:17 -0500 (Thu, 16 Nov 2006) $
28  */
29 public class GeronimoUserPrincipal implements Principal JavaDoc, Serializable JavaDoc, GeronimoCallerPrincipal {
30     private final String JavaDoc name;
31
32     public GeronimoUserPrincipal(String JavaDoc name) {
33         this.name = name;
34     }
35
36     /**
37      * Compares this principal to the specified object. Returns true
38      * if the object passed in is a GeronimoUserPrincipal with the
39      * same name.
40      */
41     public boolean equals(Object JavaDoc another) {
42         if (!(another instanceof GeronimoUserPrincipal)) return false;
43
44         return ((GeronimoUserPrincipal) another).name.equals(name);
45     }
46
47     /**
48      * Returns a string representation of this principal.
49      */
50     public String JavaDoc toString() {
51         return name;
52     }
53
54     /**
55      * Returns a hashcode for this principal.
56      */
57     public int hashCode() {
58         return name.hashCode();
59     }
60
61     /**
62      * Returns the name of this principal.
63      */
64     public String JavaDoc getName() {
65         return name;
66     }
67 }
68
Popular Tags