OpenJDK 27 · com.sun.jndi.ldap.LdapCtxFactory · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final String	ADDRESS_TYPE The type of each address in an LDAP reference.

Access	Constructor and Description
public	LdapCtxFactory()

Method Summary

Modifier and Type	Method and Description
public static Attribute	createTypeNameAttr(Class<?> cl) Used by Obj and obj/RemoteToAttrs too so must be public
private static void	getClassesAux(Class<?> currentClass, Vector<String> v)
public Context	getInitialContext(Hashtable<?, ?> envprops) Implements javax.naming.spi.InitialContextFactory.getInitialContext. Creates an Initial Context for beginning name resolution.
private static LdapCtx	getLdapCtxFromUrl(String domain, String url, LdapURL u, Hashtable<?, ?> env)
public static DirContext	getLdapCtxInstance(Object urlInfo, Hashtable<?, ?> env)
public Object	getObjectInstance(Object ref, Name name, Context nameCtx, Hashtable<?, ?> env) Implements javax.naming.spi.ObjectFactory.getObjectInstance. Creates an object using the location or reference information specified.
private static String[]	getTypeNames(Class<?> currentClass, Vector<String> v)
private static String[]	getURLs(Reference ref) Returns the URLs contained within an LDAP reference.
private static DirContext	getUsingURL(String url, Hashtable<?, ?> env)
private static DirContext	getUsingURLs(String[] urls, Hashtable<?, ?> env)
private static boolean	isLdapRef(Object obj) Returns true if argument is an LDAP reference.

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

ADDRESS_TYPE	back to summary
public static final String ADDRESS_TYPE The type of each address in an LDAP reference.

LdapCtxFactory	back to summary
public LdapCtxFactory()

Method Detail

createTypeNameAttr	back to summary
public static Attribute createTypeNameAttr(Class<?> cl) Used by Obj and obj/RemoteToAttrs too so must be public

getClassesAux	back to summary
private static void getClassesAux(Class<?> currentClass, Vector<String> v)

getInitialContext back to summary

getInitialContext	back to summary
public Context getInitialContext(Hashtable<?, ?> envprops) throws NamingException Implements javax.naming.spi.InitialContextFactory.getInitialContext. Doc from javax.naming.spi.InitialContextFactory.getInitialContext. Creates an Initial Context for beginning name resolution. Special requirements of this context are supplied using `environment`. The environment parameter 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. Exceptions NamingException: If cannot create an initial context.

public Context getInitialContext(Hashtable<?, ?> envprops) throws NamingException

Implements javax.naming.spi.InitialContextFactory.getInitialContext.

Doc from javax.naming.spi.InitialContextFactory.getInitialContext.

Creates an Initial Context for beginning name resolution. Special requirements of this context are supplied using environment.

The environment parameter 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.

Exceptions

NamingException:: If cannot create an initial context.

getLdapCtxFromUrl	back to summary
private static LdapCtx getLdapCtxFromUrl(String domain, String url, LdapURL u, Hashtable<?, ?> env) throws NamingException

getLdapCtxInstance	back to summary
public static DirContext getLdapCtxInstance(Object urlInfo, Hashtable<?, ?> env) throws NamingException

getObjectInstance back to summary

getObjectInstance	back to summary
public Object getObjectInstance(Object ref, Name name, Context nameCtx, Hashtable<?, ?> env) throws Exception Implements javax.naming.spi.ObjectFactory.getObjectInstance. Doc from javax.naming.spi.ObjectFactory.getObjectInstance. Creates an object using the location or reference information specified. Special requirements of this object are supplied using `environment`. An example of such an environment property is user identity information. `NamingManager.getObjectInstance()` successively loads in object factories and invokes this method on them until one produces a non-null answer. When an exception is thrown by an object factory, the exception is passed on to the caller of `NamingManager.getObjectInstance()` (and no search is made for other factories that may produce a non-null answer). An object factory should only throw an exception if it is sure that it is the only intended factory and that no other object factories should be tried. If this factory cannot create an object using the arguments supplied, it should return null. A URL context factory is a special ObjectFactory that creates contexts for resolving URLs or objects whose locations are specified by URLs. The `getObjectInstance()` method of a URL context factory will obey the following rules. If `obj` is null, create a context for resolving URLs of the scheme associated with this factory. The resulting context is not tied to a specific URL: it is able to handle arbitrary URLs with this factory's scheme id. For example, invoking `getObjectInstance()` with `obj` set to null on an LDAP URL context factory would return a context that can resolve LDAP URLs such as "ldap://ldap.wiz.com/o=wiz,c=us" and "ldap://ldap.umich.edu/o=umich,c=us". If `obj` is a URL string, create an object (typically a context) identified by the URL. For example, suppose this is an LDAP URL context factory. If `obj` is "ldap://ldap.wiz.com/o=wiz,c=us", getObjectInstance() would return the context named by the distinguished name "o=wiz, c=us" at the LDAP server ldap.wiz.com. This context can then be used to resolve LDAP names (such as "cn=George") relative to that context. If `obj` is an array of URL strings, the assumption is that the URLs are equivalent in terms of the context to which they refer. Verification of whether the URLs are, or need to be, equivalent is up to the context factory. The order of the URLs in the array is not significant. The object returned by getObjectInstance() is like that of the single URL case. It is the object named by the URLs. If `obj` is of any other type, the behavior of `getObjectInstance()` is determined by the context factory implementation. The `name` 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. Name and Context Parameters. 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`. 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. If a factory uses `nameCtx` it should synchronize its use against concurrent access, since context implementations are not guaranteed to be thread-safe. Exceptions Exception: if this object factory encountered an exception while attempting to create an object, and no other object factories are to be tried.

public Object getObjectInstance(Object ref, Name name, Context nameCtx, Hashtable<?, ?> env) throws Exception

Implements javax.naming.spi.ObjectFactory.getObjectInstance.

Doc from javax.naming.spi.ObjectFactory.getObjectInstance.

Creates an object using the location or reference information specified.

Special requirements of this object are supplied using environment. An example of such an environment property is user identity information.

NamingManager.getObjectInstance() successively loads in object factories and invokes this method on them until one produces a non-null answer. When an exception is thrown by an object factory, the exception is passed on to the caller of NamingManager.getObjectInstance() (and no search is made for other factories that may produce a non-null answer). An object factory should only throw an exception if it is sure that it is the only intended factory and that no other object factories should be tried. If this factory cannot create an object using the arguments supplied, it should return null.

A URL context factory is a special ObjectFactory that creates contexts for resolving URLs or objects whose locations are specified by URLs. The getObjectInstance() method of a URL context factory will obey the following rules.

If obj is null, create a context for resolving URLs of the scheme associated with this factory. The resulting context is not tied to a specific URL: it is able to handle arbitrary URLs with this factory's scheme id. For example, invoking getObjectInstance() with obj set to null on an LDAP URL context factory would return a context that can resolve LDAP URLs such as "ldap://ldap.wiz.com/o=wiz,c=us" and "ldap://ldap.umich.edu/o=umich,c=us".
If obj is a URL string, create an object (typically a context) identified by the URL. For example, suppose this is an LDAP URL context factory. If obj is "ldap://ldap.wiz.com/o=wiz,c=us", getObjectInstance() would return the context named by the distinguished name "o=wiz, c=us" at the LDAP server ldap.wiz.com. This context can then be used to resolve LDAP names (such as "cn=George") relative to that context.
If obj is an array of URL strings, the assumption is that the URLs are equivalent in terms of the context to which they refer. Verification of whether the URLs are, or need to be, equivalent is up to the context factory. The order of the URLs in the array is not significant. The object returned by getObjectInstance() is like that of the single URL case. It is the object named by the URLs.
If obj is of any other type, the behavior of getObjectInstance() is determined by the context factory implementation.

The name 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.

Name and Context Parameters. 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. 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. If a factory uses nameCtx it should synchronize its use against concurrent access, since context implementations are not guaranteed to be thread-safe.

Exceptions

Exception:: if this object factory encountered an exception while attempting to create an object, and no other object factories are to be tried.

getTypeNames	back to summary
private static String[] getTypeNames(Class<?> currentClass, Vector<String> v)

getURLs	back to summary
private static String[] getURLs(Reference ref) throws NamingException Returns the URLs contained within an LDAP reference.

getUsingURL	back to summary
private static DirContext getUsingURL(String url, Hashtable<?, ?> env) throws NamingException

getUsingURLs	back to summary
private static DirContext getUsingURLs(String[] urls, Hashtable<?, ?> env) throws NamingException

isLdapRef	back to summary
private static boolean isLdapRef(Object obj) Returns true if argument is an LDAP reference.

public final Class LdapCtxFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail