Mercurial > dive4elements > river
annotate gwt-client/src/main/java/org/dive4elements/river/client/server/auth/User.java @ 9801:1d7a72a50183 3.2.x tip
Assume Compose V2, consistently
author | Tom Gottfried <tom@intevation.de> |
---|---|
date | Thu, 23 Nov 2023 10:14:13 +0100 |
parents | 7bc35bbd8b27 |
children | d6d5ca6d4af0 |
rev | line source |
---|---|
5861
172338b1407f
GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
5838
diff
changeset
|
1 /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde |
172338b1407f
GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
5838
diff
changeset
|
2 * Software engineering by Intevation GmbH |
172338b1407f
GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
5838
diff
changeset
|
3 * |
5993
ea9eef426962
Removed trailing whitespace.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
5861
diff
changeset
|
4 * This file is Free Software under the GNU AGPL (>=v3) |
5861
172338b1407f
GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
5838
diff
changeset
|
5 * and comes with ABSOLUTELY NO WARRANTY! Check out the |
5993
ea9eef426962
Removed trailing whitespace.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
5861
diff
changeset
|
6 * documentation coming with Dive4Elements River for details. |
5861
172338b1407f
GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
5838
diff
changeset
|
7 */ |
172338b1407f
GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
5838
diff
changeset
|
8 |
5835
821a02bbfb4e
Fixed internal java dependencies
Sascha L. Teichmann <teichmann@intevation.de>
parents:
5834
diff
changeset
|
9 package org.dive4elements.river.client.server.auth; |
2956
d7f76f197d89
Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff
changeset
|
10 |
2978
98514ab2c9ba
Implement getting a list of roles from a logged in user
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2959
diff
changeset
|
11 import java.util.List; |
98514ab2c9ba
Implement getting a list of roles from a logged in user
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2959
diff
changeset
|
12 |
2979
193a113888d4
Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2978
diff
changeset
|
13 /** |
193a113888d4
Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2978
diff
changeset
|
14 * User representation after a succesfull login |
193a113888d4
Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2978
diff
changeset
|
15 */ |
2956
d7f76f197d89
Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff
changeset
|
16 public interface User { |
d7f76f197d89
Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff
changeset
|
17 |
2979
193a113888d4
Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2978
diff
changeset
|
18 /** |
193a113888d4
Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2978
diff
changeset
|
19 * Returns the username as String |
193a113888d4
Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2978
diff
changeset
|
20 */ |
2956
d7f76f197d89
Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff
changeset
|
21 public String getName(); |
d7f76f197d89
Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff
changeset
|
22 |
2979
193a113888d4
Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2978
diff
changeset
|
23 /** |
193a113888d4
Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2978
diff
changeset
|
24 * Returns the password of the user as String |
193a113888d4
Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2978
diff
changeset
|
25 */ |
2956
d7f76f197d89
Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff
changeset
|
26 public String getPassword(); |
d7f76f197d89
Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff
changeset
|
27 |
2979
193a113888d4
Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2978
diff
changeset
|
28 /** |
193a113888d4
Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2978
diff
changeset
|
29 * Returns True if the authentication for the user |
193a113888d4
Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2978
diff
changeset
|
30 * has expired. |
193a113888d4
Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2978
diff
changeset
|
31 */ |
2959
5ba0a6efdf3b
Auth: added simple file based authentication.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
2956
diff
changeset
|
32 public boolean hasExpired(); |
2978
98514ab2c9ba
Implement getting a list of roles from a logged in user
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2959
diff
changeset
|
33 |
2979
193a113888d4
Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2978
diff
changeset
|
34 /** |
193a113888d4
Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2978
diff
changeset
|
35 * Returns a list of roles corresponsing the the user |
193a113888d4
Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2978
diff
changeset
|
36 */ |
2978
98514ab2c9ba
Implement getting a list of roles from a logged in user
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2959
diff
changeset
|
37 public List<String> getRoles(); |
3485
71ba3cf3ec5e
Refactor Authentication to allow to pass the Freatures to the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2979
diff
changeset
|
38 |
71ba3cf3ec5e
Refactor Authentication to allow to pass the Freatures to the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2979
diff
changeset
|
39 |
71ba3cf3ec5e
Refactor Authentication to allow to pass the Freatures to the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2979
diff
changeset
|
40 /** |
71ba3cf3ec5e
Refactor Authentication to allow to pass the Freatures to the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2979
diff
changeset
|
41 * Returns true if the user is allowed access the feature |
71ba3cf3ec5e
Refactor Authentication to allow to pass the Freatures to the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2979
diff
changeset
|
42 */ |
71ba3cf3ec5e
Refactor Authentication to allow to pass the Freatures to the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
2979
diff
changeset
|
43 public boolean canUseFeature(String feature); |
3504
1387cdeb8d93
Add account information to flys-client user classes
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
3485
diff
changeset
|
44 |
1387cdeb8d93
Add account information to flys-client user classes
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
3485
diff
changeset
|
45 /** |
1387cdeb8d93
Add account information to flys-client user classes
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
3485
diff
changeset
|
46 * Returns the users account name |
1387cdeb8d93
Add account information to flys-client user classes
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
3485
diff
changeset
|
47 */ |
1387cdeb8d93
Add account information to flys-client user classes
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
3485
diff
changeset
|
48 public String getAccount(); |
6187
7bc35bbd8b27
Store the SAML ticket in the user object after authentication.
Bernhard Herzog <bh@intevation.de>
parents:
5993
diff
changeset
|
49 |
7bc35bbd8b27
Store the SAML ticket in the user object after authentication.
Bernhard Herzog <bh@intevation.de>
parents:
5993
diff
changeset
|
50 /** |
7bc35bbd8b27
Store the SAML ticket in the user object after authentication.
Bernhard Herzog <bh@intevation.de>
parents:
5993
diff
changeset
|
51 * Returns the SAML ticket for single sign-on. |
7bc35bbd8b27
Store the SAML ticket in the user object after authentication.
Bernhard Herzog <bh@intevation.de>
parents:
5993
diff
changeset
|
52 * @return The SAML ticket in base64 encoded XML. null if no ticket |
7bc35bbd8b27
Store the SAML ticket in the user object after authentication.
Bernhard Herzog <bh@intevation.de>
parents:
5993
diff
changeset
|
53 * is available. |
7bc35bbd8b27
Store the SAML ticket in the user object after authentication.
Bernhard Herzog <bh@intevation.de>
parents:
5993
diff
changeset
|
54 */ |
7bc35bbd8b27
Store the SAML ticket in the user object after authentication.
Bernhard Herzog <bh@intevation.de>
parents:
5993
diff
changeset
|
55 public String getSamlXMLBase64(); |
2956
d7f76f197d89
Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff
changeset
|
56 } |
d7f76f197d89
Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff
changeset
|
57 // vim:set ts=4 sw=4 si et fenc=utf8 tw=80: |