View Javadoc

1   /**
2    * This file Copyright (c) 2003-2010 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  import java.util.Collection;
38  import java.util.Map;
39  
40  
41  /**
42   * A {@link UserManager} delegating to a set of user managers. The first user manager which does not
43   * through an {@link UnsupportedOperationException} will be used.
44   * @author gjoseph
45   * @version $Revision: $ ($Author: $)
46   */
47  public class DelegatingUserManager implements UserManager {
48      private final Map<String, UserManager> delegates;
49  
50      /**
51       * @param delegates <String realm, UserManager delegate>
52       */
53      public DelegatingUserManager(Map<String, UserManager> delegates) {
54          this.delegates = delegates;
55      }
56  
57      public User createUser(final String name, final String pw) throws UnsupportedOperationException {
58          final Op<User> op = new Op<User>() {
59              public User delegate(UserManager um) {
60                  return um.createUser(name, pw);
61              }
62          };
63          return delegateUntilSupported(op);
64      }
65  
66      public void changePassword(User user, String newPassword) throws UnsupportedOperationException {
67          throw new UnsupportedOperationException("Please use a specific instance of UserManager to do this.");
68      }
69  
70      public User getAnonymousUser() {
71          return delegateUntilSupported(new Op<User>() {
72              public User delegate(UserManager um) {
73                  return um.getAnonymousUser();
74              }
75          });
76      }
77  
78      public User getSystemUser() {
79          return delegateUntilSupported(new Op<User>() {
80              public User delegate(UserManager um) {
81                  return um.getSystemUser();
82              }
83          });
84      }
85  
86      public User getUser(final String name) throws UnsupportedOperationException {
87          return delegateUntilNotNull(new Op<User>() {
88              public User delegate(UserManager um) {
89                  return um.getUser(name);
90              }
91          });
92      }
93  
94      public User getUser(final Subject subject) throws UnsupportedOperationException {
95          return delegateUntilNotNull(new Op<User>() {
96              public User delegate(UserManager um) {
97                  return um.getUser(subject);
98              }
99          });
100     }
101 
102     // TODO : this should maybe aggregate results, but ExternalUserManager throws an UnsupportedOperationException
103     // TODO : also not that this is seemingly never used (or maybe through reflection or other ide-search unfriendly mechanisms)
104     public Collection<User> getAllUsers() throws UnsupportedOperationException {
105         return delegateUntilSupported(new Op<Collection<User>>() {
106             public Collection<User> delegate(UserManager um) {
107                 return um.getAllUsers();
108             }
109         });
110     }
111 
112     private <RT> RT delegateUntilSupported(Op<RT> op) {
113         for (String realmName : delegates.keySet()) {
114             final UserManager um = delegates.get(realmName);
115             try {
116                 return op.delegate(um);
117             } catch (UnsupportedOperationException e) {
118                 // try the next delegate
119             }
120         }
121         throw new UnsupportedOperationException("None of the delegate UserManager supports this operation.");
122     }
123 
124     private <RT> RT delegateUntilNotNull(Op<RT> op) {
125         for (String realmName : delegates.keySet()) {
126             final UserManager um = delegates.get(realmName);
127             final RT result = op.delegate(um);
128             if (result != null) {
129                 return result;
130             }
131         }
132         return null;
133     }
134 
135     private interface Op<RT> {
136         RT delegate(UserManager um);
137     }
138 }