javax.naming

Class InitialContext

Implemented Interfaces:
Context
Known Direct Subclasses:
InitialDirContext

public class InitialContext
extends Object
implements Context

The starting context for performing naming operations. All naming operations are performed in the scope of some context. The initial context is the starting point for the name resolution.

Field Summary

protected Context
defaultInitCtx
Contains the default initial context.
protected boolean
gotDefault
Indicates if the initial context was obtained by calling NamingManager.getInitialContext(Hashtable).
protected Hashtable
myProps
The environment, associated with this initial context.

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

InitialContext()
Creates teh new initial context with no properties.
InitialContext(Hashtable environment)
Creates the new initial context with the given properties.
InitialContext(boolean lazy)
Creates the initial context with the possibility to delay its initialisation.

Method Summary

Object
addToEnvironment(String propName, Object propVal)
void
bind(String name, Object obj)
void
bind(Name name, Object obj)
void
close()
String
composeName(String name, String prefix)
Name
composeName(Name name, Name prefix)
Context
createSubcontext(String name)
Context
createSubcontext(Name name)
void
destroySubcontext(String name)
void
destroySubcontext(Name name)
protected Context
getDefaultInitCtx()
Get the default initial context.
Hashtable
getEnvironment()
String
getNameInNamespace()
This operation is not supported for the initial naming context.
NameParser
getNameParser(String name)
NameParser
getNameParser(Name name)
protected Context
getURLOrDefaultInitCtx(String name)
Obtains the context for resolving the given name.
protected Context
getURLOrDefaultInitCtx(Name name)
Obtains the context for resolving the given name.
protected void
init(Hashtable environment)
Initialises the context, using the properties, specified in the passed table.
NamingEnumeration
list(String name)
NamingEnumeration
list(Name name)
NamingEnumeration
listBindings(String name)
NamingEnumeration
listBindings(Name name)
Object
lookup(String name)
Object
lookup(Name name)
Object
lookupLink(String name)
Object
lookupLink(Name name)
void
rebind(String name, Object obj)
void
rebind(Name name, Object obj)
Object
removeFromEnvironment(String propName)
void
rename(String oldName, String newName)
void
rename(Name oldName, Name newName)
void
unbind(String name)
void
unbind(Name name)

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

defaultInitCtx

protected Context defaultInitCtx
Contains the default initial context. This value is returned by NamingManager.getInitialContext(Hashtable). It is set by this method when calling it first time. The subsequent calls return the value of this field.

gotDefault

protected boolean gotDefault
Indicates if the initial context was obtained by calling NamingManager.getInitialContext(Hashtable).

myProps

protected Hashtable myProps
The environment, associated with this initial context.

Constructor Details

InitialContext

public InitialContext()
            throws NamingException
Creates teh new initial context with no properties. Same as InitialContext(null).
Throws:
NamingException -

InitialContext

public InitialContext(Hashtable environment)
            throws NamingException
Creates the new initial context with the given properties.
Parameters:
environment - the properties, used by the initial context being created.
Throws:
NamingException -

InitialContext

protected InitialContext(boolean lazy)
            throws NamingException
Creates the initial context with the possibility to delay its initialisation.
Parameters:
lazy - specified if the initialization should not be performed by this constructor (true). If the valueis false, it works the same way as the parameterless constructor.
Throws:
NamingException -

Method Details

addToEnvironment

public Object addToEnvironment(String propName,
                               Object propVal)
            throws NamingException
Specified by:
addToEnvironment in interface Context

bind

public void bind(String name,
                 Object obj)
            throws NamingException
Specified by:
bind in interface Context

bind

public void bind(Name name,
                 Object obj)
            throws NamingException
Specified by:
bind in interface Context

close

public void close()
            throws NamingException
Specified by:
close in interface Context

composeName

public String composeName(String name,
                          String prefix)
            throws NamingException
Specified by:
composeName in interface Context

composeName

public Name composeName(Name name,
                        Name prefix)
            throws NamingException
Specified by:
composeName in interface Context

createSubcontext

public Context createSubcontext(String name)
            throws NamingException
Specified by:
createSubcontext in interface Context

createSubcontext

public Context createSubcontext(Name name)
            throws NamingException
Specified by:
createSubcontext in interface Context

destroySubcontext

