public class DirectoryManager extends NamingManager
This class contains methods for supporting DirContext
implementations.
This class is an extension of NamingManager
. It contains methods for use by service providers for accessing object factories and state factories, and for getting continuation contexts for supporting federation.
DirectoryManager
is safe for concurrent access by multiple threads.
Except as otherwise noted, a Name
, Attributes
, or environment parameter passed to any method is owned by the caller. The implementation will not modify the object or keep a reference to it, although it may keep a reference to a clone or copy.
DirObjectFactory
, DirStateFactory
CPE
public static DirContext getContinuationDirContext(CannotProceedException cpe) throws NamingException
Creates a context in which to continue a DirContext
operation. Operates just like NamingManager.getContinuationContext()
, only the continuation context returned is a DirContext
.
cpe
- The non-null exception that triggered this continuation.DirContext
object for continuing the operation.NamingException
- If a naming exception occurred.NamingManager.getContinuationContext(CannotProceedException)
public static Object getObjectInstance(Object refInfo, Name name, Context nameCtx, Hashtable<?,?> environment, Attributes attrs) throws Exception
Creates an instance of an object for the specified object, attributes, and environment.
This method is the same as NamingManager.getObjectInstance
except for the following differences:
Attributes
parameter that contains attributes associated with the object. The DirObjectFactory
might use these attributes to save having to look them up from the directory. ObjectFactory
or DirObjectFactory
. If it implements DirObjectFactory
, DirObjectFactory.getObjectInstance()
is used, otherwise, ObjectFactory.getObjectInstance()
is used. DirContext
interface should use this method, not NamingManager.getObjectInstance()
.
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.attrs
- The possibly null attributes associated with refInfo. This might not be the complete set of attributes for refInfo; you might be able to read more attributes from the directory.refInfo
and attrs
; or refInfo
if an object cannot be created by a factory.NamingException
- If a naming exception was encountered while attempting to get a URL context, or if one of the factories accessed throws a NamingException.Exception
- If one of the factories accessed throws an exception, or if an error was encountered while loading and instantiating the factory and object classes. A factory should only throw an exception if it does not want other factories to be used in an attempt to create an object. See DirObjectFactory.getObjectInstance()
.NamingManager.getURLContext(java.lang.String, java.util.Hashtable<?, ?>)
, DirObjectFactory
, DirObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable<?, ?>, javax.naming.directory.Attributes)
public static DirStateFactory.Result getStateToBind(Object obj, Name name, Context nameCtx, Hashtable<?,?> environment, Attributes attrs) throws NamingException
Retrieves the state of an object for binding when given the original object and its attributes.
This method is like NamingManager.getStateToBind
except for the following differences:
Attributes
parameter containing attributes that were passed to the DirContext.bind()
method. DirStateFactory.Result
instance containing the object to be bound, and the attributes to accompany the binding. Either the object or the attributes may be null. StateFactory
or DirStateFactory
. If it implements DirStateFactory
, then DirStateFactory.getStateToBind()
is called; otherwise, StateFactory.getStateToBind()
is called. DirContext
interface should use this method, not NamingManager.getStateToBind()
. See NamingManager.getStateToBind() for a description of how the list of state factories to be tried is determined.
The object returned by this method is owned by the caller. The implementation will not subsequently modify it. It will contain either a new Attributes
object that is likewise owned by the caller, or a reference to the original attrs
parameter.
obj
- The non-null object for which to get state to bind.name
- The name of this object relative to nameCtx
, or null if no name is specified.nameCtx
- The context relative to which the name
parameter is specified, or null if name
is relative to the default initial context.environment
- The possibly null environment to be used in the creation of the state factory and the object's state.attrs
- The possibly null Attributes that is to be bound with the object.obj
) itself with the original attributes.NamingException
- If a naming exception was encountered while using the factories. A factory should only throw an exception if it does not want other factories to be used in an attempt to create an object. See DirStateFactory.getStateToBind()
.DirStateFactory
, DirStateFactory.getStateToBind(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable<?, ?>, javax.naming.directory.Attributes)
, NamingManager.getStateToBind(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable<?, ?>)
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.