org.apache.directory.server.core.jndi

Class ServerContext

java.lang.Object

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

All Implemented Interfaces:

Context, EventContext

Direct Known Subclasses:

ServerDirContext

public abstract class ServerContext
extends Object
implements EventContext

A non-federated abstract Context implementation.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
protected Control[]	connectControls Connection level controls associated with the session
static String	DELETE_OLD_RDN_PROP property key used for deleting the old Rdn on a rename
protected static Control[]	EMPTY_CONTROLS Empty array of controls for use in dealing with them
protected org.apache.directory.api.ldap.model.schema.AttributeType	objectClassAT A reference to the ObjectClass AT
protected Control[]	requestControls The request controls to set on operations before performing them
protected Control[]	responseControls The response controls to set after performing operations
protected org.apache.directory.api.ldap.model.schema.SchemaManager	schemaManager The SchemManager instance

Fields inherited from interface javax.naming.event.EventContext

OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	ServerContext(DirectoryService service, CoreSession session, Name name)
protected	ServerContext(DirectoryService service, Hashtable<String,Object> env) Must be called by all subclasses to initialize the nexus proxy and the environment settings to be used by this Context implementation.
	ServerContext(DirectoryService service, LdapPrincipal principal, Name name) Must be called by all subclasses to initialize the nexus proxy and the environment settings to be used by this Context implementation.

Method Summary

Modifier and Type	Method and Description
void	addNamingListener(Name name, int scope, NamingListener namingListener)
void	addNamingListener(String name, int scope, NamingListener namingListener)
Object	addToEnvironment(String propName, Object propVal)
void	bind(Name name, Object obj)
void	bind(String name, Object obj)
void	close()
Name	composeName(Name name, Name prefix)
String	composeName(String name, String prefix)
Context	createSubcontext(Name name)
Context	createSubcontext(String name)
void	destroySubcontext(Name name)
void	destroySubcontext(String name)
protected void	doAddOperation(org.apache.directory.api.ldap.model.name.Dn target, org.apache.directory.api.ldap.model.entry.Entry entry) Used to encapsulate [de]marshalling of controls before and after add operations.
protected BindOperationContext	doBindOperation(org.apache.directory.api.ldap.model.name.Dn bindDn, byte[] credentials, String saslMechanism, String saslAuthId) Used to encapsulate [de]marshalling of controls before and after bind operations.
protected void	doDeleteOperation(org.apache.directory.api.ldap.model.name.Dn target) Used to encapsulate [de]marshalling of controls before and after delete operations.
protected org.apache.directory.api.ldap.model.entry.Entry	doGetRootDseOperation(org.apache.directory.api.ldap.model.name.Dn target)
protected EntryFilteringCursor	doListOperation(org.apache.directory.api.ldap.model.name.Dn target) Used to encapsulate [de]marshalling of controls before and after list operations.
protected org.apache.directory.api.ldap.model.entry.Entry	doLookupOperation(org.apache.directory.api.ldap.model.name.Dn target) Used to encapsulate [de]marshalling of controls before and after lookup operations.
protected org.apache.directory.api.ldap.model.entry.Entry	doLookupOperation(org.apache.directory.api.ldap.model.name.Dn target, String[] attrIds) Used to encapsulate [de]marshalling of controls before and after lookup operations.
protected void	doModifyOperation(org.apache.directory.api.ldap.model.name.Dn dn, List<org.apache.directory.api.ldap.model.entry.Modification> modifications) Used to encapsulate [de]marshalling of controls before and after modify operations.
protected void	doMove(org.apache.directory.api.ldap.model.name.Dn oldDn, org.apache.directory.api.ldap.model.name.Dn target) Used to encapsulate [de]marshalling of controls before and after moveAndRename operations.
protected void	doMoveAndRenameOperation(org.apache.directory.api.ldap.model.name.Dn oldDn, org.apache.directory.api.ldap.model.name.Dn parent, org.apache.directory.api.ldap.model.name.Rdn newRdn, boolean delOldDn) Used to encapsulate [de]marshalling of controls before and after moveAndRename operations.
protected void	doRename(org.apache.directory.api.ldap.model.name.Dn oldDn, org.apache.directory.api.ldap.model.name.Rdn newRdn, boolean delOldRdn) Used to encapsulate [de]marshalling of controls before and after rename operations.
protected EntryFilteringCursor	doSearchOperation(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.message.AliasDerefMode aliasDerefMode, org.apache.directory.api.ldap.model.filter.ExprNode filter, SearchControls searchControls) Used to encapsulate [de]marshalling of controls before and after list operations.
DirectoryService	getDirectoryService()
protected org.apache.directory.api.ldap.model.name.Dn	getDn() Gets the distinguished name of the entry associated with this Context.
Hashtable<String,Object>	getEnvironment()
protected Map<NamingListener,DirectoryListener>	getListeners() Allows subclasses to register and unregister listeners.
String	getNameInNamespace()
NameParser	getNameParser(Name name) Non-federated implementation presuming the name argument is not a composite name spanning multiple namespaces but a compound name in the same LDAP namespace.
NameParser	getNameParser(String name) Non-federated implementation presuming the name argument is not a composite name spanning multiple namespaces but a compound name in the same LDAP namespace.
abstract ServerContext	getRootContext() Gets a handle on the root context of the DIT.
DirectoryService	getService() Gets the DirectoryService associated with this context.
CoreSession	getSession()
protected void	injectReferralControl(OperationContext opCtx) Set the referral handling flag into the operation context using the JNDI value stored into the environment.
NamingEnumeration	list(Name name)
NamingEnumeration	list(String name)
NamingEnumeration	listBindings(Name name)
NamingEnumeration	listBindings(String name)
Object	lookup(Name name)
Object	lookup(String name)
Object	lookupLink(Name name)
Object	lookupLink(String name)
void	rebind(Name name, Object obj)
void	rebind(String name, Object obj)
Object	removeFromEnvironment(String propName)
void	removeNamingListener(NamingListener namingListener)
void	rename(Name oldName, Name newName)
void	rename(String oldName, String newName)
boolean	targetMustExist()
void	unbind(Name name)
void	unbind(String name)

