1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.jetspeed.security;
18
19 import org.apache.jetspeed.security.spi.CredentialHandler;
20 import org.apache.jetspeed.security.spi.UserSecurityHandler;
21
22 /***
23 * <p>
24 * Configures an authentication provider.
25 * </p>
26 *
27 * @author <a href="mailto:dlestrat@apache.org">David Le Strat </a>
28 */
29 public interface AuthenticationProvider
30 {
31
32 /***
33 * <p>
34 * Gets the authentication provider name.
35 * </p>
36 *
37 * @return The authentication provider name.
38 */
39 String getProviderName();
40
41 /***
42 * <p>
43 * Gets the authentication provider description.
44 * </p>
45 *
46 * @return The authentication provider description.
47 */
48 String getProviderDescription();
49
50 /***
51 * <p>
52 * Gets the {@link UserSecurityHandler}.
53 * </p>
54 *
55 * @return The {@link UserSecurityHandler}.
56 */
57 UserSecurityHandler getUserSecurityHandler();
58
59
60 /***
61 * <p>
62 * Sets the {@link UserSecurityHandler}.
63 * </p>
64 *
65 * @param userSecurityHandler The {@link UserSecurityHandler}.
66 */
67 void setUserSecurityHandler(UserSecurityHandler userSecurityHandler);
68
69 /***
70 * <p>
71 * Gets the {@link CredentialHandler}.
72 * </p>
73 *
74 * @return The {@link CredentialHandler}.
75 */
76 CredentialHandler getCredentialHandler();
77
78 /***
79 * <p>
80 * Sets the {@link CredentialHandler}.
81 * </p>
82 *
83 * @param credHandler The {@link CredentialHandler}.
84 */
85 void setCredentialHandler(CredentialHandler credHandler);
86
87 }