org.ow2.jonas.lib.naming
Class ComponentContext

java.lang.Object
  org.ow2.jonas.lib.naming.ComponentContext

All Implemented Interfaces:

javax.naming.Context

public class ComponentContext
extends java.lang.Object
implements javax.naming.Context

JOnAS implementation of Context interface.
Supports subContexts (because of jndi/, ejb/, ...)

Author:

Philippe Durieux, Philippe Coq monolog, Florent Benoit 2003.06.13 : handle Reference object for the lookup.

Field Summary

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

ComponentContext(java.lang.String id)
Constructor.

ComponentContext(java.lang.String id, java.util.Hashtable env)
Constructor.

Method Summary

protected void	addBinding(java.lang.String bindingName, javax.naming.Context context) Allow to add a binding in order to enhance the current context.
java.lang.Object	addToEnvironment(java.lang.String propName, java.lang.Object propVal) Adds a new environment property to the environment of this context.
protected void	addWrapped(javax.naming.Context wrappedContext) Allow to wrap a given context for delegating lookup operations.
protected void	addWrapped(javax.naming.Context wrappedContext, boolean wrapAllOperations) Allow to wrap a given context for delegating lookup operations.
void	bind(javax.naming.Name name, java.lang.Object obj) Binds a name to an object.
void	bind(java.lang.String name, java.lang.Object obj) Binds a name to an object.
void	close() Closes this context.
javax.naming.Name	composeName(javax.naming.Name name, javax.naming.Name prefix) Composes the name of this context with a name relative to this context.
java.lang.String	composeName(java.lang.String name, java.lang.String prefix) Composes the name of this context with a name relative to this context: Not supported.
javax.naming.Context	createSubcontext(javax.naming.Name name) Creates and binds a new context.
javax.naming.Context	createSubcontext(java.lang.String name) Creates and binds a new context.
void	destroySubcontext(javax.naming.Name name) Destroys the named context and removes it from the namespace.
void	destroySubcontext(java.lang.String name) Destroys the named context and removes it from the namespace.
java.util.Hashtable	getEnvironment() Retrieves the environment in effect for this context.
java.lang.String	getNameInNamespace() Retrieves the full name of this context within its own namespace.
javax.naming.NameParser	getNameParser(javax.naming.Name name) Retrieves the parser associated with the named context.
javax.naming.NameParser	getNameParser(java.lang.String name) Retrieves the parser associated with the named context.
javax.naming.NamingEnumeration	list(javax.naming.Name name) Enumerates the names bound in the named context, along with the class names of objects bound to them.
javax.naming.NamingEnumeration	list(java.lang.String name) Enumerates the names bound in the named context, along with the class names of objects bound to them.
javax.naming.NamingEnumeration	listBindings(javax.naming.Name name) Enumerates the names bound in the named context, along with the objects bound to them.
javax.naming.NamingEnumeration	listBindings(java.lang.String name) Enumerates the names bound in the named context, along with the objects bound to them.
java.lang.Object	lookup(javax.naming.Name name) Retrieves the named object.
java.lang.Object	lookup(java.lang.String name) Retrieves the named object.
java.lang.Object	lookupLink(javax.naming.Name name) Retrieves the named object, following links except for the terminal atomic component of the name.
java.lang.Object	lookupLink(java.lang.String name) Retrieves the named object, following links except for the terminal atomic component of the name.
void	rebind(javax.naming.Name name, java.lang.Object obj) Binds a name to an object, overwriting any existing binding.
void	rebind(java.lang.String name, java.lang.Object obj) Binds a name to an object, overwriting any existing binding.
java.lang.Object	removeFromEnvironment(java.lang.String propName) Removes an environment property from the environment of this context.
void	rename(javax.naming.Name oldName, javax.naming.Name newName) Binds a new name to the object bound to an old name, and unbinds the old name.
void	rename(java.lang.String oldName, java.lang.String newName) Binds a new name to the object bound to an old name, and unbinds the old name.
void	unbind(javax.naming.Name name) Unbinds the named object.
void	unbind(java.lang.String name) Unbinds the named object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentContext

public ComponentContext(java.lang.String id,
                        java.util.Hashtable env)

