public class InitialLdapContext extends InitialDirContext implements LdapContext
See javax.naming.InitialContext and javax.naming.InitialDirContext for details on synchronization, and the policy for how an initial context is created.
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:
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.InitialLdapContext lctx = new InitialLdapContext(env, critConnCtls); lctx.setRequestControls(critModCtls); lctx.modifyAttributes(name, mods); Controls[] respCtls = lctx.getResponseControls();
Service provider implementors should read the "Service Provider" section in the LdapContext class description for implementation details.
defaultInitCtx, gotDefault, myPropsCONTROL_FACTORIESADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTEAPPLET, AUTHORITATIVE, BATCHSIZE, DNS_URL, INITIAL_CONTEXT_FACTORY, LANGUAGE, OBJECT_FACTORIES, PROVIDER_URL, REFERRAL, SECURITY_AUTHENTICATION, SECURITY_CREDENTIALS, SECURITY_PRINCIPAL, SECURITY_PROTOCOL, STATE_FACTORIES, URL_PKG_PREFIXES| Constructor and Description |
|---|
InitialLdapContext()
Constructs an initial context using no environment properties or
connection request controls.
|
InitialLdapContext(Hashtable<?,?> environment,
Control[] connCtls)
Constructs an initial context
using environment properties and connection request controls.
|
| Modifier and Type | Method and Description |
|---|---|
ExtendedResponse |
extendedOperation(ExtendedRequest request)
Performs an extended operation.
|
Control[] |
getConnectControls()
Retrieves the connection request controls in effect for this context.
|
Control[] |
getRequestControls()
Retrieves the request controls in effect for this context.
|
Control[] |
getResponseControls()
Retrieves the response controls produced as a result of the last
method invoked on this context.
|
LdapContext |
newInstance(Control[] reqCtls)
Creates a new instance of this context initialized using request controls.
|
void |
reconnect(Control[] connCtls)
Reconnects to the LDAP server using the supplied controls and
this context's environment.
|
void |
setRequestControls(Control[] requestControls)
Sets the request controls for methods subsequently
invoked on this context.
|
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, searchaddToEnvironment, 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, unbindclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitbind, bind, createSubcontext, createSubcontext, getAttributes, getAttributes, getAttributes, getAttributes, getSchema, getSchema, getSchemaClassDefinition, getSchemaClassDefinition, modifyAttributes, modifyAttributes, modifyAttributes, modifyAttributes, rebind, rebind, search, search, search, search, search, search, search, searchaddToEnvironment, bind, bind, close, composeName, composeName, createSubcontext, createSubcontext, destroySubcontext, destroySubcontext, getEnvironment, getNameInNamespace, getNameParser, getNameParser, list, list, listBindings, listBindings, lookup, lookup, lookupLink, lookupLink, rebind, rebind, removeFromEnvironment, rename, rename, unbind, unbindpublic InitialLdapContext()
throws NamingException
NamingException - if a naming exception is encounteredpublic InitialLdapContext(Hashtable<?,?> environment, Control[] connCtls) throws NamingException
This constructor will not modify its parameters or save references to them, but may save a clone or copy. Caller should not modify mutable keys and values in environment after it has been passed to the constructor.
connCtls is used as the underlying context instance's connection request controls. See the class description for details.
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.NamingException - if a naming exception is encounteredreconnect(javax.naming.ldap.Control[]),
LdapContext.reconnect(javax.naming.ldap.Control[])public ExtendedResponse extendedOperation(ExtendedRequest request) throws NamingException
LdapContextextendedOperation in interface LdapContextrequest - The non-null request to be performed.NamingException - If an error occurred while performing the
extended operation.public LdapContext newInstance(Control[] reqCtls) throws NamingException
LdapContextThe new context has the same environment properties and connection request controls as this context. See the class description for details. Implementations might also allow this context and the new context to share the same network connection or other resources if doing so does not impede the independence of either context.
newInstance in interface LdapContextreqCtls - The possibly null request controls
to use for the new context.
If null, the context is initialized with no request controls.NamingException - If an error occurred while creating
the new instance.InitialLdapContextpublic void reconnect(Control[] connCtls) throws NamingException
LdapContextThis method is a way to explicitly initiate an LDAP "bind" operation. For example, you can use this method to set request controls for the LDAP "bind" operation, or to explicitly connect to the server to get response controls returned by the LDAP "bind" operation.
This method sets this context's connCtls to be its new connection request controls. This context's context request controls are not affected. After this method has been invoked, any subsequent implicit reconnections will be done using connCtls. connCtls are also used as connection request controls for new context instances derived from this context. These connection request controls are not affected by setRequestControls().
Service provider implementors should read the "Service Provider" section in the class description for implementation details.
reconnect in interface LdapContextconnCtls - The possibly null controls to use. If null, no
controls are used.NamingException - If an error occurred while reconnecting.LdapContext.getConnectControls(),
LdapContext.newInstance(javax.naming.ldap.Control[])public Control[] getConnectControls() throws NamingException
LdapContextgetConnectControls in interface LdapContextNamingException - If an error occurred while getting the request
controls.public void setRequestControls(Control[] requestControls) throws NamingException
LdapContextThis removes any previous request controls and adds requestControls for use by subsequent methods invoked on this context. This method does not affect this context's connection request controls.
Note that requestControls will be in effect until the next invocation of setRequestControls(). You need to explicitly invoke setRequestControls() with null or an empty array to clear the controls if you don't want them to affect the context methods any more. To check what request controls are in effect for this context, use getRequestControls().
setRequestControls in interface LdapContextrequestControls - The possibly null controls to use. If null, no
controls are used.NamingException - If an error occurred while setting the
request controls.LdapContext.getRequestControls()public Control[] getRequestControls() throws NamingException
LdapContextgetRequestControls in interface LdapContextNamingException - If an error occurred while getting the request
controls.LdapContext.setRequestControls(javax.naming.ldap.Control[])public Control[] getResponseControls() throws NamingException
LdapContextThese response controls might have been generated by a successful or failed operation.
When a context method that may return response controls is invoked, response controls from the previous method invocation are cleared. getResponseControls() returns all of the response controls generated by LDAP operations used by the context method in the order received from the LDAP server. Invoking getResponseControls() does not clear the response controls. You can call it many times (and get back the same controls) until the next context method that may return controls is invoked.
getResponseControls in interface LdapContextNamingException - If an error occurred while getting the response
controls. Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b138