annotate gwt-client/src/main/java/org/dive4elements/river/client/server/auth/User.java @ 5838:5aa05a7a34b7

Rename modules to more fitting names.
author Sascha L. Teichmann <teichmann@intevation.de>
date Thu, 25 Apr 2013 15:23:37 +0200
parents flys-client/src/main/java/org/dive4elements/river/client/server/auth/User.java@821a02bbfb4e
children 172338b1407f
rev   line source
5835
821a02bbfb4e Fixed internal java dependencies
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5834
diff changeset
1 package org.dive4elements.river.client.server.auth;
2956
d7f76f197d89 Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff changeset
2
2978
98514ab2c9ba Implement getting a list of roles from a logged in user
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 2959
diff changeset
3 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
4
2979
193a113888d4 Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 2978
diff changeset
5 /**
193a113888d4 Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 2978
diff changeset
6 * User representation after a succesfull login
193a113888d4 Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 2978
diff changeset
7 */
2956
d7f76f197d89 Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff changeset
8 public interface User {
d7f76f197d89 Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff changeset
9
2979
193a113888d4 Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 2978
diff changeset
10 /**
193a113888d4 Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 2978
diff changeset
11 * Returns the username as String
193a113888d4 Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 2978
diff changeset
12 */
2956
d7f76f197d89 Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff changeset
13 public String getName();
d7f76f197d89 Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff changeset
14
2979
193a113888d4 Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 2978
diff changeset
15 /**
193a113888d4 Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 2978
diff changeset
16 * 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
17 */
2956
d7f76f197d89 Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff changeset
18 public String getPassword();
d7f76f197d89 Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff changeset
19
2979
193a113888d4 Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 2978
diff changeset
20 /**
193a113888d4 Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 2978
diff changeset
21 * 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
22 * has expired.
193a113888d4 Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 2978
diff changeset
23 */
2959
5ba0a6efdf3b Auth: added simple file based authentication.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 2956
diff changeset
24 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
25
2979
193a113888d4 Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 2978
diff changeset
26 /**
193a113888d4 Add javadoc for the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 2978
diff changeset
27 * 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
28 */
2978
98514ab2c9ba Implement getting a list of roles from a logged in user
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 2959
diff changeset
29 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
30
71ba3cf3ec5e Refactor Authentication to allow to pass the Freatures to the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 2979
diff changeset
31
71ba3cf3ec5e Refactor Authentication to allow to pass the Freatures to the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 2979
diff changeset
32 /**
71ba3cf3ec5e Refactor Authentication to allow to pass the Freatures to the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 2979
diff changeset
33 * 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
34 */
71ba3cf3ec5e Refactor Authentication to allow to pass the Freatures to the user class
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 2979
diff changeset
35 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
36
1387cdeb8d93 Add account information to flys-client user classes
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 3485
diff changeset
37 /**
1387cdeb8d93 Add account information to flys-client user classes
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 3485
diff changeset
38 * Returns the users account name
1387cdeb8d93 Add account information to flys-client user classes
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 3485
diff changeset
39 */
1387cdeb8d93 Add account information to flys-client user classes
Bjoern Ricks <bjoern.ricks@intevation.de>
parents: 3485
diff changeset
40 public String getAccount();
2956
d7f76f197d89 Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff changeset
41 }
d7f76f197d89 Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff changeset
42 // vim:set ts=4 sw=4 si et fenc=utf8 tw=80:

http://dive4elements.wald.intevation.org