Main Page | Packages | Class Hierarchy | Class List | File List | Class Members | Related Pages | Search for 

org.objectweb.jonas.naming.java.javaURLContext Class Reference

Collaboration diagram for org.objectweb.jonas.naming.java.javaURLContext:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 javaURLContext (Hashtable env) throws NamingException
Object lookup (Name name) throws NamingException
Object lookup (String name) throws NamingException
void bind (Name name, Object obj) throws NamingException
void bind (String name, Object obj) throws NamingException
void rebind (Name name, Object obj) throws NamingException
void rebind (String name, Object obj) throws NamingException
void unbind (Name name) throws NamingException
void unbind (String name) throws NamingException
void rename (Name oldName, Name newName) throws NamingException
void rename (String oldName, String newName) throws NamingException
NamingEnumeration list (Name name) throws NamingException
NamingEnumeration list (String name) throws NamingException
NamingEnumeration listBindings (Name name) throws NamingException
NamingEnumeration listBindings (String name) throws NamingException
void destroySubcontext (Name name) throws NamingException
void destroySubcontext (String name) throws NamingException
Context createSubcontext (Name name) throws NamingException
Context createSubcontext (String name) throws NamingException
Object lookupLink (Name name) throws NamingException
Object lookupLink (String name) throws NamingException
NameParser getNameParser (Name name) throws NamingException
NameParser getNameParser (String name) throws NamingException
Name composeName (Name name, Name prefix) throws NamingException
String composeName (String name, String prefix) throws NamingException
Object addToEnvironment (String propName, Object propVal) throws NamingException
Object removeFromEnvironment (String propName) throws NamingException
Hashtable getEnvironment () throws NamingException
void close () throws NamingException
String getNameInNamespace () throws NamingException

Detailed Description

Context implementation for the "java:" namespace. Package must be named .../java (See Initial Context) Most operations consist of retrieving the actual CompNamingContext and sending it the operation for processing.

Author:
Philippe Durieux Contributor(s): Philippe Coq Monolog

Definition at line 55 of file javaURLContext.java.

Constructor & Destructor Documentation

org.objectweb.jonas.naming.java.javaURLContext.javaURLContext (  Hashtable  env  )  throws NamingException
 

Constructor

Parameters:
env the environment
Exceptions:
NamingException if it can be built.

Definition at line 99 of file javaURLContext.java.

Member Function Documentation

Object org.objectweb.jonas.naming.java.javaURLContext.addToEnvironment (  String  propName,
Object  propVal
)  throws 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.

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
Exceptions:
NamingException if a naming exception is encountered
See also:
getEnvironment()

removeFromEnvironment(String)

Definition at line 613 of file javaURLContext.java.

void org.objectweb.jonas.naming.java.javaURLContext.bind (  String  name,
Object  obj
)  throws NamingException
 

Binds a name to an object. All intermediate contexts and the target context (that named by all but terminal atomic component of the name) must already exist.

Parameters:
name the name to bind; may not be empty
obj the object to bind; possibly null
Exceptions:
NameAlreadyBoundException if name is already bound
javax.naming.directory.InvalidAttributesException if object did not supply all mandatory attributes
NamingException if a naming exception is encountered

Definition at line 212 of file javaURLContext.java.

void org.objectweb.jonas.naming.java.javaURLContext.bind (  Name  name,
Object  obj
)  throws NamingException
 

Binds a name to an object.

Parameters:
name the name to bind; may not be empty
obj the object to bind; possibly null
Exceptions:
NameAlreadyBoundException if name is already bound
javax.naming.directory.InvalidAttributesException if object did not supply all mandatory attributes
NamingException if a naming exception is encountered
See also:
bind(String, Object)

rebind(Name, Object)

javax.naming.directory.DirContext#bind(Name, Object, javax.naming.directory.Attributes)

Definition at line 194 of file javaURLContext.java.

void org.objectweb.jonas.naming.java.javaURLContext.close (   )  throws 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.

This method is idempotent: invoking it on a context that has already been closed has no effect. Invoking any other method on a closed context is not allowed, and results in undefined behaviour.

Exceptions:
NamingException if a naming exception is encountered

Definition at line 665 of file javaURLContext.java.

String org.objectweb.jonas.naming.java.javaURLContext.composeName (  String  name,
String  prefix
)  throws NamingException
 

Composes the name of this context with a name relative to this 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
Exceptions:
NamingException if a naming exception is encountered

Definition at line 593 of file javaURLContext.java.

Name org.objectweb.jonas.naming.java.javaURLContext.composeName (  Name  name,
Name  prefix
)  throws NamingException
 

Composes the name of this context with a name relative to this 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
Exceptions:
NamingException if a naming exception is encountered
See also:
composeName(String, String)

Definition at line 577 of file javaURLContext.java.

Context org.objectweb.jonas.naming.java.javaURLContext.createSubcontext (  String  name  )  throws NamingException
 

Creates and binds a new context. See createSubcontext(Name) for details.

