fr.dyade.aaa.jndi2.scn

Class scnURLContext

Implemented Interfaces:
Context

public class scnURLContext
extends java.lang.Object
implements Context

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

Field Summary

static Logger
logger

Constructor Summary

scnURLContext(Hashtable env)
Constructor

Method Summary

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

Field Details

logger

public static final Logger logger

Constructor Details

scnURLContext

public scnURLContext(Hashtable env)
            throws NamingException
Constructor

Method Details

addToEnvironment

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

See Also:
getEnvironment(), removeFromEnvironment(String)


bind

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

See Also:
bind(String,Object), rebind(Name,Object), javax.naming.directory.DirContext.bind(Name, Object, javax.naming.directory.Attributes)


bind

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


close

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


composeName

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

See Also:
composeName(String,String)


composeName

public String composeName(String name,
                          String prefix)
            throws NamingException
Composes the name of this context with a name relative to this context: Not supported.

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


createSubcontext

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

See Also:
createSubcontext(String), javax.naming.directory.DirContext.createSubcontext


createSubcontext

public Context createSubcontext(String name)
            throws NamingException

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

Returns:
the newly created context


destroySubcontext

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

See Also:
destroySubcontext(String)


destroySubcontext

public void destroySubcontext(String name)
            throws NamingException

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


getEnvironment

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

See Also:
addToEnvironment(String,Object), removeFromEnvironment(String)


getNameInNamespace

public String getNameInNamespace()
            throws NamingException
Retrieves the full name of this context within its own namespace. Not implemented.

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


getNameParser

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

See Also:
getNameParser(String), CompoundName


getNameParser

public NameParser getNameParser(String name)
            throws NamingException

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


list

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

See Also:
list(String), listBindings(Name), NameClassPair


list

public NamingEnumeration list(String name)
            throws NamingException

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.


listBindings

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

See Also:
listBindings(String), list(Name), Binding


listBindings

public NamingEnumeration listBindings(String name)
            throws NamingException

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.


lookup

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


lookup

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


lookupLink

public Object 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).

See Also:
lookupLink(String)


lookupLink

public Object lookupLink(String name)
            throws NamingException

Parameters:
name - the name of the object to look up

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


rebind

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


rebind

public void rebind(String name,
                   Object obj)
            throws NamingException

Parameters:
name - the name to bind; may not be empty
obj - the object to bind; possibly null


removeFromEnvironment

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

See Also:
getEnvironment(), addToEnvironment(String,Object)


rename

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


rename

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


unbind

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

See Also:
unbind(String)


unbind

public void unbind(String name)
            throws NamingException

Parameters:
name - the name to unbind; may not be empty


Copyright B) 2004 Scalagent - All rights reserved