/*
* 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.interceptor;
import java.util.Iterator;
import java.util.Map;
import javax.naming.Context;
import javax.naming.Name;
import javax.naming.NamingEnumeration;
import javax.naming.NamingException;
import javax.naming.directory.Attributes;
import javax.naming.directory.ModificationItem;
import javax.naming.directory.SearchControls;
import javax.naming.ldap.LdapContext;
import org.apache.ldap.common.filter.ExprNode;
import org.apache.ldap.server.authn.LdapPrincipal;
import org.apache.ldap.server.configuration.InterceptorConfiguration;
import org.apache.ldap.server.invocation.InvocationStack;
import org.apache.ldap.server.jndi.ContextFactoryConfiguration;
import org.apache.ldap.server.jndi.ServerContext;
/**
* A easy-to-use implementation of {@link Interceptor}. All methods are
* implemented to pass the flow of control to next interceptor by defaults.
* Please override the methods you have concern in.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
* @version $Rev: 226451 $, $Date: 2005-07-29 20:54:58 -0400 (Fri, 29 Jul 2005) $
*/
public abstract class BaseInterceptor implements Interceptor
{
/**
* Returns {@link LdapPrincipal} of current context.
*/
public static LdapPrincipal getPrincipal()
{
ServerContext ctx = ( ServerContext ) getContext();
return ctx.getPrincipal();
}
/**
* Returns the current JNDI {@link Context}.
*/
public static LdapContext getContext()
{
return ( LdapContext ) InvocationStack.getInstance().peek().getCaller();
}
/**
* Creates a new instance.
*/
protected BaseInterceptor()
{
}
/**
* This method does nothing by default.
*/
public void init( ContextFactoryConfiguration factoryCfg, InterceptorConfiguration cfg ) throws NamingException
{
}
/**
* This method does nothing by default.
*/
public void destroy()
{
}
// ------------------------------------------------------------------------
// Interceptor's Invoke Method
// ------------------------------------------------------------------------
public void add( NextInterceptor next, String upName, Name normName, Attributes entry ) throws NamingException
{
next.add( upName, normName, entry );
}
public void delete( NextInterceptor next, Name name ) throws NamingException
{
next.delete( name );
}
public Name getMatchedName( NextInterceptor next, Name dn, boolean normalized ) throws NamingException
{
return next.getMatchedName( dn, normalized );
}
public Attributes getRootDSE( NextInterceptor next ) throws NamingException
{
return next.getRootDSE();
}
public Name getSuffix( NextInterceptor next, Name dn, boolean normalized ) throws NamingException
{
return next.getSuffix( dn, normalized );
}
public boolean hasEntry( NextInterceptor next, Name name ) throws NamingException
{
return next.hasEntry( name );
}
public boolean isSuffix( NextInterceptor next, Name name ) throws NamingException
{
return next.isSuffix( name );
}
public NamingEnumeration list( NextInterceptor next, Name base ) throws NamingException
{
return next.list( base );
}
public Iterator listSuffixes( NextInterceptor next, boolean normalized ) throws NamingException
{
return next.listSuffixes( normalized );
}
public Attributes lookup( NextInterceptor next, Name dn, String[] attrIds ) throws NamingException
{
return next.lookup( dn, attrIds );
}
public Attributes lookup( NextInterceptor next, Name name ) throws NamingException
{
return next.lookup( name );
}
public void modify( NextInterceptor next, Name name, int modOp, Attributes mods ) throws NamingException
{
next.modify( name, modOp, mods );
}
public void modify( NextInterceptor next, Name name, ModificationItem[] mods ) throws NamingException
{
next.modify( name, mods );
}
public void modifyRn( NextInterceptor next, Name name, String newRn, boolean deleteOldRn ) throws NamingException
{
next.modifyRn( name, newRn, deleteOldRn );
}
public void move( NextInterceptor next, Name oriChildName, Name newParentName, String newRn, boolean deleteOldRn ) throws NamingException
{
next.move( oriChildName, newParentName, newRn, deleteOldRn );
}
public void move( NextInterceptor next, Name oriChildName, Name newParentName ) throws NamingException
{
next.move( oriChildName, newParentName );
}
public NamingEnumeration search( NextInterceptor next, Name base, Map env, ExprNode filter, SearchControls searchCtls ) throws NamingException
{
return next.search( base, env, filter, searchCtls );
}
}