01: /*
02: * Copyright 2001-2007 Geert Bevin <gbevin[remove] at uwyn dot com>
03: * Distributed under the terms of either:
04: * - the common development and distribution license (CDDL), v1.0; or
05: * - the GNU Lesser General Public License, v2.1 or later
06: * $Id: RoleUserCredentials.java 3634 2007-01-08 21:42:24Z gbevin $
07: */
08: package com.uwyn.rife.authentication.credentials;
09:
10: import com.uwyn.rife.authentication.Credentials;
11:
12: /**
13: * <p>This interface needs to be implemented by all credentials classes that
14: * work with {@link
15: * com.uwyn.rife.authentication.credentialsmanagers.RoleUsersManager}s, which
16: * is the default user management in RIFE.
17: * <p>Credentials aren't the same as the actual account information of a user,
18: * they provide the data that is submitted and that needs to be verified.
19: *
20: * @author Geert Bevin (gbevin[remove] at uwyn dot com)
21: * @version $Revision: 3634 $
22: * @since 1.0
23: */
24: public interface RoleUserCredentials extends Credentials, RememberMe {
25: /**
26: * Retrieves the submitted login.
27: *
28: * @return the login
29: * @since 1.0
30: */
31: public String getLogin();
32:
33: /**
34: * Sets the login to submit.
35: *
36: * @param login the login
37: * @since 1.0
38: */
39: public void setLogin(String login);
40:
41: /**
42: * Retrieves the submitted password.
43: *
44: * @return the password
45: * @since 1.0
46: */
47: public String getPassword();
48:
49: /**
50: * Sets the password to submit.
51: *
52: * @param password the password
53: * @since 1.0
54: */
55: public void setPassword(String password);
56:
57: /**
58: * Retrieves the submitted role.
59: *
60: * @return the role
61: * @since 1.0
62: */
63: public String getRole();
64:
65: /**
66: * Sets the role to submit.
67: *
68: * @param role the role
69: * @since 1.0
70: */
71: public void setRole(String role);
72: }
|