Methods inherited from class java.lang.Object

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

Field Detail

DELETE_OLD_RDN_PROP

public static final String DELETE_OLD_RDN_PROP

property key used for deleting the old Rdn on a rename

See Also:

Constant Field Values

EMPTY_CONTROLS

protected static final Control[] EMPTY_CONTROLS

Empty array of controls for use in dealing with them

schemaManager

protected org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager

The SchemManager instance

objectClassAT

protected org.apache.directory.api.ldap.model.schema.AttributeType objectClassAT

A reference to the ObjectClass AT

requestControls

protected Control[] requestControls

The request controls to set on operations before performing them

responseControls

protected Control[] responseControls

The response controls to set after performing operations

connectControls

protected Control[] connectControls

Connection level controls associated with the session

Constructor Detail

ServerContext

protected ServerContext(DirectoryService service,
                        Hashtable<String,Object> env)
                 throws Exception

Must be called by all subclasses to initialize the nexus proxy and the environment settings to be used by this Context implementation. This specific constructor relies on the presence of the Context.PROVIDER_URL key and value to determine the distinguished name of the newly created context. It also checks to make sure the referenced name actually exists within the system. This constructor is used for all InitialContext requests.

Parameters:

service - the parent service that manages this context

env - the environment properties used by this context.

Throws:

NamingException - if the environment parameters are not set correctly.

Exception

ServerContext

public ServerContext(DirectoryService service,
                     LdapPrincipal principal,
                     Name name)
              throws Exception

Must be called by all subclasses to initialize the nexus proxy and the environment settings to be used by this Context implementation. This constructor is used to propagate new contexts from existing contexts.

Parameters:

service - the directory service core

principal - the directory user principal that is propagated