Parameters:
name the name of the context to create; may not be empty
Returns:
the newly created context
Exceptions:
NameAlreadyBoundException if name is already bound
javax.naming.directory.InvalidAttributesException if creation of the subcontext requires specification of mandatory attributes
NamingException if a naming exception is encountered

Definition at line 490 of file javaURLContext.java.

Context org.objectweb.jonas.naming.java.javaURLContext.createSubcontext (  Name  name  )  throws NamingException
 

Creates and binds a new context. Creates a new context with the given name and binds it in the target context (that named by all but terminal atomic component of the name). All intermediate contexts and the target context must already exist.

Parameters:
name the name of the context to create; may not be empty
Returns:
the newly created context
Exceptions:
NameAlreadyBoundException if name is already bound
javax.naming.directory.InvalidAttributesException if creation of the subcontext requires specification of mandatory attributes
NamingException if a naming exception is encountered
See also:
createSubcontext(String)

javax.naming.directory.DirContext#createSubcontext

Definition at line 472 of file javaURLContext.java.

void org.objectweb.jonas.naming.java.javaURLContext.destroySubcontext (  String  name  )  throws NamingException
 

Destroys the named context and removes it from the namespace. See destroySubcontext(Name) for details.

Parameters:
name the name of the context to be destroyed; may not be empty
Exceptions:
NameNotFoundException if an intermediate context does not exist
NotContextException if the name is bound but does not name a context, or does not name a context of the appropriate type
ContextNotEmptyException if the named context is not empty
NamingException if a naming exception is encountered

Definition at line 448 of file javaURLContext.java.

void org.objectweb.jonas.naming.java.javaURLContext.destroySubcontext (  Name  name  )  throws 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.

This method is idempotent. It succeeds even if the terminal atomic name is not bound in the target context, but throws NameNotFoundException if any of the intermediate contexts do not exist.

In a federated naming system, a context from one naming system may be bound to a name in another. One can subsequently look up and perform operations on the foreign context using a composite name. However, an attempt destroy the context using this composite name will fail with NotContextException, because the foreign context is not a "subcontext" of the context in which it is bound. Instead, use unbind() to remove the binding of the foreign context. Destroying the foreign context requires that the destroySubcontext() be performed on a context from the foreign context's "native" naming system.

Parameters:
name the name of the context to be destroyed; may not be empty
Exceptions:
NameNotFoundException if an intermediate context does not exist
NotContextException if the name is bound but does not name a context, or does not name a context of the appropriate type
ContextNotEmptyException if the named context is not empty
NamingException if a naming exception is encountered
See also:
destroySubcontext(String)

Definition at line 432 of file javaURLContext.java.

Hashtable org.objectweb.jonas.naming.java.javaURLContext.getEnvironment (   )  throws NamingException
 

Retrieves the environment in effect for this context. See class description for more details on environment properties.

The caller should not make any changes to the object returned: their effect on the context is undefined. The environment of this context may be changed using addToEnvironment() and removeFromEnvironment().

Returns:
the environment of this context; never null
Exceptions:
NamingException if a naming exception is encountered
See also:
addToEnvironment(String, Object)

removeFromEnvironment(String)

Definition at line 650 of file javaURLContext.java.

String org.objectweb.jonas.naming.java.javaURLContext.getNameInNamespace (   )  throws NamingException
 

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

Returns:
this context's name in its own namespace; never null
Exceptions:
OperationNotSupportedException if the naming system does not have the notion of a full name
NamingException if a naming exception is encountered

Definition at line 678 of file javaURLContext.java.

NameParser org.objectweb.jonas.naming.java.javaURLContext.getNameParser (  String  name  )  throws NamingException
 

Retrieves the parser associated with the named context. See getNameParser(Name) for details.

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
Exceptions:
NamingException if a naming exception is encountered

Definition at line 560 of file javaURLContext.java.

NameParser org.objectweb.jonas.naming.java.javaURLContext.getNameParser (  Name  name  )  throws NamingException
 

Retrieves the parser associated with the named context. In a federation of namespaces, different naming systems will parse names differently. This method allows an application to get a parser for parsing names into their atomic components using the naming convention of a particular naming system. Within any single naming system, NameParser objects returned by this method must be equal (using the equals() test).

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
Exceptions:
NamingException if a naming exception is encountered
See also:
getNameParser(String)

CompoundName

Definition at line 546 of file javaURLContext.java.

NamingEnumeration org.objectweb.jonas.naming.java.javaURLContext.list (  String  name  )  throws NamingException
 

Enumerates the names bound in the named context, along with the class names of objects bound to them. See list(Name) for details.

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.
Exceptions:
NamingException if a naming exception is encountered

Definition at line 356 of file javaURLContext.java.

NamingEnumeration org.objectweb.jonas.naming.java.javaURLContext.list (  Name  name  )  throws 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.

If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.

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.
Exceptions:
NamingException if a naming exception is encountered
See also:
list(String)

listBindings(Name)

NameClassPair

Definition at line 340 of file javaURLContext.java.

NamingEnumeration org.objectweb.jonas.naming.java.javaURLContext.listBindings (  String  name  )  throws NamingException
 

