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.windows.auth;
25
26 /**
27 * A Windows Identity.
28 */
29 public interface IWindowsIdentity {
30
31 /**
32 * Sid.
33 *
34 * @return String.
35 */
36 String getSidString();
37
38 /**
39 * Sid.
40 *
41 * @return Array of bytes.
42 */
43 byte[] getSid();
44
45 /**
46 * Fully qualified name.
47 *
48 * @return String.
49 */
50 String getFqn();
51
52 /**
53 * Group memberships.
54 *
55 * @return Array of accounts.
56 */
57 IWindowsAccount[] getGroups();
58
59 /**
60 * Impersonate a logged on user.
61 *
62 * @return An impersonation context.
63 */
64 IWindowsImpersonationContext impersonate();
65
66 /**
67 * Dispose of the Windows identity.
68 */
69 void dispose();
70
71 /**
72 * Returns true if the identity represents a Guest account.
73 *
74 * @return True if the identity represents a Guest account, false otherwise.
75 */
76 boolean isGuest();
77 }