View Javadoc

1   /**
2    * This file Copyright (c) 2003-2011 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.cms.security;
35  
36  import javax.security.auth.Subject;
37  
38  import java.util.ArrayList;
39  import java.util.Collection;
40  import java.util.Map;
41  
42  
43  /**
44   * A {@link UserManager} delegating to a set of user managers. The first user manager which does not
45   * through an {@link UnsupportedOperationException} will be used.
46   * @author gjoseph
47   * @version $Revision: $ ($Author: $)
48   */
49  public class DelegatingUserManager implements UserManager {
50      private final Map<String, UserManager> delegates;
51  
52      /**
53       * @param delegates <String realm, UserManager delegate>
54       */
55      public DelegatingUserManager(Map<String, UserManager> delegates) {
56          this.delegates = delegates;
57      }
58  
59      public User createUser(final String name, final String pw) throws UnsupportedOperationException {
60          final Op<User> op = new Op<User>() {
61              public User delegate(UserManager um) {
62                  return um.createUser(name, pw);
63              }
64          };
65          return delegateUntilSupported(op);
66      }
67  
68      public void changePassword(User user, String newPassword) throws UnsupportedOperationException {
69          throw new UnsupportedOperationException("Please use a specific instance of UserManager to do this.");
70      }
71  
72      public User getAnonymousUser() {
73          return delegateUntilSupported(new Op<User>() {
74              public User delegate(UserManager um) {
75                  return um.getAnonymousUser();
76              }
77          });
78      }
79  
80      public User getSystemUser() {
81          return delegateUntilSupported(new Op<User>() {
82              public User delegate(UserManager um) {
83                  return um.getSystemUser();
84              }
85          });
86      }
87  
88      public User getUser(final String name) throws UnsupportedOperationException {
89          return delegateUntilNotNull(new Op<User>() {
90              public User delegate(UserManager um) {
91                  return um.getUser(name);
92              }
93          });
94      }
95  
96      public User getUser(final Subject subject) throws UnsupportedOperationException {
97          return delegateUntilNotNull(new Op<User>() {
98              public User delegate(UserManager um) {
99                  return um.getUser(subject);
100             }
101         });
102     }
103 
104     public Collection<User> getAllUsers() throws UnsupportedOperationException{
105         Collection<User> users = new ArrayList<User>();
106         for (String realmName : delegates.keySet()) {
107             try{
108                 UserManager userManager = delegates.get(realmName);
109                 users.addAll(userManager.getAllUsers());
110             }catch (UnsupportedOperationException e){
111                 // Skip to next user manager if current is not supporting getAllUsers() method
112             }
113         }
114         return users;
115     }
116 
117     private <RT> RT delegateUntilSupported(Op<RT> op) {
118         for (String realmName : delegates.keySet()) {
119             final UserManager um = delegates.get(realmName);
120             try {
121                 return op.delegate(um);
122             } catch (UnsupportedOperationException e) {
123                 // try the next delegate
124             }
125         }
126         throw new UnsupportedOperationException("None of the delegate UserManager supports this operation.");
127     }
128 
129     private <RT> RT delegateUntilNotNull(Op<RT> op) {
130         for (String realmName : delegates.keySet()) {
131             final UserManager um = delegates.get(realmName);
132             final RT result = op.delegate(um);
133             if (result != null) {
134                 return result;
135             }
136         }
137         return null;
138     }
139 
140     private interface Op<RT> {
141         RT delegate(UserManager um);
142     }
143 
144     public long getLockTimePeriod() throws UnsupportedOperationException{
145         throw new UnsupportedOperationException("Not supported by this user manager.");
146     }
147 
148     public int getMaxFailedLoginAttempts() throws UnsupportedOperationException {
149         throw new UnsupportedOperationException("Not supported by this user manager.");
150     }
151 
152     public void setLockTimePeriod(long lockTimePeriod) throws UnsupportedOperationException {
153         throw new UnsupportedOperationException("Not supported by this user manager.");
154     }
155 
156     public void setMaxFailedLoginAttempts(int maxFailedLoginAttempts) throws UnsupportedOperationException {
157         throw new UnsupportedOperationException("Not supported by this user manager.");
158     }
159 }