View Javadoc

1   /*
2    *   @(#) $Id: AuthenticatorConfiguration.java 264732 2005-08-30 08:04:51Z akarasulu $
3    *
4    *   Copyright 2004 The Apache Software Foundation
5    *
6    *   Licensed under the Apache License, Version 2.0 (the "License");
7    *   you may not use this file except in compliance with the License.
8    *   You may obtain a copy of the License at
9    *
10   *       http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *   Unless required by applicable law or agreed to in writing, software
13   *   distributed under the License is distributed on an "AS IS" BASIS,
14   *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   *   See the License for the specific language governing permissions and
16   *   limitations under the License.
17   *
18   */
19  package org.apache.ldap.server.configuration;
20  
21  import org.apache.ldap.server.authn.Authenticator;
22  
23  /***
24   * A configuration for {@link Authenticator}.
25   *
26   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
27   * @version $Rev: 264732 $, $Date: 2005-08-30 04:04:51 -0400 (Tue, 30 Aug 2005) $
28   */
29  public class AuthenticatorConfiguration
30  {
31      private String name;
32      private Authenticator authenticator;
33  
34      /***
35       * Creates a new instance.
36       */
37      protected AuthenticatorConfiguration()
38      {
39      }
40  
41      /***
42       * Returns the {@link Authenticator} this configuration is configuring.
43       */
44      public Authenticator getAuthenticator()
45      {
46          return authenticator;
47      }
48  
49      /***
50       * Sets the {@link Authenticator} to configure.
51       */
52      protected void setAuthenticator( Authenticator authenticator )
53      {
54          this.authenticator = authenticator;
55      }
56  
57      /***
58       * Returns the user-defined name of the {@link Authenticator} that
59       * this configuration configures..
60       */
61      public String getName()
62      {
63          return name;
64      }
65  
66      /***
67       * Sets the user-defined name of the {@link Authenticator} that
68       * this configuration configures.
69       */
70      protected void setName( String name )
71      {
72          this.name = name.trim();
73      }
74  
75      /***
76       * Validates all properties of this configuration.
77       * @throws ConfigurationException if this configuration is not valid. 
78       */
79      public void validate()
80      {
81          if( name == null )
82          {
83              throw new ConfigurationException( "Name is not specified." );
84          }
85          
86          if( authenticator == null )
87          {
88              throw new ConfigurationException( "Authenticator is not specified." );
89          }
90      }
91  }