Constructor.

Parameters:

id - id of the context.

env - initial environment.

ComponentContext

public ComponentContext(java.lang.String id)

Constructor.

Parameters:

id - id of the context.

Method Detail

lookup

public java.lang.Object lookup(javax.naming.Name name)
                        throws javax.naming.NamingException

Retrieves the named object. Delegate to the String version.

Specified by:

lookup in interface javax.naming.Context

Parameters:

name - the name of the object to look up

Returns:

the object bound to name

Throws:

javax.naming.NamingException - if a naming exception is encountered

lookup

public java.lang.Object lookup(java.lang.String name)
                        throws javax.naming.NamingException

Retrieves the named object.

Specified by:

lookup in interface javax.naming.Context

Parameters:

name - the name of the object to look up

Returns:

the object bound to name

Throws:

javax.naming.NamingException - if a naming exception is encountered

bind

public void bind(javax.naming.Name name,
                 java.lang.Object obj)
          throws javax.naming.NamingException

Binds a name to an object. Delegate to the String version.

Specified by:

bind in interface javax.naming.Context

Parameters:

name - the name to bind; may not be empty

obj - the object to bind; possibly null

Throws:

javax.naming.NamingException - if a naming exception is encountered

See Also:

javax.naming.directory.InvalidAttributesException, NameAlreadyBoundException

bind

public void bind(java.lang.String name,
                 java.lang.Object obj)
          throws javax.naming.NamingException

Binds a name to an object.

Specified by:

bind in interface javax.naming.Context

Parameters:

name - the name to bind; may not be empty

obj - the object to bind; possibly null

Throws:

javax.naming.NamingException - if a naming exception is encountered

See Also:

javax.naming.directory.InvalidAttributesException, NameAlreadyBoundException

rebind

public void rebind(javax.naming.Name name,
                   java.lang.Object obj)
            throws javax.naming.NamingException

Binds a name to an object, overwriting any existing binding.

Specified by:

rebind in interface javax.naming.Context

Parameters:

name - the name to bind; may not be empty

obj - the object to bind; possibly null

Throws:

javax.naming.NamingException - if a naming exception is encountered

See Also:

javax.naming.directory.InvalidAttributesException

rebind

public void rebind(java.lang.String name,
                   java.lang.Object obj)
            throws javax.naming.NamingException

Binds a name to an object, overwriting any existing binding.

Specified by:

rebind in interface javax.naming.Context

Parameters:

name - the name to bind; may not be empty

obj - the object to bind; possibly null

Throws:

javax.naming.NamingException - if a naming exception is encountered

See Also:

javax.naming.directory.InvalidAttributesException, InvalidNameException

unbind

public void unbind(javax.naming.Name name)
            throws javax.naming.NamingException

Unbinds the named object.

Specified by:

unbind in interface javax.naming.Context

Parameters:

name - the name to unbind; may not be empty

Throws:

javax.naming.NamingException - if a naming exception is encountered

See Also:

NameNotFoundException

unbind

public void unbind(java.lang.String name)
            throws javax.naming.NamingException

Unbinds the named object.

Specified by:

unbind in interface javax.naming.Context

Parameters:

name - the name to unbind; may not be empty

Throws:

javax.naming.NamingException - if a naming exception is encountered

See Also:

NameNotFoundException, InvalidNameException

rename

public void rename(javax.naming.Name oldName,
                   javax.naming.Name newName)
            throws javax.naming.NamingException

Binds a new name to the object bound to an old name, and unbinds the old name.

Specified by:

rename in interface javax.naming.Context

Parameters:

oldName - the name of the existing binding; may not be empty

newName - the name of the new binding; may not be empty

Throws:

javax.naming.NamingException - if a naming exception is encountered

rename

public void rename(java.lang.String oldName,
                   java.lang.String newName)
            throws javax.naming.NamingException

Binds a new name to the object bound to an old name, and unbinds the old name.

Specified by:

rename in interface javax.naming.Context

Parameters:

oldName - the name of the existing binding; may not be empty

newName - the name of the new binding; may not be empty

Throws:

javax.naming.NamingException - if a naming exception is encountered

