View Javadoc
1   /*
2    * MIT License
3    *
4    * Copyright (c) 2010-2024 The Waffle Project Contributors: https://github.com/Waffle/waffle/graphs/contributors
5    *
6    * Permission is hereby granted, free of charge, to any person obtaining a copy
7    * of this software and associated documentation files (the "Software"), to deal
8    * in the Software without restriction, including without limitation the rights
9    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10   * copies of the Software, and to permit persons to whom the Software is
11   * furnished to do so, subject to the following conditions:
12   *
13   * The above copyright notice and this permission notice shall be included in all
14   * copies or substantial portions of the Software.
15   *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22   * SOFTWARE.
23   */
24  package waffle.spring;
25  
26  import java.util.Locale;
27  
28  import org.springframework.security.core.GrantedAuthority;
29  import org.springframework.security.core.authority.SimpleGrantedAuthority;
30  
31  import waffle.windows.auth.WindowsAccount;
32  
33  /**
34   * A {@link GrantedAuthorityFactory} that uses the {@link WindowsAccount}'s fqn as the basis of the
35   * {@link GrantedAuthority} string, and (optionally) applies two transformations:
36   * <ul>
37   * <li>prepending a prefix, and</li>
38   * <li>converting to uppercase</li>
39   * </ul>
40   * .
41   */
42  public class FqnGrantedAuthorityFactory implements GrantedAuthorityFactory {
43  
44      /** The prefix. */
45      private final String prefix;
46  
47      /** The convert to upper case. */
48      private final boolean convertToUpperCase;
49  
50      /**
51       * Instantiates a new fqn granted authority factory.
52       *
53       * @param newPrefix
54       *            the new prefix
55       * @param newConvertToUpperCase
56       *            the new convert to upper case
57       */
58      public FqnGrantedAuthorityFactory(final String newPrefix, final boolean newConvertToUpperCase) {
59          this.prefix = newPrefix;
60          this.convertToUpperCase = newConvertToUpperCase;
61      }
62  
63      @Override
64      public GrantedAuthority createGrantedAuthority(final WindowsAccount windowsAccount) {
65  
66          String grantedAuthorityString = windowsAccount.getFqn();
67  
68          if (this.prefix != null) {
69              grantedAuthorityString = this.prefix + grantedAuthorityString;
70          }
71  
72          if (this.convertToUpperCase) {
73              grantedAuthorityString = grantedAuthorityString.toUpperCase(Locale.ENGLISH);
74          }
75  
76          return new SimpleGrantedAuthority(grantedAuthorityString);
77      }
78  
79  }