/*
* Copyright 2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.ldap.server.partition;
import java.util.*;
import javax.naming.Context;
import javax.naming.Name;
import javax.naming.NamingEnumeration;
import javax.naming.NamingException;
import javax.naming.ServiceUnavailableException;
import javax.naming.directory.Attributes;
import javax.naming.directory.ModificationItem;
import javax.naming.directory.SearchControls;
import javax.naming.directory.DirContext;
import javax.naming.event.EventContext;
import javax.naming.event.NamingListener;
import javax.naming.ldap.LdapContext;
import org.apache.ldap.common.filter.ExprNode;
import org.apache.ldap.server.DirectoryServiceConfiguration;
import org.apache.ldap.server.DirectoryService;
import org.apache.ldap.server.configuration.DirectoryPartitionConfiguration;
import org.apache.ldap.server.event.EventService;
import org.apache.ldap.server.interceptor.InterceptorChain;
import org.apache.ldap.server.invocation.Invocation;
import org.apache.ldap.server.invocation.InvocationStack;
/**
* A decorator that wraps other {@link DirectoryPartitionNexus} to enable
* {@link InterceptorChain} and {@link InvocationStack} support.
* All {@link Invocation}s made to this nexus is automatically pushed to
* {@link InvocationStack} of the current thread, and popped when
* the operation ends. All invocations are filtered by {@link InterceptorChain}.
*
* @author The Apache Directory Project
* @version $Rev: 326825 $, $Date: 2005-10-20 01:09:43 -0400 (Thu, 20 Oct 2005) $
*/
public class DirectoryPartitionNexusProxy extends DirectoryPartitionNexus
{
/** safe to use set of bypass instructions to lookup raw entries */
public static final Collection LOOKUP_BYPASS;
/** safe to use set of bypass instructions to getMatchedDn */
public static final Collection GETMATCHEDDN_BYPASS;
/** Bypass String to use when ALL interceptors should be skipped */
public static final String BYPASS_ALL = "*";
/** Bypass String to use when ALL interceptors should be skipped */
public static final Collection BYPASS_ALL_COLLECTION = Collections.singleton( BYPASS_ALL );
/** Integer const for DirContext.ADD_ATTRIBUTE */
private static final Integer ADD_MODOP = new Integer( DirContext.ADD_ATTRIBUTE );
/** Integer const for DirContext.REMOVE_ATTRIBUTE */
private static final Integer REMOVE_MODOP = new Integer( DirContext.REMOVE_ATTRIBUTE );
/** Integer const for DirContext.REPLACE_ATTRIBUTE */
private static final Integer REPLACE_MODOP = new Integer( DirContext.REPLACE_ATTRIBUTE );
private final Context caller;
private final DirectoryService service;
private final DirectoryServiceConfiguration configuration;
static
{
Collection c = new HashSet();
c.add( "normalizationService" );
c.add( "authenticationService" );
c.add( "authorizationService" );
c.add( "oldAuthorizationService" );
c.add( "schemaService" );
c.add( "subentryService" );
c.add( "operationalAttributeService" );
c.add( "eventService" );
LOOKUP_BYPASS = Collections.unmodifiableCollection( c );
c = new HashSet();
c.add( "authenticationService" );
c.add( "authorizationService" );
c.add( "oldAuthorizationService" );
c.add( "schemaService" );
c.add( "subentryService" );
c.add( "operationalAttributeService" );
c.add( "eventService" );
GETMATCHEDDN_BYPASS = Collections.unmodifiableCollection( c );
}
/**
* Creates a new instance.
*
* @param caller a JNDI {@link Context} object that will call this proxy
* @param service a JNDI service
*/
public DirectoryPartitionNexusProxy( Context caller, DirectoryService service )
{
this.caller = caller;
this.service = service;
this.configuration = service.getConfiguration();
}
public LdapContext getLdapContext() {
return this.configuration.getPartitionNexus().getLdapContext();
}
public void init( DirectoryServiceConfiguration factoryCfg, DirectoryPartitionConfiguration cfg )
{
}
public void destroy()
{
}
public DirectoryPartition getSystemPartition()
{
return this.configuration.getPartitionNexus().getSystemPartition();
}
public Name getSuffix( boolean normalized ) throws NamingException
{
return this.configuration.getPartitionNexus().getSuffix( normalized );
}
public void sync() throws NamingException {
this.service.sync();
}
public void close() throws NamingException {
this.service.shutdown();
}
public boolean isInitialized() {
return this.service.isStarted();
}
public Name getMatchedName( Name dn, boolean normalized ) throws NamingException
{
return getMatchedName( dn, normalized, null );
}
public Name getMatchedName( Name dn, boolean normalized, Collection bypass ) throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
Object[] args = new Object[] { dn, normalized? Boolean.TRUE : Boolean.FALSE };
stack.push( new Invocation( this, caller, "getMatchedDn", args, bypass ) );
try
{
return this.configuration.getInterceptorChain().getMatchedName( dn, normalized );
}
finally
{
stack.pop();
}
}
public Name getSuffix( Name dn, boolean normalized) throws NamingException
{
return getSuffix( dn, normalized, null );
}
public Name getSuffix( Name dn, boolean normalized, Collection bypass ) throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
Object[] args = new Object[] { dn, normalized? Boolean.TRUE : Boolean.FALSE };
stack.push( new Invocation( this, caller, "getSuffix", args, bypass ) );
try
{
return this.configuration.getInterceptorChain().getSuffix( dn, normalized );
}
finally
{
stack.pop();
}
}
public Iterator listSuffixes( boolean normalized ) throws NamingException
{
return listSuffixes( normalized, null );
}
public Iterator listSuffixes( boolean normalized, Collection bypass ) throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
Object[] args = new Object[] { normalized? Boolean.TRUE : Boolean.FALSE };
stack.push( new Invocation( this, caller, "listSuffixes", args, bypass ) );
try
{
return this.configuration.getInterceptorChain().listSuffixes( normalized );
}
finally
{
stack.pop();
}
}
public boolean compare( Name name, String oid, Object value ) throws NamingException
{
return compare( name, oid, value, null );
}
public boolean compare( Name name, String oid, Object value, Collection bypass ) throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
stack.push( new Invocation( this, caller, "compare", new Object[] { name, oid, value }, bypass ) );
try
{
return this.configuration.getInterceptorChain().compare( name, oid, value );
}
finally
{
stack.pop();
}
}
public void delete( Name name ) throws NamingException
{
delete( name, null );
}
public void delete( Name name, Collection bypass ) throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
stack.push( new Invocation( this, caller, "delete", new Object[] { name }, bypass ) );
try
{
this.configuration.getInterceptorChain().delete( name );
}
finally
{
stack.pop();
}
}
public void add( String upName, Name normName, Attributes entry ) throws NamingException
{
add( upName, normName, entry, null );
}
public void add( String upName, Name normName, Attributes entry, Collection bypass ) throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
stack.push( new Invocation( this, caller, "add", new Object[] { upName, normName, entry }, bypass ) );
try
{
this.configuration.getInterceptorChain().add( upName, normName, entry );
}
finally
{
stack.pop();
}
}
public void modify( Name name, int modOp, Attributes mods ) throws NamingException
{
modify( name, modOp, mods, null );
}
public void modify( Name name, int modOp, Attributes mods, Collection bypass ) throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
Integer modOpObj;
switch( modOp )
{
case( DirContext.ADD_ATTRIBUTE ):
modOpObj = ADD_MODOP;
break;
case( DirContext.REMOVE_ATTRIBUTE ):
modOpObj = REMOVE_MODOP;
break;
case( DirContext.REPLACE_ATTRIBUTE ):
modOpObj = REPLACE_MODOP;
break;
default:
throw new IllegalArgumentException( "bad modification operation value: " + modOp );
}
stack.push( new Invocation( this, caller, "modify", new Object[] { name, modOpObj, mods }, bypass ) );
try
{
this.configuration.getInterceptorChain().modify( name, modOp, mods );
}
finally
{
stack.pop();
}
}
public void modify( Name name, ModificationItem[] mods ) throws NamingException
{
modify( name, mods, null );
}
public void modify( Name name, ModificationItem[] mods, Collection bypass ) throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
stack.push( new Invocation( this, caller, "modify", new Object[] { name, mods }, bypass ) );
try
{
this.configuration.getInterceptorChain().modify( name, mods );
}
finally
{
stack.pop();
}
}
public NamingEnumeration list( Name base ) throws NamingException
{
return list( base, null );
}
public NamingEnumeration list( Name base, Collection bypass ) throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
stack.push( new Invocation( this, caller, "list", new Object[] { base }, bypass ) );
try
{
return this.configuration.getInterceptorChain().list( base );
}
finally
{
stack.pop();
}
}
public NamingEnumeration search( Name base, Map env, ExprNode filter, SearchControls searchCtls )
throws NamingException
{
return search( base, env, filter, searchCtls, null );
}
public NamingEnumeration search( Name base, Map env, ExprNode filter, SearchControls searchCtls, Collection bypass )
throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
stack.push( new Invocation( this, caller, "search", new Object[] { base, env, filter, searchCtls }, bypass ) );
try
{
return this.configuration.getInterceptorChain().search( base, env, filter, searchCtls );
}
finally
{
stack.pop();
}
}
public Attributes lookup( Name name ) throws NamingException
{
return lookup( name, ( Collection ) null );
}
public Attributes lookup( Name name, Collection bypass ) throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
stack.push( new Invocation( this, caller, "lookup", new Object[] { name }, bypass ) );
try
{
return this.configuration.getInterceptorChain().lookup( name );
}
finally
{
stack.pop();
}
}
public Attributes lookup( Name dn, String[] attrIds ) throws NamingException
{
return lookup( dn, attrIds, null );
}
public Attributes lookup( Name dn, String[] attrIds, Collection bypass ) throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
stack.push( new Invocation( this, caller, "lookup", new Object[] { dn, attrIds }, bypass ) );
try
{
return this.configuration.getInterceptorChain().lookup( dn, attrIds );
}
finally
{
stack.pop();
}
}
public boolean hasEntry( Name name ) throws NamingException
{
return hasEntry( name, null );
}
public boolean hasEntry( Name name, Collection bypass ) throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
stack.push( new Invocation( this, caller, "hasEntry", new Object[] { name }, bypass ) );
try
{
return this.configuration.getInterceptorChain().hasEntry( name );
}
finally
{
stack.pop();
}
}
public boolean isSuffix( Name name ) throws NamingException
{
return isSuffix( name, null );
}
public boolean isSuffix( Name name, Collection bypass ) throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
stack.push( new Invocation( this, caller, "isSuffix", new Object[] { name }, bypass ) );
try
{
return this.configuration.getInterceptorChain().isSuffix( name );
}
finally
{
stack.pop();
}
}
public void modifyRn( Name name, String newRn, boolean deleteOldRn ) throws NamingException
{
modifyRn( name, newRn, deleteOldRn, null );
}
public void modifyRn( Name name, String newRn, boolean deleteOldRn, Collection bypass ) throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
Object[] args = new Object[] { name, newRn, deleteOldRn? Boolean.TRUE : Boolean.FALSE };
stack.push( new Invocation( this, caller, "modifyRn", args, bypass ) );
try
{
this.configuration.getInterceptorChain().modifyRn( name, newRn, deleteOldRn );
}
finally
{
stack.pop();
}
}
public void move( Name oriChildName, Name newParentName ) throws NamingException
{
move( oriChildName, newParentName, null );
}
public void move( Name oriChildName, Name newParentName, Collection bypass ) throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
stack.push( new Invocation( this, caller, "move", new Object[] { oriChildName, newParentName }, bypass ) );
try
{
this.configuration.getInterceptorChain().move( oriChildName, newParentName );
}
finally
{
stack.pop();
}
}
public void move( Name oriChildName, Name newParentName, String newRn, boolean deleteOldRn ) throws NamingException
{
move( oriChildName, newParentName, newRn, deleteOldRn, null );
}
public void move( Name oriChildName, Name newParentName, String newRn, boolean deleteOldRn, Collection bypass )
throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
Object[] args = new Object[] { oriChildName, newParentName, newRn, deleteOldRn? Boolean.TRUE : Boolean.FALSE };
stack.push( new Invocation( this, caller, "move", args, bypass ) );
try
{
this.configuration.getInterceptorChain().move( oriChildName, newParentName, newRn, deleteOldRn );
}
finally
{
stack.pop();
}
}
public Attributes getRootDSE() throws NamingException
{
return getRootDSE( null );
}
public Attributes getRootDSE( Collection bypass ) throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
stack.push( new Invocation( this, caller, "getRootDSE", null, bypass ) );
try
{
return this.configuration.getInterceptorChain().getRootDSE();
}
finally
{
stack.pop();
}
}
public void addContextPartition( DirectoryPartitionConfiguration config ) throws NamingException
{
addContextPartition( config, null );
}
public void addContextPartition( DirectoryPartitionConfiguration config, Collection bypass ) throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
stack.push( new Invocation( this, caller, "addContextPartition", new Object[] { config }, bypass ) );
try
{
this.configuration.getInterceptorChain().addContextPartition( config );
}
finally
{
stack.pop();
}
}
public void removeContextPartition( Name suffix ) throws NamingException
{
removeContextPartition( suffix, null );
}
public void removeContextPartition( Name suffix, Collection bypass ) throws NamingException
{
ensureStarted();
InvocationStack stack = InvocationStack.getInstance();
stack.push( new Invocation( this, caller, "removeContextPartition", new Object[] { suffix }, bypass ) );
try
{
this.configuration.getInterceptorChain().removeContextPartition( suffix );
}
finally
{
stack.pop();
}
}
private void ensureStarted() throws ServiceUnavailableException
{
if( !service.isStarted() )
{
throw new ServiceUnavailableException( "Directory service is not started." );
}
}
// -----------------------------------------------------------------------
// EventContext and EventDirContext notification methods
// -----------------------------------------------------------------------
/*
* All listener registration/deregistration methods can be reduced down to
* the following methods. Rather then make these actual intercepted methods
* we use them as out of band methods to interface with the notification
* interceptor.
*/
public void addNamingListener( EventContext ctx, Name name, ExprNode filter, SearchControls searchControls,
NamingListener namingListener ) throws NamingException
{
InterceptorChain chain = this.configuration.getInterceptorChain();
EventService interceptor = ( EventService ) chain.get( "eventService" );
interceptor.addNamingListener( ctx, name, filter, searchControls, namingListener );
}
public void removeNamingListener( EventContext ctx, NamingListener namingListener ) throws NamingException
{
InterceptorChain chain = this.configuration.getInterceptorChain();
EventService interceptor = ( EventService ) chain.get( "eventService" );
interceptor.removeNamingListener( ctx, namingListener );
}
}