This interface represents a factory for obtaining the state of an object and corresponding attributes for binding.

The JNDI framework allows for object implementations to be loaded in dynamically via object factories.

A DirStateFactory extends StateFactory by allowing an Attributes instance to be supplied to and be returned by the getStateToBind() method. DirStateFactory implementations are intended to be used by DirContext service providers. When a caller binds an object using DirContext.bind(), he might also specify a set of attributes to be bound with the object. The object and attributes to be bound are passed to the getStateToBind() method of a factory. If the factory processes the object and attributes, it returns a corresponding pair of object and attributes to be bound. If the factory does not process the object, it must return null.

For example, a caller might bind a printer object with some printer-related attributes.

 ctx.rebind("inky", printer, printerAttrs);

An LDAP service provider for ctx uses a DirStateFactory (indirectly via DirectoryManager.getStateToBind()) and gives it printer and printerAttrs. A factory for an LDAP directory might turn printer into a set of attributes and merge that with printerAttrs. The service provider then uses the resulting attributes to create an LDAP entry and updates the directory.

Since DirStateFactory extends StateFactory, it has two getStateToBind() methods, where one differs from the other by the attributes argument. DirectoryManager.getStateToBind() will only use the form that accepts the attributes argument, while NamingManager.getStateToBind() will only use the form that does not accept the attributes argument.

