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 (C) Exoffice Technologies Inc. All Rights Reserved.
42   */
43  
44  package org.exolab.jms.authentication;
45  
46  
47  import org.exolab.core.service.BasicService;
48  import org.exolab.core.service.ServiceException;
49  
50  
51  /***
52   * This is the active authentication component within the JMS server.
53   *
54   * @version     $Revision: 1.3 $ $Date: 2003/08/07 13:32:48 $
55   * @author      <a href="mailto:knut@lerpold">Knut Lerpold</a>
56   */
57  public class AuthenticationMgr extends BasicService {
58  
59      /***
60       * The user manager
61       */
62      private UserManager _users;
63  
64      /***
65       * The service name of the authentication manager
66       */
67      private static final String AM_SERVICE_NAME = "AuthenticationManager";
68  
69      /***
70       * The singleton instance of the authentication manager.
71       */
72      private static volatile AuthenticationMgr _instance;
73  
74  
75      /***
76       * Construct a new <code>AuthenticationManager</code>
77       *
78       * @throws ServiceException if the service cannot be initialised
79       */
80      private AuthenticationMgr() throws ServiceException {
81          super(AM_SERVICE_NAME);
82          _users = new UserManager();
83      }
84  
85      /***
86       * Create and return an instance of the singleton.
87       *
88       * @return the singleton instance
89       * @throws ServiceException if the service cannot be created
90       */
91      public static AuthenticationMgr createInstance() throws ServiceException {
92          _instance = new AuthenticationMgr();
93          return _instance;
94      }
95  
96      /***
97       * Return an instance to the AuthenticationMgr singleton. This method
98       * assumes that the singleton has already been created with a call to
99       * {@link #createInstance}
100      *
101      * @return the singleton instance
102      */
103     public static AuthenticationMgr instance() {
104         return _instance;
105     }
106 
107     // implement BasicService.run
108     public void run() {
109         // do nothing
110     }
111 
112     // override BasicService.stop
113     public void stop() throws ServiceException {
114         // destroy the user manager.
115         _users.destroy();
116 
117         // clear the static reference
118         _instance = null;
119     }
120 
121     /***
122      * Create a user.
123      *
124      * @param user the user to create
125      * @return <code>true</code> if the user is created
126      * otherwise <code>false</code>
127      */
128     public boolean addUser(User user) {
129         return _users.createUser(user);
130     }
131 
132     /***
133      * Remove this user
134      *
135      * @param user the user to remove
136      * @return <code>true</code> if the user is removed
137      * otherwise <code>false</code>
138      */
139     public boolean removeUser(User user) {
140         return _users.deleteUser(user);
141     }
142 
143     /***
144      * Gets a user.
145      *
146      * @param user the user
147      * @return User
148      */
149     public User getUser(User user) {
150         return _users.getUser(user);
151     }
152 
153     /***
154      * Update a user.
155      *
156      * @param user the user to update
157      * @return <code>true</code> if the password is updated
158      * otherwise <code>false</code>
159      */
160     public boolean updateUser(User user) {
161         return _users.updateUser(user);
162     }
163 
164     /***
165      * Validate the password for the specified user.
166      *
167      * @param username the user's name
168      * @param password the password to check
169      * @return <code>true</code> if the username and password exist, otherwise
170      * <code>false</code>
171      */
172     public boolean validateUser(String username, String password) {
173         return _users.validateUser(username, password);
174     }
175 
176 }