KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > jetspeed > om > security > UserNamePrincipal


1 /*
2  * Copyright 2000-2001,2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package org.apache.jetspeed.om.security;
18
19
20 /**
21  * A Principal based on the user name.
22  *
23  * @author <a HREF="mailto:taylor@apache.org">David Sean Taylor</a>
24  * @version $Id: UserNamePrincipal.java,v 1.4 2004/02/23 03:14:12 jford Exp $
25  */
26 public class UserNamePrincipal implements java.security.Principal JavaDoc
27 {
28     private final String JavaDoc userName;
29
30     public UserNamePrincipal(String JavaDoc userName)
31     {
32         this.userName = userName;
33     }
34
35     /**
36      * Compares this principal to the specified object. Returns true
37      * if the object passed in matches the principal represented by
38      * the implementation of this interface.
39      *
40      * @param another principal to compare with.
41      *
42      * @return true if the principal passed in is the same as that
43      * encapsulated by this principal, and false otherwise.
44
45      */
46     public boolean equals(Object JavaDoc another)
47     {
48         if (!(another instanceof UserNamePrincipal))
49             return false;
50         UserNamePrincipal principal = (UserNamePrincipal)another;
51         return this.getName().equals(principal.getName());
52     }
53
54     /**
55      * Returns a string representation of this principal.
56      *
57      * @return a string representation of this principal.
58      */
59     public String JavaDoc toString()
60     {
61         return this.userName;
62     }
63
64     /**
65      * Returns the name of this principal.
66      *
67      * @return the name of this principal.
68      */
69     public String JavaDoc getName()
70     {
71         return this.userName;
72     }
73
74
75 }
76
77
Popular Tags