summaryrefslogtreecommitdiff
path: root/javax/naming/spi/InitialContextFactoryBuilder.java
diff options
context:
space:
mode:
Diffstat (limited to 'javax/naming/spi/InitialContextFactoryBuilder.java')
-rw-r--r--javax/naming/spi/InitialContextFactoryBuilder.java17
1 files changed, 17 insertions, 0 deletions
diff --git a/javax/naming/spi/InitialContextFactoryBuilder.java b/javax/naming/spi/InitialContextFactoryBuilder.java
index fef073e8a..31bafe6dc 100644
--- a/javax/naming/spi/InitialContextFactoryBuilder.java
+++ b/javax/naming/spi/InitialContextFactoryBuilder.java
@@ -42,8 +42,25 @@ import java.util.Hashtable;
import javax.naming.NamingException;
+/**
+ * Represents the builder that creates instances of the factories that produce
+ * initial naming contexts. JNDI allows to specifiy different initial contexts
+ * at runtime. The user program can install its own initial context factory
+ * builder.
+ *
+ * @see NamingManager#setInitialContextFactoryBuilder
+ */
public interface InitialContextFactoryBuilder
{
+ /**
+ * Create the new initial context factory
+ *
+ * @param environment the properties, used for creation of the initial
+ * context factory. The parameter is owned by the caller: it is safe to reuse
+ * the table for other purposes after the method returns.
+ * @return the created initial context factory, never null.
+ * @throws NamingException on failure
+ */
InitialContextFactory createInitialContextFactory (Hashtable<?, ?> environment)
throws NamingException;
}