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.jndi;
18  
19  import java.util.Hashtable;
20  
21  import javax.naming.Context;
22  
23  import org.apache.ldap.server.configuration.StartupConfiguration;
24  import org.apache.ldap.server.interceptor.InterceptorChain;
25  import org.apache.ldap.server.partition.ContextPartitionNexus;
26  import org.apache.ldap.server.schema.GlobalRegistries;
27  
28  /***
29   * Represents the global configuration of currently running
30   * {@link ContextFactoryService}.  You can access all properties of
31   * {@link ContextFactoryService} and get JNDI {@link Context}s it provides
32   * via this interface.
33   */
34  public interface ContextFactoryConfiguration
35  {
36      
37      /***
38       * Returns the {@link ContextFactoryService} for this configuration.
39       */
40      ContextFactoryService getService();
41      
42      /***
43       * Returns the instance ID of the {@link ContextFactoryService}.
44       */
45      String getInstanceId();
46      
47      /***
48       * Returns the listener that listens to service events.
49       */
50      ContextFactoryServiceListener getServiceListener();
51      
52      /***
53       * Returns the initial context environment of the {@link ContextFactoryService}.
54       */
55      Hashtable getEnvironment();
56      
57      /***
58       * Returns the startup configuration of the {@link ContextFactoryService}.
59       */
60      StartupConfiguration getStartupConfiguration();
61      
62      /***
63       * Returns the registries for system schema objects of the {@link ContextFactoryService}.
64       */
65      GlobalRegistries getGlobalRegistries();
66  
67      /***
68       * Returns the {@link ContextPartitionNexus} of the {@link ContextFactoryService}
69       * which bypasses the interceptor chain.
70       */
71      ContextPartitionNexus getPartitionNexus();
72      
73      /***
74       * Returns the interceptor chain of the {@link ContextFactoryService}.
75       */
76      InterceptorChain getInterceptorChain();
77      
78      /***
79       * Returns <tt>true</tt> if this service is started
80       * and bootstrap entries have been created for the first time.
81       */
82      boolean isFirstStart();
83  }