name - the distinguished name of this context

Throws:

NamingException - if there is a problem creating the new context

Exception

ServerContext

public ServerContext(DirectoryService service,
                     CoreSession session,
                     Name name)
              throws Exception

Throws:

Exception

Method Detail

injectReferralControl

protected void injectReferralControl(OperationContext opCtx)

Set the referral handling flag into the operation context using the JNDI value stored into the environment.

doAddOperation

protected void doAddOperation(org.apache.directory.api.ldap.model.name.Dn target,
                              org.apache.directory.api.ldap.model.entry.Entry entry)
                       throws Exception

Used to encapsulate [de]marshalling of controls before and after add operations.

Parameters:

entry -

target -

Throws:

Exception

doDeleteOperation

protected void doDeleteOperation(org.apache.directory.api.ldap.model.name.Dn target)
                          throws Exception

Used to encapsulate [de]marshalling of controls before and after delete operations.

Parameters:

target -

Throws:

Exception

doSearchOperation

protected EntryFilteringCursor doSearchOperation(org.apache.directory.api.ldap.model.name.Dn dn,
                                                 org.apache.directory.api.ldap.model.message.AliasDerefMode aliasDerefMode,
                                                 org.apache.directory.api.ldap.model.filter.ExprNode filter,
                                                 SearchControls searchControls)
                                          throws Exception

Used to encapsulate [de]marshalling of controls before and after list operations.

Parameters:

dn -

aliasDerefMode -

filter -

searchControls -

Returns:

NamingEnumeration

Throws:

Exception

doListOperation

protected EntryFilteringCursor doListOperation(org.apache.directory.api.ldap.model.name.Dn target)
                                        throws Exception

Used to encapsulate [de]marshalling of controls before and after list operations.

Throws:

Exception

doGetRootDseOperation

protected org.apache.directory.api.ldap.model.entry.Entry doGetRootDseOperation(org.apache.directory.api.ldap.model.name.Dn target)
                                                                         throws Exception

Throws:

Exception

doLookupOperation

protected org.apache.directory.api.ldap.model.entry.Entry doLookupOperation(org.apache.directory.api.ldap.model.name.Dn target)
                                                                     throws Exception

Used to encapsulate [de]marshalling of controls before and after lookup operations.

Throws:

Exception

doLookupOperation

protected org.apache.directory.api.ldap.model.entry.Entry doLookupOperation(org.apache.directory.api.ldap.model.name.Dn target,
                                                                            String[] attrIds)
                                                                     throws Exception

Used to encapsulate [de]marshalling of controls before and after lookup operations.

Throws:

Exception

doBindOperation

protected BindOperationContext doBindOperation(org.apache.directory.api.ldap.model.name.Dn bindDn,
                                               byte[] credentials,
                                               String saslMechanism,
                                               String saslAuthId)
                                        throws Exception

Used to encapsulate [de]marshalling of controls before and after bind operations.

Throws:

Exception

doMoveAndRenameOperation

protected void doMoveAndRenameOperation(org.apache.directory.api.ldap.model.name.Dn oldDn,
                                        org.apache.directory.api.ldap.model.name.Dn parent,
                                        org.apache.directory.api.ldap.model.name.Rdn newRdn,
                                        boolean delOldDn)
                                 throws Exception

Used to encapsulate [de]marshalling of controls before and after moveAndRename operations.

Throws:

Exception

doModifyOperation

protected void doModifyOperation(org.apache.directory.api.ldap.model.name.Dn dn,
                                 List<org.apache.directory.api.ldap.model.entry.Modification> modifications)
                          throws Exception

Used to encapsulate [de]marshalling of controls before and after modify operations.

Throws:

Exception

doMove

protected void doMove(org.apache.directory.api.ldap.model.name.Dn oldDn,
                      org.apache.directory.api.ldap.model.name.Dn target)
               throws Exception

Used to encapsulate [de]marshalling of controls before and after moveAndRename operations.

