org.apache.directory.server.core.jndi

Class ServerLdapContext

java.lang.Object

org.apache.directory.server.core.jndi.ServerContext

org.apache.directory.server.core.jndi.ServerDirContext

org.apache.directory.server.core.jndi.ServerLdapContext

All Implemented Interfaces:

Context, DirContext, EventContext, EventDirContext, LdapContext

public class ServerLdapContext
extends ServerDirContext
implements LdapContext

An implementation of a JNDI LdapContext.

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.server.core.jndi.ServerContext

connectControls, DELETE_OLD_RDN_PROP, EMPTY_CONTROLS, objectClassAT, requestControls, responseControls, schemaManager

Fields inherited from interface javax.naming.ldap.LdapContext

CONTROL_FACTORIES

Fields inherited from interface javax.naming.directory.DirContext

ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTE

Fields inherited from 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

Fields inherited from interface javax.naming.event.EventContext

OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE

Constructor Summary

Constructors

Constructor and Description
ServerLdapContext(DirectoryService service, CoreSession session, Name bindDn)
ServerLdapContext(DirectoryService service, Hashtable<String,Object> env) Creates an instance of an ServerLdapContext.
ServerLdapContext(DirectoryService service, LdapPrincipal principal, Name dn) Creates a new ServerDirContext with a distinguished name which is used to set the PROVIDER_URL to the distinguished name for this context.

Method Summary

Modifier and Type	Method and Description
boolean	compare(org.apache.directory.api.ldap.model.name.Dn name, String oid, Object value) Explicitly exposes an LDAP compare operation which JNDI does not directly provide.
ExtendedResponse	extendedOperation(ExtendedRequest request)
Control[]	getConnectControls()
Control[]	getRequestControls()
Control[]	getResponseControls()
ServerContext	getRootContext() Gets a handle on the root context of the DIT.
void	ldapUnbind() Calling this method tunnels an unbind call down into the partition holding the bindDn.
LdapContext	newInstance(Control[] requestControls)
void	reconnect(Control[] connCtls)
void	setRequestControls(Control[] requestControls)

Methods inherited from class org.apache.directory.server.core.jndi.ServerDirContext

addNamingListener, addNamingListener, addNamingListener, addNamingListener, bind, bind, createSubcontext, createSubcontext, getAttributes, getAttributes, getAttributes, getAttributes, getSchema, getSchema, getSchemaClassDefinition, getSchemaClassDefinition, modifyAttributes, modifyAttributes, modifyAttributes, modifyAttributes, modifyAttributes, rebind, rebind, search, search, search, search, search, search, search, search, search

Methods inherited from class org.apache.directory.server.core.jndi.ServerContext

addNamingListener, addNamingListener, addToEnvironment, bind, bind, close, composeName, composeName, createSubcontext, createSubcontext, destroySubcontext, destroySubcontext, doAddOperation, doBindOperation, doDeleteOperation, doGetRootDseOperation, doListOperation, doLookupOperation, doLookupOperation, doModifyOperation, doMove, doMoveAndRenameOperation, doRename, doSearchOperation, getDirectoryService, getDn, getEnvironment, getListeners, getNameInNamespace, getNameParser, getNameParser, getService, getSession, injectReferralControl, list, list, listBindings, listBindings, lookup, lookup, lookupLink, lookupLink, rebind, rebind, removeFromEnvironment, removeNamingListener, rename, rename, targetMustExist, unbind, unbind

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from 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

Methods inherited from 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 inherited from interface javax.naming.event.EventContext

addNamingListener, addNamingListener, removeNamingListener, targetMustExist

Constructor Detail

ServerLdapContext

public ServerLdapContext(DirectoryService service,
                         Hashtable<String,Object> env)
                  throws Exception

Creates an instance of an ServerLdapContext.

Parameters:

service - the parent service that manages this context

env - the JNDI environment parameters

Throws:

NamingException - the context cannot be created

Exception

ServerLdapContext

public ServerLdapContext(DirectoryService service,
                         LdapPrincipal principal,
                         Name dn)
                  throws Exception

Creates a new ServerDirContext with a distinguished name which is used to set the PROVIDER_URL to the distinguished name for this context.

Parameters:

principal - the directory user principal that is propagated

dn - the distinguished name of this context

service - the directory service core

Throws:

NamingException - if there are problems instantiating

Exception

ServerLdapContext

public ServerLdapContext(DirectoryService service,
                         CoreSession session,
                         Name bindDn)
                  throws Exception

Throws:

Exception

Method Detail

extendedOperation

public ExtendedResponse extendedOperation(ExtendedRequest request)

Specified by:

extendedOperation in interface LdapContext

See Also:

LdapContext.extendedOperation( javax.naming.ldap.ExtendedRequest)

newInstance

public LdapContext newInstance(Control[] requestControls)
                        throws NamingException

Specified by:

newInstance in interface LdapContext

Throws:

NamingException

See Also:

LdapContext.newInstance( javax.naming.ldap.Control[])

reconnect

public void reconnect(Control[] connCtls)
               throws NamingException

Specified by:

reconnect in interface LdapContext

Throws:

NamingException

See Also:

LdapContext.reconnect(javax.naming.ldap.Control[])

getConnectControls

public Control[] getConnectControls()
                             throws NamingException

Specified by:

getConnectControls in interface LdapContext

Throws:

NamingException

See Also:

LdapContext.getConnectControls()

setRequestControls

public void setRequestControls(Control[] requestControls)
                        throws NamingException

Specified by:

setRequestControls in interface LdapContext

Throws:

NamingException

See Also:

LdapContext.setRequestControls( javax.naming.ldap.Control[])

getRequestControls

public Control[] getRequestControls()
                             throws NamingException

Specified by:

getRequestControls in interface LdapContext

Throws:

NamingException

See Also:

LdapContext.getRequestControls()

getResponseControls

public Control[] getResponseControls()
                              throws NamingException

Specified by:

getResponseControls in interface LdapContext

Throws:

NamingException

See Also:

LdapContext.getResponseControls()

compare

public boolean compare(org.apache.directory.api.ldap.model.name.Dn name,
                       String oid,
                       Object value)
                throws NamingException

Explicitly exposes an LDAP compare operation which JNDI does not directly provide. All normalization and schema checking etcetera is handled by this call.

Parameters:

name - the name of the entri

oid - the name or object identifier for the attribute to compare

value - the value to compare the attribute to

Returns:

true if the entry has the value for the attribute, false otherwise

Throws:

NamingException - if the backing store cannot be accessed, or permission is not allowed for this operation or the oid is not recognized, or the attribute is not present in the entry ... you get the picture.

ldapUnbind

public void ldapUnbind()
                throws NamingException

Calling this method tunnels an unbind call down into the partition holding the bindDn. The bind() counter part is not exposed because it is automatically called when you create a new initial context for a new connection (on wire) or (programatic) caller.

Throws:

NamingException - if there are failures encountered while unbinding

getRootContext

public ServerContext getRootContext()
                             throws NamingException

Description copied from class: ServerContext

Gets a handle on the root context of the DIT. The RootDSE as the present user.

Specified by:

getRootContext in class ServerContext

Returns:

the rootDSE context

Throws:

NamingException - if this fails