Enumerates the names bound in the named context, along with the objects bound to them. See listBindings(Name) for details.

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.
Exceptions:
NamingException if a naming exception is encountered

Definition at line 395 of file javaURLContext.java.

NamingEnumeration org.objectweb.jonas.naming.java.javaURLContext.listBindings (  Name  name  )  throws 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.

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.
Exceptions:
NamingException if a naming exception is encountered
See also:
listBindings(String)

list(Name)

Binding

Definition at line 379 of file javaURLContext.java.

Object org.objectweb.jonas.naming.java.javaURLContext.lookup (  String  name  )  throws NamingException
 

Retrieves the named object.

Parameters:
name the name of the object to look up
Returns:
the object bound to name
Exceptions:
NamingException if a naming exception is encountered

Definition at line 175 of file javaURLContext.java.

Object org.objectweb.jonas.naming.java.javaURLContext.lookup (  Name  name  )  throws NamingException
 

Retrieves the named object.

Parameters:
name the name of the object to look up
Returns:
the object bound to name
Exceptions:
NamingException if a naming exception is encountered

Definition at line 164 of file javaURLContext.java.

Object org.objectweb.jonas.naming.java.javaURLContext.lookupLink (  String  name  )  throws NamingException
 

Retrieves the named object, following links except for the terminal atomic component of the name. See lookupLink(Name) for details.

Parameters:
name the name of the object to look up
Returns:
the object bound to name, not following the terminal link (if any)
Exceptions:
NamingException if a naming exception is encountered

Definition at line 523 of file javaURLContext.java.

Object org.objectweb.jonas.naming.java.javaURLContext.lookupLink (  Name  name  )  throws 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.

Parameters:
name the name of the object to look up
Returns:
the object bound to name, not following the terminal link (if any).
Exceptions:
NamingException if a naming exception is encountered
See also:
lookupLink(String)

Definition at line 508 of file javaURLContext.java.

void org.objectweb.jonas.naming.java.javaURLContext.rebind (  String  name,
Object  obj
)  throws NamingException
 

Binds a name to an object, overwriting any existing binding. See rebind(Name, Object) for details.

Parameters:
name the name to bind; may not be empty
obj the object to bind; possibly null
Exceptions:
javax.naming.directory.InvalidAttributesException if object did not supply all mandatory attributes
NamingException if a naming exception is encountered

Definition at line 251 of file javaURLContext.java.

void org.objectweb.jonas.naming.java.javaURLContext.rebind (  Name  name,
Object  obj
)  throws 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.

If the object is a DirContext, any existing attributes associated with the name are replaced with those of the object. Otherwise, any existing attributes associated with the name remain unchanged.

Parameters:
name the name to bind; may not be empty
obj the object to bind; possibly null
Exceptions:
javax.naming.directory.InvalidAttributesException if object did not supply all mandatory attributes
NamingException if a naming exception is encountered

Definition at line 235 of file javaURLContext.java.

Object org.objectweb.jonas.naming.java.javaURLContext.removeFromEnvironment (  String  propName  )  throws NamingException
 

Removes an environment property from the environment of this context. See class description for more details on environment properties.

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
Exceptions:
NamingException if a naming exception is encountered
See also:
getEnvironment()

addToEnvironment(String, Object)

Definition at line 631 of file javaURLContext.java.

void org.objectweb.jonas.naming.java.javaURLContext.rename (  String  oldName,
String  newName
)  throws NamingException
 

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

Parameters:
oldName the name of the existing binding; may not be empty
newName the name of the new binding; may not be empty
Exceptions:
NamingException if a naming exception is encountered

Definition at line 317 of file javaURLContext.java.

void org.objectweb.jonas.naming.java.javaURLContext.rename (  Name  oldName,
Name  newName
)  throws NamingException
 

Binds a new name to the object bound to an old name, and unbinds the old name. This operation is not supported (read only env.)

Parameters:
oldName the name of the existing binding; may not be empty
newName the name of the new binding; may not be empty
Exceptions:
NamingException if a naming exception is encountered

Definition at line 303 of file javaURLContext.java.

void org.objectweb.jonas.naming.java.javaURLContext.unbind (  String  name  )  throws NamingException
 

Unbinds the named object. See unbind(Name) for details.

Parameters:
name the name to unbind; may not be empty
Exceptions:
NameNotFoundException if an intermediate context does not exist
NamingException if a naming exception is encountered

Definition at line 289 of file javaURLContext.java.

void org.objectweb.jonas.naming.java.javaURLContext.unbind (  Name  name  )  throws 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.

This method is idempotent. It succeeds even if the terminal atomic name is not bound in the target context, but throws NameNotFoundException if any of the intermediate contexts do not exist.

Any attributes associated with the name are removed. Intermediate contexts are not changed.

Parameters:
name the name to unbind; may not be empty
Exceptions:
NameNotFoundException if an intermediate context does not exist
NamingException if a naming exception is encountered
See also:
unbind(String)

Definition at line 276 of file javaURLContext.java.

The documentation for this class was generated from the following file:
Generated on Tue Feb 15 15:07:16 2005 for JOnAS by  doxygen 1.3.9.1