org.objectweb.carol.jndi.spi
Class AbsContext

java.lang.Object
  extended by org.objectweb.carol.jndi.spi.AbsContext
All Implemented Interfaces:
javax.naming.Context
Direct Known Subclasses:
CmiContext, IIOPContext, IRMIContext, JacORBIIOPContext, JEREMIEContext, JRMPContext

public abstract class AbsContext
extends java.lang.Object
implements javax.naming.Context

This abstract class define the common methods used for all existing protocol implementation of their SPI context. When integrating a new protocol, define a new SPI class extending this one. You only have to focus on specific implementation and let in major case all default implementation.

Author:
Florent Benoit

Nested Class Summary
protected  class AbsContext.WrappedEnumeration
          This class is used to return a naming enumeration by decoding encoded names
 
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
protected AbsContext(javax.naming.Context ctx)
          Constructs a wrapper on the given protocol context
 
Method Summary
 java.lang.Object addToEnvironment(java.lang.String propName, java.lang.Object propVal)
          Adds a new environment property to the environment of this context.
protected  java.lang.Object addToExported(javax.naming.Name name, java.lang.Object o)
          Adds a new object to the list of exported objects
 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.
 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.
protected  java.lang.String decode(java.lang.String name)
          undo what encode() does
protected  java.lang.Object defaultUnwrapObject(java.lang.Object o, javax.naming.Name name)
          Default implementation of unwrapObject method If this object is a reference wrapper return the reference If this object is a resource wrapper return the resource
 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.
protected  javax.naming.Name encode(javax.naming.Name initialName)
          Hide special characters from flat namespace registry.
 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.
protected  int getObjectPort()
          Get the object port to use (0 by default, declare this method in a subclass if you want to change value)
protected  javax.naming.Context getWrappedContext()
           
 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.
protected abstract  java.lang.Object unwrapObject(java.lang.Object o, javax.naming.Name name)
          If this object is a reference wrapper return the reference If this object is a resource wrapper return the resource
protected abstract  java.lang.Object wrapObject(java.lang.Object o, javax.naming.Name name, boolean replace)
          Wrap an Object : If the object is a reference wrap it into a Reference Wrapper Object here the good way is to contact the carol configuration to get the portable remote object
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbsContext

protected AbsContext(javax.naming.Context ctx)
Constructs a wrapper on the given protocol context

Parameters:
ctx - the given context (could be jrmp context, jeremie context, iiop context,...).
Method Detail

unwrapObject

protected abstract java.lang.Object unwrapObject(java.lang.Object o,
                                                 javax.naming.Name name)
                                          throws javax.naming.NamingException
If this object is a reference wrapper return the reference If this object is a resource wrapper return the resource

Parameters:
o - the object to resolve
name - name of the object to unwrap
Returns:
the unwrapped object
Throws:
javax.naming.NamingException - if the object cannot be unwraped

wrapObject

protected abstract java.lang.Object wrapObject(java.lang.Object o,
                                               javax.naming.Name name,
                                               boolean replace)
                                        throws javax.naming.NamingException
Wrap an Object : If the object is a reference wrap it into a Reference Wrapper Object here the good way is to contact the carol configuration to get the portable remote object

Parameters:
o - the object to encode
name - of the object
replace - if the object need to be replaced
Returns:
a Remote JNDIRemoteReference Object if o is a resource o if else
Throws:
javax.naming.NamingException - if object cannot be wrapped

defaultUnwrapObject

protected java.lang.Object defaultUnwrapObject(java.lang.Object o,
                                               javax.naming.Name name)
                                        throws javax.naming.NamingException
Default implementation of unwrapObject method If this object is a reference wrapper return the reference If this object is a resource wrapper return the resource

Parameters:
o - the object to resolve
name - name of the object to unwrap
Returns:
the unwrapped object
Throws:
javax.naming.NamingException - if the object cannot be unwraped

getObjectPort

protected int getObjectPort()
Get the object port to use (0 by default, declare this method in a subclass if you want to change value)

Returns:
object port to use

lookup

public java.lang.Object lookup(javax.naming.Name 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

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.

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

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

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. All intermediate contexts and the target context (that named by all but terminal atomic component of the name) must already exist.

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

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

unbind

public void unbind(javax.naming.Name name)
            throws javax.naming.NamingException
Unbinds the named object. Removes the terminal atomic name in name from the target context--that named by all but the terminal atomic part of name.

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

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

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. Both names are relative to this context. Any attributes associated with the old name become associated with the new 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.

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. Any attributes associated with the name are also removed. Intermediate contexts are not destroyed.

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.

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.

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

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

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.

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.

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 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.

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 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

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. See class description for more details on environment properties.

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. See class description for more details on environment properties.

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. See class description for more details on environment properties.

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. This method releases this context's resources immediately, instead of waiting for them to be released automatically by the garbage collector.

Specified by:
close in interface javax.naming.Context
Throws:
javax.naming.NamingException - if a naming exception is encountered

getNameInNamespace

public java.lang.String getNameInNamespace()
                                    throws javax.naming.NamingException
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
Throws:
javax.naming.NamingException - if a naming exception is encountered

addToExported

protected java.lang.Object addToExported(javax.naming.Name name,
                                         java.lang.Object o)
Adds a new object to the list of exported objects

Parameters:
name - JNDI name of the exported object
o - exported object
Returns:
Returns the wrapperHash.

getWrappedContext

protected javax.naming.Context getWrappedContext()
Returns:
the wrappedContext.

encode

protected javax.naming.Name encode(javax.naming.Name initialName)
Hide special characters from flat namespace registry. Escape forward and backward slashes, and leading quote character.

Parameters:
initialName - the name to encode
Returns:
the encoded name

decode

protected java.lang.String decode(java.lang.String name)
undo what encode() does

Parameters:
name - to decode
Returns:
decoded String from the given encoding string