View Javadoc

1   /* 
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
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  }