- All Known Implementing Classes:
public interface LdapContext extends DirContext
javax.naming.directory.DirContextshould be used instead.
Usage Details About ControlsThis interface provides support for LDAP v3 controls. At a high level, this support allows a user program to set request controls for LDAP operations that are executed in the course of the user program's invocation of
DirContextmethods, and read response controls resulting from LDAP operations. At the implementation level, there are some details that developers of both the user program and service providers need to understand in order to correctly use request and response controls.
There are two types of request controls:
- Request controls that affect how a connection is created
- Request controls that affect context methods
Unless explicitly qualified, the term "request controls" refers to context request controls.
Context Request ControlsThere are two ways in which a context instance gets its request controls:
ldapContextis an instance of
nullor an empty array for
reqCtlsmeans no request controls.
newInstance()creates a new instance of a context using
setRequestControls()updates an existing context instance's request controls to
Unlike environment properties, request controls of a context instance
are not inherited by context instances that are derived from
it. Derived context instances have
null as their context
request controls. You must set the request controls of a derived context
instance explicitly using
A context instance's request controls are retrieved using
Connection Request ControlsThere are three ways in which connection request controls are set:
new InitialLdapContext(env, connCtls)
refExceptionis an instance of
ldapContextis an instance of
nullor an empty array for
connCtlsmeans no connection request controls.
Like environment properties, connection request controls of a context
are inherited by contexts that are derived from it.
Typically, you initialize the connection request controls using the
InitialLdapContext constructor or
LdapReferralContext.getReferralContext(). These connection
request controls are inherited by contexts that share the same
connection--that is, contexts derived from the initial or referral
reconnect() to change the connection request controls of
ldapContext.reconnect() affects only the
connection used by
ldapContext and any new contexts instances that are
ldapContext. Contexts that previously shared the
ldapContext remain unchanged. That is, a context's
connection request controls must be explicitly changed and is not
affected by changes to another context's connection request
A context instance's connection request controls are retrieved using
Service Provider RequirementsA service provider supports connection and context request controls in the following ways. Context request controls must be associated on a per context instance basis while connection request controls must be associated on a per connection instance basis. The service provider must look for the connection request controls in the environment property "java.naming.ldap.control.connect" and pass this environment property on to context instances that it creates.
Response ControlsThe method
LdapContext.getResponseControls()is used to retrieve the response controls generated by LDAP operations executed as the result of invoking a
DirContextoperation. The result is all of the responses controls generated by the underlying LDAP operations, including any implicit reconnection. To get only the reconnection response controls, use
Controlarray passed as a parameter to any method is owned by the caller. The service provider will not modify the array or keep a reference to it, although it may keep references to the individual
Controlobjects in the array. A
Controlarray returned by any method is immutable, and may not subsequently be modified by either the caller or the service provider.
Fields Modifier and Type Field Description
static StringConstant that holds the name of the environment property for specifying the list of control factories to use.
Fields declared in interface javax.naming.Context
APPLET, 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
Modifier and Type Method Description
ExtendedRequest request)(Performs an extended operation.
()Retrieves the connection request controls in effect for this context.
()Retrieves the request controls in effect for this context.
()Retrieves the response controls produced as a result of the last method invoked on this context.
Control requestControls)(Creates a new instance of this context initialized using request controls.
Control connCtls)(Reconnects to the LDAP server using the supplied controls and this context's environment.
Control requestControls)(Sets the request controls for methods subsequently invoked on this context.
Methods declared in interface javax.naming.Context
addToEnvironment, 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, unbind
Methods declared in interface javax.naming.directory.DirContext
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
CONTROL_FACTORIESstatic final String CONTROL_FACTORIESConstant that holds the name of the environment property for specifying the list of control factories to use. The value of the property should be a colon-separated list of the fully qualified class names of factory classes that will create a control given another control. See
ControlFactory.getControlInstance()for details. This property may be specified in the environment, a system property, or one or more resource files.
The value of this constant is "java.naming.factory.control".
extendedOperationPerforms an extended operation. This method is used to support LDAPv3 extended operations.
request- The non-null request to be performed.
- The possibly null response of the operation. null means the operation did not generate any response.
NamingException- If an error occurred while performing the extended operation.
newInstanceCreates a new instance of this context initialized using request controls. This method is a convenience method for creating a new instance of this context for the purposes of multithreaded access. For example, if multiple threads want to use different context request controls, each thread may use this method to get its own copy of this context and set/get context request controls without having to synchronize with other threads.
The 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.
requestControls- The possibly null request controls to use for the new context. If null, the context is initialized with no request controls.
- A non-null
NamingException- If an error occurred while creating the new instance.
- See Also:
reconnectReconnects to the LDAP server using the supplied controls and this context's environment.
This 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
connCtlsto 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
connCtlsare also used as connection request controls for new context instances derived from this context. These connection request controls are not affected by
Service provider implementors should read the "Service Provider" section in the class description for implementation details.
getConnectControlsRetrieves the connection request controls in effect for this context. The controls are owned by the JNDI implementation and are immutable. Neither the array nor the controls may be modified by the caller.
- A possibly-null array of controls. null means no connect controls have been set for this context.
NamingException- If an error occurred while getting the request controls.
setRequestControlsSets the request controls for methods subsequently invoked on this context. The request controls are owned by the JNDI implementation and are immutable. Neither the array nor the controls may be modified by the caller.
This removes any previous request controls and adds
requestControlsfor use by subsequent methods invoked on this context. This method does not affect this context's connection request controls.
requestControlswill be in effect until the next invocation of
setRequestControls(). You need to explicitly invoke
nullor 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
getRequestControlsRetrieves the request controls in effect for this context. The request controls are owned by the JNDI implementation and are immutable. Neither the array nor the controls may be modified by the caller.
getResponseControlsRetrieves the response controls produced as a result of the last method invoked on this context. The response controls are owned by the JNDI implementation and are immutable. Neither the array nor the controls may be modified by the caller.
These 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.
- A possibly null array of controls. If null, the previous method invoked on this context did not produce any controls.
NamingException- If an error occurred while getting the response controls.