public void destroySubcontext(String name)
            throws NamingException
Specified by:
destroySubcontext in interface Context

destroySubcontext

public void destroySubcontext(Name name)
            throws NamingException
Specified by:
destroySubcontext in interface Context

getDefaultInitCtx

protected Context getDefaultInitCtx()
            throws NamingException
Get the default initial context. If gotDefault == false, this method obtains the initial context from the naming manager and sets gotDefault to true. Otherwise the cached value (defaultInitCtx is returned.
Returns:
the default initial context
Throws:
NamingException -

getEnvironment

public Hashtable getEnvironment()
            throws NamingException
Specified by:
getEnvironment in interface Context

getNameInNamespace

public String getNameInNamespace()
            throws NamingException
This operation is not supported for the initial naming context.
Specified by:
getNameInNamespace in interface Context

getNameParser

public NameParser getNameParser(String name)
            throws NamingException
Specified by:
getNameParser in interface Context

getNameParser

public NameParser getNameParser(Name name)
            throws NamingException
Specified by:
getNameParser in interface Context

getURLOrDefaultInitCtx

protected Context getURLOrDefaultInitCtx(String name)
            throws NamingException
Obtains the context for resolving the given name. If the first component of the name is the URL string, this method tries to find the corressponding URL naming context. If it is not an URL string, or the URL context is not found, the default initial context is returned.
Parameters:
name - the name, for that it is required to obtain the context.
Returns:
the context for resolving the name.
Throws:
NamingException -

getURLOrDefaultInitCtx

protected Context getURLOrDefaultInitCtx(Name name)
            throws NamingException
Obtains the context for resolving the given name. If the first component of the name is the URL string, this method tries to find the corressponding URL naming context. If it is not an URL string, or the URL context is not found, the default initial context is returned.
Parameters:
name - the name, for that it is required to obtain the context.
Returns:
the context for resolving the name.
Throws:
NamingException -

init

protected void init(Hashtable environment)
            throws NamingException
Initialises the context, using the properties, specified in the passed table. The missing properties are additionally obtained (in order) from the following locations:
  • If the passed parameter contains the key Context.APPLET, its value must be the instance of the Applet. Then the properties are requested via Applet.getParameter(String).
  • The value of the system property is used.
  • The resource "jndi.properties" is requested from the context class loader of the current thread
  • The property file "jndi.properties" is read from the location, specified by the system property "gnu.classpath.home.url".
Parameters:
environment - the table of the properties, may be null. The method modifies the table and stores the reference to it. The caller must not later reuse this structure for other purposes.
Since:
1.3

list

public NamingEnumeration list(String name)
            throws NamingException
Specified by:
list in interface Context

list

public NamingEnumeration list(Name name)
            throws NamingException
Specified by:
list in interface Context

listBindings

public NamingEnumeration listBindings(String name)
            throws NamingException
Specified by:
listBindings in interface Context

listBindings

public NamingEnumeration listBindings(Name name)
            throws NamingException
Specified by:
listBindings in interface Context

lookup

public Object lookup(String name)
            throws NamingException
Specified by:
lookup in interface Context

lookup

public Object lookup(Name name)
            throws NamingException
Specified by:
lookup in interface Context

lookupLink

public Object lookupLink(String name)
            throws NamingException
Specified by:
lookupLink in interface Context

lookupLink

public Object lookupLink(Name name)
            throws NamingException
Specified by:
lookupLink in interface Context

rebind

public void rebind(String name,
                   Object obj)
            throws NamingException
Specified by:
rebind in interface Context

rebind

public void rebind(Name name,
                   Object obj)
            throws NamingException
Specified by:
rebind in interface Context

removeFromEnvironment

public Object removeFromEnvironment(String propName)
            throws NamingException
Specified by:
removeFromEnvironment in interface Context

rename

public void rename(String oldName,
                   String newName)
            throws NamingException
Specified by:
rename in interface Context

rename

public void rename(Name oldName,
                   Name newName)
            throws NamingException
Specified by:
rename in interface Context

unbind

public void unbind(String name)
            throws NamingException
Specified by:
unbind in interface Context

unbind

public void unbind(Name name)
            throws NamingException
Specified by:
unbind in interface Context

InitialContext.java -- Initial naming context. Copyright (C) 2000, 2002, 2003, 2004, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.