annotate flys-client/src/main/java/de/intevation/flys/client/server/auth/User.java @ 2979:193a113888d4

Add javadoc for the user class flys-client/trunk@4977 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Bjoern Ricks <bjoern.ricks@intevation.de>
date Fri, 13 Jul 2012 09:41:17 +0000
parents 98514ab2c9ba
children 71ba3cf3ec5e
rev   line source
2956
d7f76f197d89 Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff changeset
1 package de.intevation.flys.client.server.auth;
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();
2956
d7f76f197d89 Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff changeset
30 }
d7f76f197d89 Refactor GGInA authentication
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
diff changeset
31 // vim:set ts=4 sw=4 si et fenc=utf8 tw=80:

http://dive4elements.wald.intevation.org