Throws:

Exception

doRename

protected void doRename(org.apache.directory.api.ldap.model.name.Dn oldDn,
                        org.apache.directory.api.ldap.model.name.Rdn newRdn,
                        boolean delOldRdn)
                 throws Exception

Used to encapsulate [de]marshalling of controls before and after rename operations.

Throws:

Exception

getSession

public CoreSession getSession()

getDirectoryService

public DirectoryService getDirectoryService()

getRootContext

public abstract ServerContext getRootContext()
                                      throws NamingException

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

Returns:

the rootDSE context

Throws:

NamingException - if this fails

getService

public DirectoryService getService()

Gets the DirectoryService associated with this context.

Returns:

the directory service associated with this context

getDn

protected org.apache.directory.api.ldap.model.name.Dn getDn()

Gets the distinguished name of the entry associated with this Context.

Returns:

the distinguished name of this Context's entry.

close

public void close()
           throws NamingException

Specified by:

close in interface Context

Throws:

NamingException

See Also:

Context.close()

getNameInNamespace

public String getNameInNamespace()
                          throws NamingException

Specified by:

getNameInNamespace in interface Context

Throws:

NamingException

See Also:

Context.getNameInNamespace()

getEnvironment

public Hashtable<String,Object> getEnvironment()

Specified by:

getEnvironment in interface Context

See Also:

Context.getEnvironment()

addToEnvironment

public Object addToEnvironment(String propName,
                               Object propVal)
                        throws NamingException

Specified by:

addToEnvironment in interface Context

Throws:

NamingException

See Also:

Context.addToEnvironment(java.lang.String, java.lang.Object)

removeFromEnvironment

public Object removeFromEnvironment(String propName)
                             throws NamingException

Specified by:

removeFromEnvironment in interface Context

Throws:

NamingException

See Also:

Context.removeFromEnvironment(java.lang.String)

createSubcontext

public Context createSubcontext(String name)
                         throws NamingException

Specified by:

createSubcontext in interface Context

Throws:

NamingException

See Also:

Context.createSubcontext(java.lang.String)

createSubcontext

public Context createSubcontext(Name name)
                         throws NamingException

Specified by:

createSubcontext in interface Context

Throws:

NamingException

See Also:

Context.createSubcontext(javax.naming.Name)

destroySubcontext

public void destroySubcontext(String name)
                       throws NamingException

Specified by:

destroySubcontext in interface Context

Throws:

NamingException

See Also:

Context.destroySubcontext(java.lang.String)

destroySubcontext

public void destroySubcontext(Name name)
                       throws NamingException

Specified by:

destroySubcontext in interface Context

Throws:

NamingException

See Also:

Context.destroySubcontext(javax.naming.Name)

bind

public void bind(String name,
                 Object obj)
          throws NamingException

Specified by:

bind in interface Context

Throws:

NamingException

See Also:

Context.bind(java.lang.String, java.lang.Object)

bind

public void bind(Name name,
                 Object obj)
          throws NamingException

Specified by:

bind in interface Context

Throws:

NamingException

See Also:

Context.bind(javax.naming.Name, java.lang.Object)

rename

public void rename(String oldName,
                   String newName)
            throws NamingException

Specified by:

rename in interface Context

Throws:

NamingException

See Also:

Context.rename(java.lang.String, java.lang.String)

rename

public void rename(Name oldName,
                   Name newName)
            throws NamingException

Specified by:

rename in interface Context

Throws:

NamingException

See Also:

Context.rename(javax.naming.Name, javax.naming.Name)

rebind

public void rebind(String name,
                   Object obj)
            throws NamingException

Specified by:

rebind in interface Context

Throws:

NamingException

See Also:

Context.rebind(java.lang.String, java.lang.Object)

rebind

public void rebind(Name name,
                   Object obj)
            throws NamingException

Specified by:

rebind in interface Context

Throws:

NamingException

See Also:

Context.rebind(javax.naming.Name, java.lang.Object)