Either form of the getStateToBind() method of a DirStateFactory may be invoked multiple times, possibly using different parameters. The implementation is thread-safe.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	DirStateFactory.Result An object/attributes pair for returning the result of DirStateFactory.getStateToBind().

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public DirStateFactory.Result	Returns: A `Result` containing the object's state for binding and the corresponding attributes to be bound; null if the object don't use this factory. getStateToBind(Object A possibly null object whose state is to be retrieved. 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 object's state. environment, Attributes The possibly null attributes to be bound with the object. The factory must not modify `inAttrs`. inAttrs) Retrieves the state of an object for binding given the object and attributes to be transformed.

public DirStateFactory.Result

Returns:

A Result containing the object's state for binding and the corresponding attributes to be bound; null if the object don't use this factory.

getStateToBind(Object

A possibly null object whose state is to be retrieved.

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 object's state.

environment, Attributes

The possibly null attributes to be bound with the object. The factory must not modify inAttrs.

inAttrs)

Retrieves the state of an object for binding given the object and attributes to be transformed.

Inherited from javax.naming.spi.StateFactory:: getStateToBind

Method Detail

getStateToBind back to summary

getStateToBind	back to summary
public DirStateFactory.Result getStateToBind(Object obj, Name name, Context nameCtx, Hashtable<?, ?> environment, Attributes inAttrs) throws NamingException Retrieves the state of an object for binding given the object and attributes to be transformed. `DirectoryManager.getStateToBind()` successively loads in state factories. If a factory implements `DirStateFactory`, `DirectoryManager` invokes this method; otherwise, it invokes `StateFactory.getStateToBind()`. It does this until a factory produces a non-null answer. When an exception is thrown by a factory, the exception is passed on to the caller of `DirectoryManager.getStateToBind()`. The search for other factories that may produce a non-null answer is halted. A factory should only throw an exception if it is sure that it is the only intended factory and that no other factories should be tried. If this factory cannot create an object using the arguments supplied, it should return null. The `name` and `nameCtx` parameters may optionally be used to specify the name of the object being created. See the description of "Name and Context Parameters" in `ObjectFactory.getObjectInstance()` for details. If a factory uses `nameCtx` it should synchronize its use against concurrent access, since context implementations are not guaranteed to be thread-safe. The `name`, `inAttrs`, and `environment` parameters are owned by the caller. The implementation will not modify these objects or keep references to them, although it may keep references to clones or copies. 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 `inAttrs` parameter. Parameters obj:Object A possibly null object whose state is to be retrieved. 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 object's state. inAttrs:Attributes The possibly null attributes to be bound with the object. The factory must not modify `inAttrs`. Returns:DirStateFactory.Result A `Result` containing the object's state for binding and the corresponding attributes to be bound; null if the object don't use this factory. Exceptions NamingException: If this factory encountered an exception while attempting to get the object's state, and no other factories are to be tried. See Also `DirectoryManager#getStateToBind`

public DirStateFactory.Result getStateToBind(Object obj, Name name, Context nameCtx, Hashtable<?, ?> environment, Attributes inAttrs) throws NamingException

Retrieves the state of an object for binding given the object and attributes to be transformed.

DirectoryManager.getStateToBind() successively loads in state factories. If a factory implements DirStateFactory, DirectoryManager invokes this method; otherwise, it invokes StateFactory.getStateToBind(). It does this until a factory produces a non-null answer.

When an exception is thrown by a factory, the exception is passed on to the caller of DirectoryManager.getStateToBind(). The search for other factories that may produce a non-null answer is halted. A factory should only throw an exception if it is sure that it is the only intended factory and that no other factories should be tried. If this factory cannot create an object using the arguments supplied, it should return null.

The name and nameCtx parameters may optionally be used to specify the name of the object being created. See the description of "Name and Context Parameters" in ObjectFactory.getObjectInstance() for details. If a factory uses nameCtx it should synchronize its use against concurrent access, since context implementations are not guaranteed to be thread-safe.

The name, inAttrs, and environment parameters are owned by the caller. The implementation will not modify these objects or keep references to them, although it may keep references to clones or copies. 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 inAttrs parameter.

Parameters

obj:Object: A possibly null object whose state is to be retrieved.
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 object's state.
inAttrs:Attributes: The possibly null attributes to be bound with the object. The factory must not modify inAttrs.

Returns:DirStateFactory.Result

A Result containing the object's state for binding and the corresponding attributes to be bound; null if the object don't use this factory.

Exceptions

NamingException:: If this factory encountered an exception while attempting to get the object's state, and no other factories are to be tried.

See Also

DirectoryManager#getStateToBind

javax.naming.spi back to summary

public Class DirStateFactory.Result

Class Inheritance

extends Object

java.lang.Object
javax.naming.spi.DirStateFactory.Result

An object/attributes pair for returning the result of DirStateFactory.getStateToBind().

Field Summary

Modifier and Type	Field and Description
private Attributes	attrs The possibly null attributes to be bound.
private Object	obj The possibly null object to be bound.

Constructor Summary

Access	Constructor and Description
public	Result(Object The possibly null object to be bound. obj, Attributes The possibly null attributes to be bound. outAttrs) Constructs an instance of Result.

Method Summary

Modifier and Type	Method and Description
public Attributes	Returns: The possibly null attributes to be bound. getAttributes() Retrieves the attributes to be bound.
public Object	Returns: The possibly null object to be bound. getObject() Retrieves the object to be bound.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

attrs	back to summary
private Attributes attrs The possibly null attributes to be bound.

obj	back to summary
private Object obj The possibly null object to be bound.

Constructor Detail

Result	back to summary
public Result(Object obj, Attributes outAttrs) Constructs an instance of Result. Parameters obj:Object The possibly null object to be bound. outAttrs:Attributes The possibly null attributes to be bound.

Result

back to summary

public Result(Object obj, Attributes outAttrs)

Constructs an instance of Result.

Parameters

obj:Object: The possibly null object to be bound.
outAttrs:Attributes: The possibly null attributes to be bound.

Method Detail

getAttributes	back to summary
public Attributes getAttributes() Retrieves the attributes to be bound. Returns:Attributes The possibly null attributes to be bound.

getAttributes

back to summary

public Attributes getAttributes()

Retrieves the attributes to be bound.

Returns:Attributes: The possibly null attributes to be bound.

getObject	back to summary
public Object getObject() Retrieves the object to be bound. Returns:Object The possibly null object to be bound.

getObject

back to summary

public Object getObject()

Retrieves the object to be bound.

Returns:Object: The possibly null object to be bound.

public Interface DirStateFactory

Nested and Inner Type Summary

Method Summary

Method Detail

public Class DirStateFactory.Result

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail