This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
javax.naming.ldap
class InitialLdapContext
- All Implemented Interfaces:
- Context, DirContext, LdapContext
public class InitialLdapContext
extends InitialDirContext
implements LdapContext
This class is the starting context for performing
LDAPv3-style extended operations and controls.
See javax.naming.InitialContext and
javax.naming.InitialDirContext for details on synchronization,
and the policy for how an initial context is created.
Request Controls
When you create an initial context (InitialLdapContext),
you can specify a list of request controls.
These controls will be used as the request controls for any
implicit LDAP "bind" operation performed by the context or contexts
derived from the context. These are called connection request controls.
Use getConnectControls() to get a context's connection request
controls.
The request controls supplied to the initial context constructor
are not used as the context request controls
for subsequent context operations such as searches and lookups.
Context request controls are set and updated by using
setRequestControls().
As shown, there can be two different sets of request controls
associated with a context: connection request controls and context
request controls.
This is required for those applications needing to send critical
controls that might not be applicable to both the context operation and
any implicit LDAP "bind" operation.
A typical user program would do the following:
InitialLdapContext lctx = new InitialLdapContext(env, critConnCtls);
lctx.setRequestControls(critModCtls);
lctx.modifyAttributes(name, mods);
Controls[] respCtls = lctx.getResponseControls();
It specifies first the critical controls for creating the initial context
(critConnCtls), and then sets the context's request controls
(critModCtls) for the context operation. If for some reason
lctx needs to reconnect to the server, it will use
critConnCtls. See the LdapContext interface for
more discussion about request controls.
Service provider implementors should read the "Service Provider" section
in the LdapContext class description for implementation details.
Constructor Summary |
Constructs an initial context using no environment properties or
connection request controls.
|
Constructs an initial context
using environment properties and connection request controls.
|
Methods inherited from class javax.naming.directory.InitialDirContext |
bind, bind, createSubcontext, createSubcontext, getAttributes, getAttributes, getAttributes, getAttributes, getSchema, getSchema, getSchemaClassDefinition, getSchemaClassDefinition, modifyAttributes, modifyAttributes, modifyAttributes, modifyAttributes, rebind, rebind, search, search, search, search, search, search, search, search |
Methods inherited from class javax.naming.InitialContext |
addToEnvironment, bind, bind, close, composeName, composeName, createSubcontext, createSubcontext, destroySubcontext, destroySubcontext, doLookup, doLookup, getDefaultInitCtx, getEnvironment, getNameInNamespace, getNameParser, getNameParser, getURLOrDefaultInitCtx, getURLOrDefaultInitCtx, init, list, list, listBindings, listBindings, lookup, lookup, lookupLink, lookupLink, rebind, rebind, removeFromEnvironment, rename, rename, unbind, unbind |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
InitialLdapContext
public InitialLdapContext()
throws NamingException
-
Constructs an initial context using no environment properties or
connection request controls.
Equivalent to new InitialLdapContext(null, null).
- Throws:
NamingException
- if a naming exception is encountered
InitialLdapContext
public InitialLdapContext(Hashtable environment,
Control[] connCtls)
throws NamingException
-
Constructs an initial context
using environment properties and connection request controls.
See javax.naming.InitialContext for a discussion of
environment properties.
This constructor will not modify its parameters or
save references to them, but may save a clone or copy.
connCtls is used as the underlying context instance's
connection request controls. See the class description
for details.
- Parameters:
environment
- environment used to create the initial DirContext.
Null indicates an empty environment.
connCtls
- connection request controls for the initial context.
If null, no connection request controls are used.
- Throws:
NamingException
- if a naming exception is encountered
extendedOperation
public ExtendedResponse extendedOperation(ExtendedRequest request)
throws NamingException
-
- Parameters:
request
- Throws:
NamingException
getConnectControls
public Control[] getConnectControls()
throws NamingException
-
- Throws:
NamingException
getRequestControls
public Control[] getRequestControls()
throws NamingException
-
- Throws:
NamingException
getResponseControls
public Control[] getResponseControls()
throws NamingException
-
- Throws:
NamingException
newInstance
public LdapContext newInstance(Control[] reqCtls)
throws NamingException
-
- Parameters:
reqCtls
- Throws:
NamingException
reconnect
public void reconnect(Control[] connCtls)
throws NamingException
-
- Parameters:
connCtls
- Throws:
NamingException
setRequestControls
public void setRequestControls(Control[] requestControls)
throws NamingException
-
- Parameters:
requestControls
- Throws:
NamingException
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.