list

public javax.naming.NamingEnumeration list(javax.naming.Name name)
                                    throws javax.naming.NamingException

Enumerates the names bound in the named context, along with the class names of objects bound to them. The contents of any subcontexts are not included.

Specified by:

list in interface javax.naming.Context

Parameters:

name - the name of the context to list

Returns:

an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.

Throws:

javax.naming.NamingException - if a naming exception is encountered

list

public javax.naming.NamingEnumeration list(java.lang.String name)
                                    throws javax.naming.NamingException

Enumerates the names bound in the named context, along with the class names of objects bound to them.

Specified by:

list in interface javax.naming.Context

Parameters:

name - the name of the context to list

Returns:

an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.

Throws:

javax.naming.NamingException - if a naming exception is encountered

listBindings

public javax.naming.NamingEnumeration listBindings(javax.naming.Name name)
                                            throws javax.naming.NamingException

Enumerates the names bound in the named context, along with the objects bound to them. The contents of any subcontexts are not included. If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.

Specified by:

listBindings in interface javax.naming.Context

Parameters:

name - the name of the context to list

Returns:

an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.

Throws:

javax.naming.NamingException - if a naming exception is encountered

listBindings

public javax.naming.NamingEnumeration listBindings(java.lang.String name)
                                            throws javax.naming.NamingException

Enumerates the names bound in the named context, along with the objects bound to them.

Specified by:

listBindings in interface javax.naming.Context

Parameters:

name - the name of the context to list

Returns:

an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.

Throws:

javax.naming.NamingException - if a naming exception is encountered

destroySubcontext

public void destroySubcontext(javax.naming.Name name)
                       throws javax.naming.NamingException

Destroys the named context and removes it from the namespace. Not supported yet.

Specified by:

destroySubcontext in interface javax.naming.Context

Parameters:

name - the name of the context to be destroyed; may not be empty

Throws:

javax.naming.NamingException - if a naming exception is encountered

destroySubcontext

public void destroySubcontext(java.lang.String name)
                       throws javax.naming.NamingException

Destroys the named context and removes it from the namespace. Not supported yet.

Specified by:

destroySubcontext in interface javax.naming.Context

Parameters:

name - the name of the context to be destroyed; may not be empty

Throws:

javax.naming.NamingException - if a naming exception is encountered

createSubcontext

public javax.naming.Context createSubcontext(javax.naming.Name name)
                                      throws javax.naming.NamingException

Creates and binds a new context. Creates a new context with the given name and binds it in the target context.

Specified by:

createSubcontext in interface javax.naming.Context

Parameters:

name - the name of the context to create; may not be empty

Returns:

the newly created context

Throws:

javax.naming.NamingException - if a naming exception is encountered

See Also:

javax.naming.directory.InvalidAttributesException, NameAlreadyBoundException

createSubcontext

public javax.naming.Context createSubcontext(java.lang.String name)
                                      throws javax.naming.NamingException

Creates and binds a new context.

Specified by:

createSubcontext in interface javax.naming.Context

Parameters:

name - the name of the context to create; may not be empty

Returns:

the newly created context

Throws:

javax.naming.NamingException - if a naming exception is encountered

See Also:

javax.naming.directory.InvalidAttributesException, NameAlreadyBoundException

lookupLink

public java.lang.Object lookupLink(javax.naming.Name name)
                            throws javax.naming.NamingException

Retrieves the named object, following links except for the terminal atomic component of the name. If the object bound to name is not a link, returns the object itself.

Specified by:

lookupLink in interface javax.naming.Context

Parameters:

name - the name of the object to look up

Returns:

the object bound to name, not following the terminal link (if any).

Throws:

javax.naming.NamingException - if a naming exception is encountered

lookupLink

public java.lang.Object lookupLink(java.lang.String name)
                            throws javax.naming.NamingException

Retrieves the named object, following links except for the terminal atomic component of the name. If the object bound to name is not a link, returns the object itself.

Specified by:

lookupLink in interface javax.naming.Context

Parameters:

name - the name of the object to look up

Returns:

the object bound to name, not following the terminal link (if any)

Throws:

javax.naming.NamingException - if a naming exception is encountered

getNameParser

public javax.naming.NameParser getNameParser(javax.naming.Name name)
                                      throws javax.naming.NamingException

Retrieves the parser associated with the named context.

Specified by:

getNameParser in interface javax.naming.Context

Parameters:

name - the name of the context from which to get the parser

Returns:

a name parser that can parse compound names into their atomic components

Throws:

javax.naming.NamingException - if a naming exception is encountered

getNameParser

public javax.naming.NameParser getNameParser(java.lang.String name)
                                      throws javax.naming.NamingException

Retrieves the parser associated with the named context.

Specified by:

getNameParser in interface javax.naming.Context

Parameters:

name - the name of the context from which to get the parser

Returns:

a name parser that can parse compound names into their atomic components

Throws:

javax.naming.NamingException - if a naming exception is encountered

composeName

public javax.naming.Name composeName(javax.naming.Name name,
                                     javax.naming.Name prefix)
                              throws javax.naming.NamingException

Composes the name of this context with a name relative to this context.

Specified by:

composeName in interface javax.naming.Context

Parameters:

name - a name relative to this context

prefix - the name of this context relative to one of its ancestors

Returns:

the composition of prefix and name

Throws:

javax.naming.NamingException - if a naming exception is encountered

composeName

public java.lang.String composeName(java.lang.String name,
                                    java.lang.String prefix)
                             throws javax.naming.NamingException

Composes the name of this context with a name relative to this context: Not supported.

Specified by:

composeName in interface javax.naming.Context

Parameters:

name - a name relative to this context

prefix - the name of this context relative to one of its ancestors

Returns:

the composition of prefix and name

Throws:

javax.naming.NamingException - if a naming exception is encountered

addToEnvironment

public java.lang.Object addToEnvironment(java.lang.String propName,
                                         java.lang.Object propVal)
                                  throws javax.naming.NamingException

Adds a new environment property to the environment of this context. If the property already exists, its value is overwritten.

Specified by:

addToEnvironment in interface javax.naming.Context

Parameters:

propName - the name of the environment property to add; may not be null

propVal - the value of the property to add; may not be null

Returns:

the previous value of the property, or null if the property was not in the environment before

Throws:

javax.naming.NamingException - if a naming exception is encountered

removeFromEnvironment

public java.lang.Object removeFromEnvironment(java.lang.String propName)
                                       throws javax.naming.NamingException

Removes an environment property from the environment of this context.

Specified by:

removeFromEnvironment in interface javax.naming.Context

Parameters:

propName - the name of the environment property to remove; may not be null

Returns:

the previous value of the property, or null if the property was not in the environment

Throws:

javax.naming.NamingException - if a naming exception is encountered

getEnvironment

public java.util.Hashtable getEnvironment()
                                   throws javax.naming.NamingException

Retrieves the environment in effect for this context.

Specified by:

getEnvironment in interface javax.naming.Context

Returns:

the environment of this context; never null

Throws:

javax.naming.NamingException - if a naming exception is encountered

close

public void close()
           throws javax.naming.NamingException

Closes this context.

Specified by:

close in interface javax.naming.Context

Throws:

javax.naming.NamingException - if a naming exception is encountered

getNameInNamespace

public java.lang.String getNameInNamespace()

Retrieves the full name of this context within its own namespace.

Specified by:

getNameInNamespace in interface javax.naming.Context

Returns:

this context's name in its own namespace; never null

addWrapped

protected void addWrapped(javax.naming.Context wrappedContext)

Allow to wrap a given context for delegating lookup operations.

Parameters:

wrappedContext - the context that will be wrapped

addWrapped

protected void addWrapped(javax.naming.Context wrappedContext,
                          boolean wrapAllOperations)

Allow to wrap a given context for delegating lookup operations.

Parameters:

wrappedContext - the context that will be wrapped

wrapAllOperations - if all access are redirected to this wrapped context

addBinding

protected void addBinding(java.lang.String bindingName,
                          javax.naming.Context context)

Allow to add a binding in order to enhance the current context.

Parameters:

bindingName - the name of the binding

context - the context to add for this binding