View Javadoc

1   /***
2    * Redistribution and use of this software and associated documentation
3    * ("Software"), with or without modification, are permitted provided
4    * that the following conditions are met:
5    *
6    * 1. Redistributions of source code must retain copyright
7    *    statements and notices.  Redistributions must also contain a
8    *    copy of this document.
9    *
10   * 2. Redistributions in binary form must reproduce the
11   *    above copyright notice, this list of conditions and the
12   *    following disclaimer in the documentation and/or other
13   *    materials provided with the distribution.
14   *
15   * 3. The name "Exolab" must not be used to endorse or promote
16   *    products derived from this Software without prior written
17   *    permission of Exoffice Technologies.  For written permission,
18   *    please contact info@exolab.org.
19   *
20   * 4. Products derived from this Software may not be called "Exolab"
21   *    nor may "Exolab" appear in their names without prior written
22   *    permission of Exoffice Technologies. Exolab is a registered
23   *    trademark of Exoffice Technologies.
24   *
25   * 5. Due credit should be given to the Exolab Project
26   *    (http://www.exolab.org/).
27   *
28   * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29   * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
32   * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39   * OF THE POSSIBILITY OF SUCH DAMAGE.
40   *
41   * Copyright 2003-2004 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: BasicPrincipal.java,v 1.1 2004/11/26 01:50:34 tanderson Exp $
44   */
45  package org.exolab.jms.common.security;
46  
47  import java.io.Serializable;
48  import java.security.Principal;
49  
50  
51  /***
52   * <code>BasicPrincipal</code> associates a user name with a password
53   *
54   * @version     $Revision: 1.1 $ $Date: 2004/11/26 01:50:34 $
55   * @author      <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
56   */
57  public class BasicPrincipal implements Principal, Serializable {
58  
59      /***
60       * The principal's name
61       */
62      private String _name;
63  
64      /***
65       * The principal's password
66       */
67      private String _password;
68  
69      /***
70       * Object version no. for serialization
71       */
72      static final long serialVersionUID = 1;
73  
74  
75      /***
76       * Construct a new <code>Principal</code>
77       *
78       * @param name the principal's name
79       * @param password the principal's password
80       */
81      public BasicPrincipal(String name, String password) {
82          if (name == null) {
83              throw new IllegalArgumentException("Argument 'name' is null");
84          }
85          if (password == null) {
86              throw new IllegalArgumentException("Argument 'password' is null");
87          }
88          _name = name;
89          _password = password;
90      }
91  
92      /***
93       * Returns the name of this principal
94       *
95       * @return the name of this principal
96       */
97      public String getName() {
98          return _name;
99      }
100 
101     /***
102      * Returns the password of this principal
103      *
104      * @return the password of this principal
105      */
106     public String getPassword() {
107         return _password;
108     }
109 
110     /***
111      * Compares this principal to the specified object.
112      *
113      * @param another principal to compare with
114      * @return <code>true</code> if the principal passed in is the same as
115      * this principal; otherwise <code>false</code>
116      */
117     public boolean equals(Object another) {
118         boolean equal = (this == another);
119         if (!equal && another instanceof BasicPrincipal) {
120             BasicPrincipal other = (BasicPrincipal) another;
121             if (_name.equals(other.getName())
122                 && _password.equals(other.getPassword())) {
123                 equal = true;
124             }
125         }
126         return equal;
127     }
128 
129     /***
130      * Returns a hashcode for this principal.
131      *
132      * @return a hashcode for this principal.
133      */
134     public int hashCode() {
135         return _name.hashCode();
136     }
137 
138 }