- All Superinterfaces:
public interface DirStateFactory extends StateFactoryThis 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
StateFactoryby allowing an
Attributesinstance to be supplied to and be returned by the
DirStateFactoryimplementations are intended to be used by
DirContextservice 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.
An LDAP service provider for
ctx.rebind("inky", printer, printerAttrs);
DirectoryManager.getStateToBind()) and gives it
printerAttrs. A factory for an LDAP directory might turn
printerinto 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.
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 Class Summary
Nested Classes Modifier and Type Interface Description
DirStateFactory.ResultAn object/attributes pair for returning the result of DirStateFactory.getStateToBind().
All Methods Instance Methods Abstract Methods Modifier and Type Method Description
getStateToBind(Object obj, Name name, Context nameCtx, Hashtable<?,?> environment, Attributes inAttrs)Retrieves the state of an object for binding given the object and attributes to be transformed.
DirStateFactory.Result getStateToBind(Object obj, Name name, Context nameCtx, Hashtable<?,?> environment, Attributes inAttrs) throws NamingExceptionRetrieves 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
DirectoryManagerinvokes 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.
nameCtxparameters 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
nameCtxit should synchronize its use against concurrent access, since context implementations are not guaranteed to be thread-safe.
environmentparameters 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
Attributesobject that is likewise owned by the caller, or a reference to the original
obj- A possibly null object whose state is to be retrieved.
name- The name of this object relative to
nameCtx, or null if no name is specified.
nameCtx- The context relative to which the
nameparameter is specified, or null if
nameis relative to the default initial context.
environment- The possibly null environment to be used in the creation of the object's state.
inAttrs- The possibly null attributes to be bound with the object. The factory must not modify
Resultcontaining the object's state for binding and the corresponding attributes to be bound; null if the object don't use this factory.
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(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable<?, ?>, javax.naming.directory.Attributes)