1 /*
2 * MIT License
3 *
4 * Copyright (c) 2010-2022 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 org.springframework.security.core.GrantedAuthority;
27
28 import waffle.windows.auth.WindowsAccount;
29
30 /**
31 * Used by {@link WindowsAuthenticationToken} to convert {@link WindowsAccount}s representing groups into
32 * {@link GrantedAuthority}s.
33 */
34 @FunctionalInterface
35 public interface GrantedAuthorityFactory {
36
37 /**
38 * Creates a {@link GrantedAuthority} from the given {@link WindowsAccount}.
39 *
40 * @param windowsAccount
41 * the windows account
42 *
43 * @return the granted authority
44 */
45 GrantedAuthority createGrantedAuthority(final WindowsAccount windowsAccount);
46
47 }