1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. 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,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.server.core.jndi;
21
22
23 import javax.naming.InitialContext;
24 import javax.naming.spi.InitialContextFactory;
25
26 import org.apache.directory.server.core.api.DirectoryService;
27
28
29 /**
30 * A server-side JNDI provider implementation of {@link InitialContextFactory}.
31 * This class can be utilized via JNDI API in the standard fashion:
32 * <p>
33 * <code>
34 * Hashtable env = new Hashtable();
35 * env.put( Context.PROVIDER_URL, "ou=system" );
36 * env.put(
37 * Context.INITIAL_CONTEXT_FACTORY, "org.apache.directory.server.core.jndi.CoreContextFactory" );
38 * InitialContext initialContext = new InitialContext( env );
39 * </code>
40 * <p>
41 * Unfortunately, {@link InitialContext} creates a new instance of
42 * {@link InitialContextFactory} implementation everytime it is instantiated,
43 * so this factory maintains only a static, singleton instance of
44 * {@link DirectoryService}, which provides actual implementation.
45 * Please note that you'll also have to maintain any stateful information
46 * as using singleton pattern if you're going to extend this factory.
47 * <p>
48 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
49 *
50 * @see javax.naming.spi.InitialContextFactory
51 */
52 public abstract class AbstractContextFactory implements InitialContextFactory
53 {
54 }