1 /* NamingManager.java -- Creates contexts and objects
2 Copyright (C) 2000, 2001, 2002, 2003, 2004,
3 2006 Free Software Foundation, Inc.
5 This file is part of GNU Classpath.
7 GNU Classpath is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Classpath is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Classpath; see the file COPYING. If not, write to the
19 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22 Linking this library statically or dynamically with other modules is
23 making a combined work based on this library. Thus, the terms and
24 conditions of the GNU General Public License cover the whole
27 As a special exception, the copyright holders of this library give you
28 permission to link this library with independent modules to produce an
29 executable, regardless of the license terms of these independent
30 modules, and to copy and distribute the resulting executable under
31 terms of your choice, provided that you also meet, for each linked
32 independent module, the terms and conditions of the license of that
33 module. An independent module is a module which is not derived from
34 or based on this library. If you modify this library, you may extend
35 this exception to your version of the library, but you are not
36 obligated to do so. If you do not wish to do so, delete this
37 exception statement from your version. */
40 package javax
.naming
.spi
;
42 // import gnu.classpath.VMStackWalker;
44 import java
.util
.Enumeration
;
45 import java
.util
.Hashtable
;
46 import java
.util
.StringTokenizer
;
48 import javax
.naming
.CannotProceedException
;
49 import javax
.naming
.Context
;
50 import javax
.naming
.Name
;
51 import javax
.naming
.NamingException
;
52 import javax
.naming
.NoInitialContextException
;
53 import javax
.naming
.RefAddr
;
54 import javax
.naming
.Reference
;
55 import javax
.naming
.Referenceable
;
56 import javax
.naming
.StringRefAddr
;
59 * Contains methods for creating contexts and objects referred to by
60 * location information. The location is specified in the scope of the
61 * certain naming or directory service. This class only contais static
62 * methods and cannot be instantiated.
64 public class NamingManager
67 * The environment property into which getContinuationContext() stores the
68 * value of the CannotProceedException parameter. The value of this field
69 * is <i>java.naming.spi.CannotProceedException<i>.
71 public static final String CPE
= "java.naming.spi.CannotProceedException";
73 private static InitialContextFactoryBuilder icfb
;
75 // Package private so DirectoryManager can access it.
76 static ObjectFactoryBuilder ofb
;
78 // This class cannot be instantiated.
84 * Checks if the initial context factory builder has been set.
86 * @return true if the builder has been set
88 * @see #setInitialContextFactoryBuilder(InitialContextFactoryBuilder)
90 public static boolean hasInitialContextFactoryBuilder ()
96 * Creates the initial context. If the initial object factory builder has
97 * been set with {@link #setObjectFactoryBuilder(ObjectFactoryBuilder)},
98 * the work is delegated to this builder. Otherwise, the method searches
99 * for the property Context.INITIAL_CONTEXT_FACTORY first in the passed
100 * table and then in the system properties. The value of this property is
101 * uses as a class name to install the context factory. The corresponding
102 * class must exist, be public and have the public parameterless constructor.
104 * @param environment the properties, used to create the context.
106 * @return the created context
108 * @throws NoInitialContextException if the initial builder is not set,
109 * the property Context.INITIAL_CONTEXT_FACTORY is missing of the
110 * class, named by this property, cannot be instantiated.
111 * @throws NamingException if throws by the context factory
113 public static Context
getInitialContext (Hashtable environment
)
114 throws NamingException
116 InitialContextFactory icf
= null;
119 icf
= icfb
.createInitialContextFactory(environment
);
122 String java_naming_factory_initial
= null;
123 if (environment
!= null)
124 java_naming_factory_initial
125 = (String
) environment
.get (Context
.INITIAL_CONTEXT_FACTORY
);
126 if (java_naming_factory_initial
== null)
127 java_naming_factory_initial
=
128 System
.getProperty (Context
.INITIAL_CONTEXT_FACTORY
);
129 if (java_naming_factory_initial
== null)
131 NoInitialContextException ("Can't find property: "
132 + Context
.INITIAL_CONTEXT_FACTORY
);
136 icf
= (InitialContextFactory
)Class
.forName
137 (java_naming_factory_initial
, true,
138 Thread
.currentThread().getContextClassLoader())
141 catch (Exception exception
)
143 NoInitialContextException e
144 = new NoInitialContextException
145 ("Can't load InitialContextFactory class: "
146 + java_naming_factory_initial
);
147 e
.setRootCause(exception
);
152 return icf
.getInitialContext (environment
);
157 * Creates the URL context for the given URL scheme id.
160 * The class name of the factory that creates the context has the naming
161 * pattern scheme-idURLContextFactory. For instance, the factory for the "ftp"
162 * sheme should be named "ftpURLContextFactory".
165 * The Context.URL_PKG_PREFIXES environment property contains the
166 * colon-separated list of the possible package prefixes. The package name is
167 * constructed concatenating the package prefix with the scheme id. This
168 * property is searched in the passed <i>environment</i> parameter and later
169 * in the system properties.
172 * If the factory class cannot be found in the specified packages, system will
173 * try to use the default internal factory for the given scheme.
176 * After the factory is instantiated, its method
177 * {@link ObjectFactory#getObjectInstance(Object, Name, Context, Hashtable)}
178 * is called to create and return the object instance.
180 * @param refInfo passed to the factory
181 * @param name passed to the factory
182 * @param nameCtx passed to the factory
183 * @param scheme the url scheme that must be supported by the given context
184 * @param environment the properties for creating the factory and context (may
186 * @return the created context
187 * @throws NamingException if thrown by the factory when creating the context.
189 static Context
getURLContext(Object refInfo
, Name name
, Context nameCtx
,
190 String scheme
, Hashtable environment
)
191 throws NamingException
193 // Specified as the default in the docs. Unclear if this is
195 String defaultPrefix
= "com.sun.jndi.url";
197 StringBuffer allPrefixes
= new StringBuffer();
200 if (environment
!= null)
202 prefixes
= (String
) environment
.get(Context
.URL_PKG_PREFIXES
);
203 if (prefixes
!= null)
204 allPrefixes
.append(prefixes
);
207 prefixes
= System
.getProperty(Context
.URL_PKG_PREFIXES
);
208 if (prefixes
!= null)
210 if (allPrefixes
.length() > 0)
211 allPrefixes
.append(':');
212 allPrefixes
.append(prefixes
);
215 if (allPrefixes
.length() > 0)
216 allPrefixes
.append(':');
217 allPrefixes
.append(defaultPrefix
);
219 scheme
= scheme
+ "." + scheme
+ "URLContextFactory";
221 StringTokenizer tokens
= new StringTokenizer(allPrefixes
.toString(), ":");
222 while (tokens
.hasMoreTokens())
224 String aTry
= tokens
.nextToken();
227 String tryClass
= aTry
+ "." + scheme
;
228 Class factoryClass
= forName(tryClass
);
229 if (factoryClass
!= null)
231 ObjectFactory factory
= (ObjectFactory
) factoryClass
.newInstance();
232 Object obj
= factory
.getObjectInstance(refInfo
, name
, nameCtx
,
234 Context ctx
= (Context
) obj
;
239 catch (ClassNotFoundException _1
)
243 catch (ClassCastException _2
)
245 // This means that the class we found was not an
246 // ObjectFactory or that the factory returned something
247 // which was not a Context.
249 catch (InstantiationException _3
)
251 // If we couldn't instantiate the factory we might get
254 catch (IllegalAccessException _4
)
256 // Another possibility when instantiating.
258 catch (NamingException _5
)
264 // Anything from getObjectInstance.
272 * Load the class with the given name. This method tries to use the context
273 * class loader first. If this fails, it searches for the suitable class
274 * loader in the caller stack trace. This method is a central point where all
275 * requests to find a class by name are delegated.
277 static Class
forName(String className
)
281 return Class
.forName(className
, true,
282 Thread
.currentThread().getContextClassLoader());
284 catch (ClassNotFoundException nex
)
287 * Returns the first user defined class loader on the call stack, or
288 * null when no non-null class loader was found.
289 Class[] ctx = VMStackWalker.getClassContext();
290 for (int i = 0; i < ctx.length; i++)
292 // Since we live in a class loaded by the bootstrap
293 // class loader, getClassLoader is safe to call without
294 // needing to be wrapped in a privileged action.
295 ClassLoader cl = ctx[i].getClassLoader();
299 return Class.forName(className, true, cl);
301 catch (ClassNotFoundException nex2)
314 * Creates the URL context for the given URL scheme id.
317 * The class name of the factory that creates the context has the naming
318 * pattern scheme-idURLContextFactory. For instance, the factory for the "ftp"
319 * sheme should be named "ftpURLContextFactory". The Context.URL_PKG_PREFIXES
320 * environment property contains the colon-separated list of the possible
321 * package prefixes. The package name is constructed concatenating the package
322 * prefix with the scheme id.
325 * If the factory class cannot be found in the specified packages, system will
326 * try to use the default internal factory for the given scheme.
329 * After the factory is instantiated, its method
330 * {@link ObjectFactory#getObjectInstance(Object, Name, Context, Hashtable)}
331 * is called to create and return the object instance.
333 * @param scheme the url scheme that must be supported by the given context
334 * @param environment the properties for creating the factory and context (may
336 * @return the created context
337 * @throws NamingException if thrown by the factory when creating the context.
339 public static Context
getURLContext (String scheme
,
340 Hashtable environment
)
341 throws NamingException
343 return getURLContext (null, null, null, scheme
, environment
);
347 * Sets the initial object factory builder.
349 * @param builder the builder to set
351 * @throws SecurityException if the builder cannot be installed due
352 * security restrictions.
353 * @throws NamingException if the builder cannot be installed due other
355 * @throws IllegalStateException if setting the builder repeatedly
357 public static void setObjectFactoryBuilder (ObjectFactoryBuilder builder
)
358 throws NamingException
360 SecurityManager sm
= System
.getSecurityManager ();
362 sm
.checkSetFactory ();
363 // Once the builder is installed it cannot be replaced.
365 throw new IllegalStateException ("object factory builder already installed");
370 static StringTokenizer
getPlusPath (String property
, Hashtable env
,
372 throws NamingException
374 String path
= (String
) env
.get (property
);
376 nameCtx
= getInitialContext (env
);
377 String path2
= (String
) nameCtx
.getEnvironment ().get (property
);
380 else if (path2
!= null)
382 return new StringTokenizer (path
!= null ? path
: "", ":");
386 * <p>Creates an object for the specified name context, environment and
387 * referencing context object.</p>
389 * If the builder factory is set by
390 * {@link #setObjectFactoryBuilder(ObjectFactoryBuilder)}, the call is
391 * delegated to that factory. Otherwise, the object is created using the
394 * <li>If the referencing object (refInfo) contains the factory class name,
395 * the object is created by this factory. If the creation fails,
396 * the parameter refInfo is returned as the method return value.</li>
397 * <li>If the referencing object has no factory class name, and the addresses
398 * are StringRefAddrs having the address type "URL", the object is
399 * created by the URL context factory. The used factory corresponds the
400 * the naming schema of the each URL. If the attempt to create
401 * the object this way is not successful, the subsequent rule is
403 * <li> If the refInfo is not an instance of Reference or Referencable
404 * (for example, null), the object is created by the factories,
405 * specified in the Context.OBJECT_FACTORIES property of the
406 * environment and the provider resource file, associated with the
407 * nameCtx. The value of this property is the colon separated list
408 * of the possible factories. If none of the factories can be
409 * loaded, the refInfo is returned.
412 * <p>The object factory must be public and have the public parameterless
415 * @param refInfo the referencing object, for which the new object must be
416 * created (can be null). If not null, it is usually an instance of
417 * the {@link Reference} or {@link Referenceable}.
418 * @param name the name of the object. The name is relative to
419 * the nameCtx naming context. The value of this parameter can be
420 * null if the name is not specified.
421 * @param nameCtx the naming context, in which scope the name of the new
422 * object is specified. If this parameter is null, the name is
423 * specified in the scope of the initial context.
424 * @param environment contains additional information for creating the object.
425 * This paramter can be null if there is no need to provide any
426 * additional information.
428 * @return the created object. If the creation fails, in some cases
429 * the parameter refInfo may be returned.
431 * @throws NamingException if the attempt to name the new object has failed
432 * @throws Exception if the object factory throws it. The object factory
433 * only throws an exception if it does not want other factories
434 * to be used to create the object.
436 public static Object
getObjectInstance (Object refInfo
,
439 Hashtable environment
)
442 ObjectFactory factory
= null;
445 factory
= ofb
.createObjectFactory (refInfo
, environment
);
448 // First see if we have a Reference or a Referenceable. If so
449 // we do some special processing.
450 Object ref2
= refInfo
;
451 if (refInfo
instanceof Referenceable
)
452 ref2
= ((Referenceable
) refInfo
).getReference ();
453 if (ref2
instanceof Reference
)
455 Reference ref
= (Reference
) ref2
;
457 // If we have a factory class name then we use that.
458 String fClass
= ref
.getFactoryClassName ();
461 // Exceptions here are passed to the caller.
462 Class k
= Class
.forName (fClass
,
464 Thread
.currentThread().getContextClassLoader());
465 factory
= (ObjectFactory
) k
.newInstance ();
469 // There's no factory class name. If the address is a
470 // StringRefAddr with address type `URL', then we try
471 // the URL's context factory.
472 Enumeration e
= ref
.getAll ();
473 while (e
.hasMoreElements ())
475 RefAddr ra
= (RefAddr
) e
.nextElement ();
476 if (ra
instanceof StringRefAddr
477 && "URL".equals (ra
.getType ()))
480 = (ObjectFactory
) getURLContext (refInfo
,
483 (String
) ra
.getContent (),
485 Object obj
= factory
.getObjectInstance (refInfo
,
494 // Have to try the next step.
499 // Now look at OBJECT_FACTORIES to find the factory.
502 StringTokenizer tokens
= getPlusPath (Context
.OBJECT_FACTORIES
,
503 environment
, nameCtx
);
505 while (tokens
.hasMoreTokens ())
507 String klassName
= tokens
.nextToken ();
508 Class k
= Class
.forName (klassName
,
510 Thread
.currentThread().getContextClassLoader());
511 factory
= (ObjectFactory
) k
.newInstance ();
512 Object obj
= factory
.getObjectInstance (refInfo
, name
,
513 nameCtx
, environment
);
525 Object obj
= factory
.getObjectInstance (refInfo
, name
,
526 nameCtx
, environment
);
527 return obj
== null ? refInfo
: obj
;
531 * Sets the initial context factory builder.
533 * @param builder the builder to set
535 * @throws SecurityException if the builder cannot be installed due
536 * security restrictions.
537 * @throws NamingException if the builder cannot be installed due other
539 * @throws IllegalStateException if setting the builder repeatedly
541 * @see #hasInitialContextFactoryBuilder()
543 public static void setInitialContextFactoryBuilder
544 (InitialContextFactoryBuilder builder
)
545 throws NamingException
547 SecurityManager sm
= System
.getSecurityManager ();
549 sm
.checkSetFactory ();
550 // Once the builder is installed it cannot be replaced.
552 throw new IllegalStateException ("ctx factory builder already installed");
558 * Creates a context in which the context operation must be continued.
559 * This method is used by operations on names that span multiple namespaces.
561 * @param cpe the exception that triggered this continuation. This method
562 * obtains the environment ({@link CannotProceedException#getEnvironment()}
563 * and sets the environment property {@link #CPE} = cpe.
565 * @return a non null context for continuing the operation
567 * @throws NamingException if the naming problems have occured
569 public static Context
getContinuationContext (CannotProceedException cpe
)
570 throws NamingException
572 Hashtable env
= cpe
.getEnvironment ();
576 // TODO: Check if this implementation matches the API specification
579 Object obj
= getObjectInstance (cpe
.getResolvedObj(),
581 cpe
.getAltNameCtx (),
584 return (Context
) obj
;
590 // fix stack trace for re-thrown exception (message confusing otherwise)
591 cpe
.fillInStackTrace();
597 * Get the object state for binding.
599 * @param obj the object, for that the binding state must be retrieved. Cannot
601 * @param name the name of this object, related to the nameCtx. Can be null if
603 * @param nameCtx the naming context, to that the object name is related. Can
604 * be null if the name is related to the initial default context.
605 * @param environment the properties for creating the object state. Can be
606 * null if no properties are provided.
607 * @return the object state for binding, may be null if no changes are
608 * returned by the factory
609 * @throws NamingException
611 public static Object
getStateToBind (Object obj
, Name name
,
612 Context nameCtx
, Hashtable environment
)
613 throws NamingException
615 StringTokenizer tokens
= getPlusPath (Context
.STATE_FACTORIES
,
616 environment
, nameCtx
);
617 while (tokens
.hasMoreTokens ())
619 String klassName
= tokens
.nextToken ();
622 Class k
= Class
.forName (klassName
,
624 Thread
.currentThread().getContextClassLoader());
625 StateFactory factory
= (StateFactory
) k
.newInstance ();
626 Object o
= factory
.getStateToBind (obj
, name
, nameCtx
,
631 catch (ClassNotFoundException _1
)
635 catch (ClassCastException _2
)
637 // This means that the class we found was not an
638 // ObjectFactory or that the factory returned something
639 // which was not a Context.
641 catch (InstantiationException _3
)
643 // If we couldn't instantiate the factory we might get
646 catch (IllegalAccessException _4
)
648 // Another possibility when instantiating.