wamblee.org Git - utils/blob - test/enterprise/src/main/java/org/wamblee/test/jndi/StubInitialContextFactory.java

   1 /*
   2  * Copyright 2005-2010 the original author or authors.
   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 package org.wamblee.test.jndi;
  17
  18 import java.util.Hashtable;
  19
  20 import javax.naming.Context;
  21 import javax.naming.NamingException;
  22 import javax.naming.spi.InitialContextFactory;
  23
  24 /**
  25  * Test initial context factory used for testing software in a Java SE
  26  * environnment that uses JNDI to retrieve objects.
  27  *
  28  * See {@link #bind(String, Object)} to resp. register the initial context.
  29  *
  30  * To start mocking the JNDI tree, call {@link #register()}.
  31  *
  32  * To bind objects in the JNDI tree simply use the standard JNDI api:
  33  *
  34  * <pre>
  35  *   InitialContext context = new InitialContext();
  36  *   MyClass myObj = ...;
  37  *   context.bind("a/b", myObj);
  38  * </pre>
  39  *
  40  * When finished with a test case, call {@link #unregister()} to unregister the
  41  * JNDI tree again.
  42  */
  43 public class StubInitialContextFactory implements InitialContextFactory {
  44
  45     private static Context CONTEXT;
  46
  47     private static void initialize() {
  48         try {
  49             CONTEXT = new StubInitialContext();
  50         } catch (NamingException e) { // can't happen.
  51             throw new RuntimeException(e);
  52         }
  53     }
  54
  55     /**
  56      * This method must be called to register this initial context factory as
  57      * the default implementation for JNDI.
  58      *
  59      * @throws Exception
  60      */
  61     public static void register() {
  62         // sets up the InitialContextFactoryForTest as default factory.
  63         System.setProperty(Context.INITIAL_CONTEXT_FACTORY,
  64             StubInitialContextFactory.class.getName());
  65         if (CONTEXT == null) {
  66             initialize();
  67         }
  68     }
  69
  70     /**
  71      * Unregisters the initial context factory
  72      */
  73     public static void unregister() {
  74         System.setProperty(Context.INITIAL_CONTEXT_FACTORY, "");
  75         CONTEXT = null;
  76     }
  77
  78     public Context getInitialContext(Hashtable<?, ?> aEnvironment)
  79         throws NamingException {
  80         return CONTEXT;
  81     }
  82 }