View Javadoc

1   /*
2    *   @(#) $Id: InterceptorConfiguration.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.interceptor.Interceptor;
22  
23  /***
24   * A configuration for {@link Interceptor}.
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 InterceptorConfiguration
30  {
31      private String name;
32      private Interceptor interceptor;
33  
34      /***
35       * Creates a new instance.
36       */
37      protected InterceptorConfiguration()
38      {
39      }
40  
41      /***
42       * Returns the {@link Interceptor} that this configuration
43       * configures.
44       */
45      public Interceptor getInterceptor()
46      {
47          return interceptor;
48      }
49  
50      /***
51       * Sets the {@link Interceptor} that this configuration
52       * configures.
53       */
54      protected void setInterceptor( Interceptor authenticator )
55      {
56          this.interceptor = authenticator;
57      }
58  
59      /***
60       * Returns the name of the {@link Interceptor}.
61       */
62      public String getName()
63      {
64          return name;
65      }
66  
67      /***
68       * Sets the name of the {@link Interceptor}.
69       */
70      protected void setName( String name )
71      {
72          this.name = name.trim();
73      }
74  
75      /***
76       * Validates this configuration.
77       *
78       * @throws ConfigurationException if this configuration is not valid.
79       */
80      public void validate()
81      {
82          if( name == null )
83          {
84              throw new ConfigurationException( "Name is not specified." );
85          }
86          
87          if( interceptor == null )
88          {
89              throw new ConfigurationException( "Authenticator is not specified." );
90          }
91      }
92  }