|
JNDI 1.1.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.naming.spi.NamingManager
This class contains methods for creating context objects and objects referred to by location information in the naming or directory service.
This class is cannot be instantiated. You only perform static methods against it.
The mention of URL in the documentation for this class refers to a URL string as defined by RFC 1738 and its related RFCs. It is any string that conforms to the syntax described therein, and may not always have corresponding support in the java.net.URL class or Web browsers.
NamingManager is safe for concurrent access by multiple threads.
Method Summary | |
static Context |
getContinuationContext(CannotProceedException cpe)
Creates a context in which to continue a context operation. |
static Context |
getInitialContext(java.util.Hashtable environment)
Creates an initial context using the specified environment properties. |
static java.lang.Object |
getObjectInstance(java.lang.Object refInfo,
Name name,
Context nameCtx,
java.util.Hashtable environment)
Creates an instance of an object for the specified object and environment. |
static Context |
getURLContext(java.lang.String scheme,
java.util.Hashtable environment)
Creates a context for the given URL scheme id. |
static boolean |
hasInitialContextFactoryBuilder()
Determines whether an initial context factory builder has been set. |
static void |
setInitialContextFactoryBuilder(InitialContextFactoryBuilder builder)
Sets the InitialContextFactory builder to be builder. |
static void |
setObjectFactoryBuilder(ObjectFactoryBuilder builder)
The ObjectFactoryBuilder determines the policy used when trying to load object factories. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Method Detail |
public static void setObjectFactoryBuilder(ObjectFactoryBuilder builder) throws NamingException
setObjectFactoryBuilder() overrides this policy by installing its own ObjectFactoryBuilder. Subsequent object factories will be loaded and created using the installed builder.
The builder can only be installed if the executing thread is allowed by the security manager to do so. Once installed, the builder cannot be replaced.
builder
- The factory builder to install. If null, no builder
is installed.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable)
,
ObjectFactory
,
ObjectFactoryBuilder
,
SecurityManager.checkSetFactory()
public static java.lang.Object getObjectInstance(java.lang.Object refInfo, Name name, Context nameCtx, java.util.Hashtable environment) throws java.lang.Exception
If an object factory builder has been installed, use it to create a factory for creating the object. Otherwise, the following rules are used to create the object:
refInfo
is a Reference
or Referenceable
, and it contains a factory class name,
use information
in the reference to create a factory for creating the object
and return the object. If such a factory cannot be created,
return refInfo
. Note that if an exception
is encountered while creating the factory, the exception is
passed up to the caller of getObjectInstance().
Note that in order for classes to be loaded from the URL
specified in the reference, a SecurityManager
must have
been installed. If there is no SecurityManager
installed,
the classes will not be loaded.
refInfo
is a URL string, or an array of URL strings,
use the URL context factory corresponding to the URL's scheme id to
create the object (see getURLContext()).
If that fails, continue to step 3.
refInfo
.
If an exception is encountered while creating the object, the
exception is passed up to the caller.
Note that an object factory (an object that implements the ObjectFactory interface) must be public and must have a public constructor that accepts no arguments.
The name
and nameCtx
parameters may
optionally be used to specify the name of the object being created.
name
is the name of the object, relative to context
nameCtx
. This information could be useful to the object
factory or to the object implementation.
If there are several possible contexts from which the object
could be named -- as will often be the case -- it is up to
the caller to select one. A good rule of thumb is to select the
"deepest" context available.
If nameCtx
is null, name
is relative
to the default initial context. If no name is being specified, the
name
parameter should be null.
refInfo
- The possibly null object for which to create an object.name
- The name of this object relative to nameCtx
.
Specifying a name is optional; if it is
omitted, name
should be null.nameCtx
- The context relative to which the name
parameter is specified. If null, name
is
relative to the default initial context.environment
- The possibly null environment to
be used in the creation of the object factory and the object.refInfo
; or
refInfo
if an object cannot be created using
the algorithm described above.getURLContext(java.lang.String, java.util.Hashtable)
,
ObjectFactory
,
ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable)
public static Context getURLContext(java.lang.String scheme, java.util.Hashtable environment) throws NamingException
The resulting context is for resolving URLs of the
scheme scheme
. The resulting context is not tied
to a specific URL. It is able to handle arbitrary URLs with
the specified scheme.
The class name of the factory that creates the resulting context has the naming convention scheme-idURLContextFactory (e.g. "ftpURLContextFactory" for the "ftp" scheme-id), in the package specified as follows. The Context.URL_PKG_PREFIXES environment or system property contains a colon-separated list of package prefixes. If both properties exist, the environment property takes precedence. Each package prefix in the property is tried in the order specified to load the factory class. The default package prefix is "com.sun.jndi.url" (if none of the specified packages work, this default is tried). The complete package name is constructed using the package prefix, concatenated with the scheme id.
For example, if the scheme id is "ldap", and the Context.URL_PKG_PREFIXES property contains "com.widget:com.wiz.jndi", the naming manager would attempt to load the following classes until one is successfully instantiated:
If a factory is instantiated, it is invoked with the following parameters to produce the resulting context.
factory.getObjectInstance(null, environment);
For example, invoking getObjectInstance() as shown above on a LDAP URL context factory would return a context that can resolve LDAP urls (e.g. "ldap://ldap.wiz.com/o=wiz,c=us", "ldap://ldap.umich.edu/o=umich,c=us", ...).
Note that an object factory (an object that implements the ObjectFactory interface) must be public and must have a public constructor that accepts no arguments.
scheme
- The non-null scheme-id of the URLs supported by the context.environment
- The possibly null environment properties to be
used in the creation of the object factory and the context.scheme
;
null
if the factory for creating the
context is not found.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable)
,
ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable)
public static Context getInitialContext(java.util.Hashtable environment) throws NamingException
If an InitialContextFactoryBuilder has been installed, it is used to create the factory for creating the initial context. Otherwise, the class specified in the Context.INITIAL_CONTEXT_FACTORY system or environment property is used. If both properties exist, the environment property takes precedence. Note that an initial context factory (an object that implements the InitialContextFactory interface) must be public and must have a public constructor that accepts no arguments.
environment
- The possibly null environment properties used when
creating the context.InitialContext
,
InitialDirContext
public static void setInitialContextFactoryBuilder(InitialContextFactoryBuilder builder) throws NamingException
The builder can only be installed if the executing thread is allowed by the security manager to do so. Once installed, the builder cannot be replaced.
builder
- The initial context factory builder to install. If null,
no builder is set.hasInitialContextFactoryBuilder()
,
SecurityManager.checkSetFactory()
public static boolean hasInitialContextFactoryBuilder()
setInitialContextFactoryBuilder(javax.naming.spi.InitialContextFactoryBuilder)
public static Context getContinuationContext(CannotProceedException cpe) throws NamingException
In performing an operation on a name that spans multiple
namespaces, a context from one naming system may need to pass
the operation on to the next naming system. The context
implementation does this by first constructing a
CannotProceedException
containing information
pinpointing how far it has proceeded. It then obtains a
continuation context from JNDI by calling
getContinuationContext
. The context
implementation should then resume the context operation by
invoking the same operation on the continuation context, using
the remainder of the name that has not yet been resolved.
cpe
- The non-null exception that triggered this continuation.
|
JNDI 1.1.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |