View Javadoc

1   /*
2    *   Copyright 2004 The Apache Software Foundation
3    *
4    *   Licensed under the Apache License, Version 2.0 (the "License");
5    *   you may not use this file except in compliance with the License.
6    *   You may obtain a copy of the License at
7    *
8    *       http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *   Unless required by applicable law or agreed to in writing, software
11   *   distributed under the License is distributed on an "AS IS" BASIS,
12   *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *   See the License for the specific language governing permissions and
14   *   limitations under the License.
15   *
16   */
17  package org.apache.ldap.server.authn;
18  
19  import java.util.Enumeration;
20  
21  /***
22   * An authenticator configuration object used by the server to pass information to an authenticator
23   * during initialization.
24   *
25   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
26   */
27  public interface AuthenticatorConfig {
28  
29      /***
30       * Returns the name of this authenticator instance.
31       */
32      public String getAuthenticatorName();
33  
34      /***
35       * Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.
36       */
37      public String getInitParameter( String name );
38  
39      /***
40       * Returns the names of the servlet's initialization parameters as an Enumeration of String objects, or an empty Enumeration if the servlet has no initialization parameters.
41       */
42      public Enumeration getInitParameterNames();
43  
44      /***
45       * Returns a reference to the AuthenticatorContext.
46       */
47      public AuthenticatorContext getAuthenticatorContext();
48  }