OpenJDK 27 · javax.naming.spi.DirectoryManager · APIdia, the JavaDoc alternative

Access	Constructor and Description
pack-priv	DirectoryManager()

Method Summary

Modifier and Type	Method and Description
public static DirContext	Returns: A non-null `DirContext` object for continuing the operation. getContinuationDirContext(CannotProceedException The non-null exception that triggered this continuation. cpe) Creates a context in which to continue a `DirContext` operation.
public static Object	Returns: An object created using `refInfo` and `attrs`; or `refInfo` if an object cannot be created by a factory. getObjectInstance(Object The possibly null object for which to create an object. refInfo, Name The name of this object relative to `nameCtx`. Specifying a name is optional; if it is omitted, `name` should be null. name, Context The context relative to which the `name` parameter is specified. If null, `name` is relative to the default initial context. nameCtx, Hashtable<?, ?> The possibly null environment to be used in the creation of the object factory and the object. environment, Attributes 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. attrs) Creates an instance of an object for the specified object, attributes, and environment.
public static DirStateFactory.Result	Returns: A non-null DirStateFactory.Result containing the object and attributes to be bound. If no state factory returns a non-null answer, the result will contain the object (`obj`) itself with the original attributes. getStateToBind(Object The non-null object for which to get state to bind. obj, Name The name of this object relative to `nameCtx`, or null if no name is specified. name, Context The context relative to which the `name` parameter is specified, or null if `name` is relative to the default initial context. nameCtx, Hashtable<?, ?> The possibly null environment to be used in the creation of the state factory and the object's state. environment, Attributes The possibly null Attributes that is to be bound with the object. attrs) Retrieves the state of an object for binding when given the original object and its attributes.

Inherited from javax.naming.spi.NamingManager:: getContext getContinuationContext getInitialContext getObjectFactoryBuilder getObjectInstance getResolver getStateToBind getURLContext hasInitialContextFactoryBuilder setInitialContextFactoryBuilder setObjectFactoryBuilder

DirectoryManager	back to summary
pack-priv DirectoryManager()

Method Detail

getContinuationDirContext back to summary

getContinuationDirContext	back to summary
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`. Parameters cpe:CannotProceedException The non-null exception that triggered this continuation. Returns:DirContext A non-null `DirContext` object for continuing the operation. Annotations @SuppressWarnings:unchecked Exceptions NamingException: If a naming exception occurred. See Also `NamingManager#getContinuationContext(CannotProceedException)`

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.

Parameters

cpe:CannotProceedException: The non-null exception that triggered this continuation.

Returns:DirContext

A non-null DirContext object for continuing the operation.

Annotations

@SuppressWarnings:unchecked

Exceptions

NamingException:: If a naming exception occurred.

getObjectInstance back to summary

getObjectInstance	back to summary
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: It accepts an `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. The object factories tried must implement either `ObjectFactory` or `DirObjectFactory`. If it implements `DirObjectFactory`, `DirObjectFactory.getObjectInstance()` is used, otherwise, `ObjectFactory.getObjectInstance()` is used. Service providers that implement the `DirContext` interface should use this method, not `NamingManager.getObjectInstance()`. Parameters refInfo:Object The possibly null object for which to create an object. name:Name The name of this object relative to `nameCtx`. Specifying a name is optional; if it is omitted, `name` should be null. nameCtx:Context The context relative to which the `name` parameter is specified. If null, `name` is relative to the default initial context. environment:Hashtable<?, ?> The possibly null environment to be used in the creation of the object factory and the object. attrs:Attributes 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. Returns:Object An object created using `refInfo` and `attrs`; or `refInfo` if an object cannot be created by a factory. Exceptions 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()`. NamingException: If a naming exception was encountered while attempting to get a URL context, or if one of the factories accessed throws a NamingException. Since 1.3 See Also `NamingManager#getURLContext`, `DirObjectFactory`, `DirObjectFactory#getObjectInstance`

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:

It accepts an 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.
The object factories tried must implement either ObjectFactory or DirObjectFactory. If it implements DirObjectFactory, DirObjectFactory.getObjectInstance() is used, otherwise, ObjectFactory.getObjectInstance() is used.

Service providers that implement the DirContext interface should use this method, not NamingManager.getObjectInstance().

Parameters

refInfo:Object: The possibly null object for which to create an object.
name:Name: The name of this object relative to nameCtx. Specifying a name is optional; if it is omitted, name should be null.
nameCtx:Context: The context relative to which the name parameter is specified. If null, name is relative to the default initial context.
environment:Hashtable<?, ?>: The possibly null environment to be used in the creation of the object factory and the object.
attrs:Attributes: 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.

Returns:Object

An object created using refInfo and attrs; or refInfo if an object cannot be created by a factory.

Exceptions

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().
NamingException:: If a naming exception was encountered while attempting to get a URL context, or if one of the factories accessed throws a NamingException.

Since

1.3

getStateToBind back to summary

getStateToBind	back to summary
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: It accepts an `Attributes` parameter containing attributes that were passed to the `DirContext.bind()` method. It returns a non-null `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. The state factories tried must each implement either `StateFactory` or `DirStateFactory`. If it implements `DirStateFactory`, then `DirStateFactory.getStateToBind()` is called; otherwise, `StateFactory.getStateToBind()` is called. Service providers that implement the `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. Parameters obj:Object The non-null object for which to get state to bind. name:Name The name of this object relative to `nameCtx`, or null if no name is specified. nameCtx:Context The context relative to which the `name` parameter is specified, or null if `name` is relative to the default initial context. environment:Hashtable<?, ?> The possibly null environment to be used in the creation of the state factory and the object's state. attrs:Attributes The possibly null Attributes that is to be bound with the object. Returns:DirStateFactory.Result A non-null DirStateFactory.Result containing the object and attributes to be bound. If no state factory returns a non-null answer, the result will contain the object (`obj`) itself with the original attributes. Exceptions 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()`. Since 1.3 See Also `DirStateFactory`, `DirStateFactory#getStateToBind`, `NamingManager#getStateToBind`

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:

It accepts an Attributes parameter containing attributes that were passed to the DirContext.bind() method.
It returns a non-null 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.
The state factories tried must each implement either StateFactory or DirStateFactory. If it implements DirStateFactory, then DirStateFactory.getStateToBind() is called; otherwise, StateFactory.getStateToBind() is called.

Service providers that implement the 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.

Parameters

obj:Object: The non-null object for which to get state to bind.
name:Name: The name of this object relative to nameCtx, or null if no name is specified.
nameCtx:Context: The context relative to which the name parameter is specified, or null if name is relative to the default initial context.
environment:Hashtable<?, ?>: The possibly null environment to be used in the creation of the state factory and the object's state.
attrs:Attributes: The possibly null Attributes that is to be bound with the object.

Returns:DirStateFactory.Result

A non-null DirStateFactory.Result containing the object and attributes to be bound. If no state factory returns a non-null answer, the result will contain the object (obj) itself with the original attributes.

Exceptions

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().

Since

1.3

public Class DirectoryManager

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail