/*
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modifica-
tion, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. The end-user documentation included with the redistribution, if any, must
include the following acknowledgment: "This product includes software
developed by the Apache Software Foundation (http://www.apache.org/)."
Alternately, this acknowledgment may appear in the software itself, if
and wherever such third-party acknowledgments normally appear.
4. The names "Jakarta", "Avalon", "Excalibur" and "Apache Software Foundation"
must not be used to endorse or promote products derived from this software
without prior written permission. For written permission, please contact
apache@apache.org.
5. Products derived from this software may not be called "Apache", nor may
"Apache" appear in their name, without prior written permission of the
Apache Software Foundation.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This software consists of voluntary contributions made by many individuals
on behalf of the Apache Software Foundation. For more information on the
Apache Software Foundation, please see <http://www.apache.org/>.
*/
package org.apache.avalon.excalibur.naming;
import java.util.Hashtable;
import javax.naming.CompositeName;
import javax.naming.Context;
import javax.naming.InvalidNameException;
import javax.naming.Name;
import javax.naming.NameParser;
import javax.naming.NamingEnumeration;
import javax.naming.NamingException;
import javax.naming.spi.ResolveResult;
/**
* Abstract JNDI Context that can be inherited from to
* provide a particular type of Context.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
* @version $Revision: 1.1 $
* @deprecated Toolkit deprecated and replaced by http://spice.sourceforge.net/jndikit/
*/
public abstract class AbstractURLContext
extends AbstractContext
implements NameParser
{
protected final String m_scheme;
public AbstractURLContext( final String scheme, final Hashtable environment )
{
super( environment );
m_scheme = scheme;
}
public Name parse( final String name )
throws NamingException
{
return ( new CompositeName().add( name ) );
}
protected NameParser getNameParser()
throws NamingException
{
return this;
}
/**
* Helper method to bind
*/
protected void bind( final Name name, final Object object, final boolean rebind )
throws NamingException
{
final ResolveResult resolveResult = getBaseURLContext( name, getRawEnvironment() );
final Context context = (Context)resolveResult.getResolvedObj();
try
{
if( rebind )
{
context.rebind( resolveResult.getRemainingName(), object );
}
else
{
context.bind( resolveResult.getRemainingName(), object );
}
}
finally
{
context.close();
}
}
/**
* Create a Subcontext.
*
* @param name the name of subcontext
* @return the created context
* @exception NamingException if an error occurs (ie context exists, badly formated name etc)
*/
public Context createSubcontext( final Name name )
throws NamingException
{
final ResolveResult resolveResult = getBaseURLContext( name, getRawEnvironment() );
final Context context = (Context)resolveResult.getResolvedObj();
try
{
return context.createSubcontext( resolveResult.getRemainingName() );
}
finally
{
context.close();
}
}
public void destroySubcontext( final Name name )
throws NamingException
{
final ResolveResult resolveResult = getBaseURLContext( name, getRawEnvironment() );
final Context context = (Context)resolveResult.getResolvedObj();
try
{
context.destroySubcontext( resolveResult.getRemainingName() );
}
finally
{
context.close();
}
}
public String getNameInNamespace()
throws NamingException
{
return "";
}
/**
* Enumerates the names bound in the named context.
*
* @param name the name of the context
* @return the enumeration
* @exception NamingException if an error occurs
*/
public NamingEnumeration list( final Name name )
throws NamingException
{
final ResolveResult resolveResult = getBaseURLContext( name, getRawEnvironment() );
final Context context = (Context)resolveResult.getResolvedObj();
try
{
return context.list( resolveResult.getRemainingName() );
}
finally
{
context.close();
}
}
/**
* Enumerates the names bound in the named context, along with the objects bound to them.
*
* @param name the name of the context
* @return the enumeration
* @exception NamingException if an error occurs
*/
public NamingEnumeration listBindings( final Name name )
throws NamingException
{
final ResolveResult resolveResult = getBaseURLContext( name, getRawEnvironment() );
final Context context = (Context)resolveResult.getResolvedObj();
try
{
return context.listBindings( resolveResult.getRemainingName() );
}
finally
{
context.close();
}
}
/**
* Get the object named.
*
* @param name the name
* @return the object
* @exception NamingException if an error occurs (ie object name is inavlid or unbound)
*/
public Object lookup( final Name name )
throws NamingException
{
final ResolveResult resolveResult = getBaseURLContext( name, getRawEnvironment() );
final Context context = (Context)resolveResult.getResolvedObj();
try
{
return context.lookup( resolveResult.getRemainingName() );
}
finally
{
context.close();
}
}
/**
* Unbind a object from a name.
*
* @param name the name
* @exception NamingException if an error occurs
*/
public void unbind( final Name name )
throws NamingException
{
final ResolveResult resolveResult = getBaseURLContext( name, getRawEnvironment() );
final Context context = (Context)resolveResult.getResolvedObj();
try
{
context.unbind( resolveResult.getRemainingName() );
}
finally
{
context.close();
}
}
protected ResolveResult getBaseURLContext( final Name name, final Hashtable environment )
throws NamingException
{
if( name.isEmpty() )
{
throw new InvalidNameException( "Unable to locate URLContext will empty name" );
}
final String nameString = name.toString();
int index = nameString.indexOf( ':' );
if( -1 == index )
{
throw new InvalidNameException( "Unable to build URLContext as it does not specify scheme" );
}
final String scheme = nameString.substring( 0, index );
final int end = getEndIndexOfURLPart( nameString, index + 1 );
final String urlPart = nameString.substring( index + 1, end );
final String namePart = nameString.substring( end );
if( !m_scheme.equals( scheme ) )
{
throw new InvalidNameException( "Bad Scheme use to build URLContext (" + scheme + "). " +
"Expected " + m_scheme );
}
final Context context = newContext( urlPart );
return new ResolveResult( context, new CompositeName( namePart ) );
}
/**
* Find end index of url part in string.
* Default implementation looks for
* //.../[name-part]
* ///[name-part]
* //... (no name part)
* [name-part]
*
* @param name the name
* @param index the index where "scheme:" ends
* @return the index where url ends
* @exception NamingException if an error occurs
*/
protected int getEndIndexOfURLPart( final String name, final int index )
throws NamingException
{
int result = 0;
//does it start with //
if( name.startsWith( "//", index ) )
{
//does it have .../ following ???
int end = name.indexOf( "/", index + 2 );
if( -1 != end )
{
result = end;
}
else
{
result = name.length();
}
}
return result;
}
/**
* Return a new instance of the base context for a URL.
* This must be implemented in particular URLContext.
*
* @param urlPart the part of url string not including "scheme:"
* @return a base URLContext for urlPart
* @exception NamingException if an error occurs
*/
protected abstract Context newContext( String urlPart )
throws NamingException;
}