unbind

public void unbind(String name)
            throws NamingException

Specified by:

unbind in interface Context

Throws:

NamingException

See Also:

Context.unbind(java.lang.String)

unbind

public void unbind(Name name)
            throws NamingException

Specified by:

unbind in interface Context

Throws:

NamingException

See Also:

Context.unbind(javax.naming.Name)

lookup

public Object lookup(String name)
              throws NamingException

Specified by:

lookup in interface Context

Throws:

NamingException

See Also:

Context.lookup(java.lang.String)

lookup

public Object lookup(Name name)
              throws NamingException

Specified by:

lookup in interface Context

Throws:

NamingException

See Also:

Context.lookup(javax.naming.Name)

lookupLink

public Object lookupLink(String name)
                  throws NamingException

Specified by:

lookupLink in interface Context

Throws:

NamingException

See Also:

Context.lookupLink(java.lang.String)

lookupLink

public Object lookupLink(Name name)
                  throws NamingException

Specified by:

lookupLink in interface Context

Throws:

NamingException

See Also:

Context.lookupLink(javax.naming.Name)

getNameParser

public NameParser getNameParser(String name)
                         throws NamingException

Non-federated implementation presuming the name argument is not a composite name spanning multiple namespaces but a compound name in the same LDAP namespace. Hence the parser returned is always the same as calling this method with the empty String.

Specified by:

getNameParser in interface Context

Throws:

NamingException

See Also:

Context.getNameParser(java.lang.String)

getNameParser

public NameParser getNameParser(Name name)
                         throws NamingException

Non-federated implementation presuming the name argument is not a composite name spanning multiple namespaces but a compound name in the same LDAP namespace. Hence the parser returned is always the same as calling this method with the empty String Name.

Specified by:

getNameParser in interface Context

Throws:

NamingException

See Also:

Context.getNameParser(javax.naming.Name)

list

public NamingEnumeration list(String name)
                       throws NamingException

Specified by:

list in interface Context

Throws:

NamingException

See Also:

Context.list(java.lang.String)

list

public NamingEnumeration list(Name name)
                       throws NamingException

Specified by:

list in interface Context

Throws:

NamingException

See Also:

Context.list(javax.naming.Name)

listBindings

public NamingEnumeration listBindings(String name)
                               throws NamingException

Specified by:

listBindings in interface Context

Throws:

NamingException

See Also:

Context.listBindings(java.lang.String)

listBindings

public NamingEnumeration listBindings(Name name)
                               throws NamingException

Specified by:

listBindings in interface Context

Throws:

NamingException

See Also:

Context.listBindings(javax.naming.Name)

composeName

public String composeName(String name,
                          String prefix)
                   throws NamingException

Specified by:

composeName in interface Context

Throws:

NamingException

See Also:

Context.composeName(java.lang.String, java.lang.String)

composeName

public Name composeName(Name name,
                        Name prefix)
                 throws NamingException

Specified by:

composeName in interface Context

Throws:

NamingException

See Also:

Context.composeName(javax.naming.Name, javax.naming.Name)

addNamingListener

public void addNamingListener(Name name,
                              int scope,
                              NamingListener namingListener)
                       throws NamingException

Specified by:

addNamingListener in interface EventContext

Throws:

NamingException

addNamingListener

public void addNamingListener(String name,
                              int scope,
                              NamingListener namingListener)
                       throws NamingException

Specified by:

addNamingListener in interface EventContext

Throws:

NamingException

removeNamingListener

public void removeNamingListener(NamingListener namingListener)
                          throws NamingException

Specified by:

removeNamingListener in interface EventContext

Throws:

NamingException

targetMustExist

public boolean targetMustExist()
                        throws NamingException

Specified by:

targetMustExist in interface EventContext

Throws:

NamingException

getListeners

protected Map<NamingListener,DirectoryListener> getListeners()

Allows subclasses to register and unregister listeners.

Returns:

the set of listeners used for tracking registered name listeners.