com.scand.jndi.registry
Class RegistryContext

java.lang.Object
  com.scand.jndi.registry.RegistryContext

All Implemented Interfaces:

javax.naming.Context

public final class RegistryContext

extends java.lang.Object

implements javax.naming.Context

Context implementation.

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	RegistryContext(java.util.Hashtable environment)
protected	RegistryContext(java.util.Hashtable environment, com.scand.registry.RegistryKey registryKey)

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.
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 (registry key).
javax.naming.Context	createSubcontext(java.lang.String name) Creates and binds a new context (registry key).
void	destroySubcontext(javax.naming.Name name) Destroys the named context (registry key) and removes it from the namespace (registry).
void	destroySubcontext(java.lang.String name) Destroys the named context (registry key) and removes it from the 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.
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) The same as lookup(Name).
java.lang.Object	lookupLink(java.lang.String name) The same as lookup(String).
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.
java.lang.String	toString() Returns a string representation of the object.
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, wait, wait, wait

Constructor Detail

RegistryContext

protected RegistryContext(java.util.Hashtable environment)

RegistryContext

protected RegistryContext(java.util.Hashtable environment,
                          com.scand.registry.RegistryKey registryKey)

Method Detail

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.

See Also:

getEnvironment(), removeFromEnvironment(String)

bind

public void bind(javax.naming.Name name,
                 java.lang.Object obj)
          throws javax.naming.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. Can bind objects of type java.lang.String (REG_SZ), java.lang.Long (REG_DWORD) and com.scand.jndi.registry.ByteArray (REG_BINARY). Serializable objects will be bound as com.scand.jndi.registry.ByteArray (REG_BINARY). Strings are serialized if "com.scand.jndi.registry.forceStringSerialization" is set to "true". If "com.scand.jndi.registry.entryPrefix" is set to "" then the method binds an entry. If "com.scand.jndi.registry.entryPrefix" is set to non-empty string then the method binds an entry if terminal atomic component of the name starts with the value of "com.scand.jndi.registry.entryPrefix", otherwise the method binds a key.

Specified by:

bind in interface javax.naming.Context

Parameters:

name - The name to bind; may not be empty.

obj - The object to bind; can be null only if parameter name is not entry name.

Throws:

javax.naming.NameAlreadyBoundException - if name is already bound.

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

See Also:

bind(String, Object), rebind(Name, Object)

bind

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

Binds a name to an object. See bind(Name, Object) for details.

Specified by:

bind in interface javax.naming.Context

Parameters:

name - The name to bind; may not be empty.

obj - The object to bind; can be null only if parameter name is not entry name (names a key).

Throws:

javax.naming.NameAlreadyBoundException - if name is already bound.

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.

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.

Specified by:

close in interface javax.naming.Context

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. Given a name (name) relative to this context, and the name (prefix) of this context relative to one of its ancestors, this method returns the composition of the two names using the syntax appropriate for the naming system involved. That is, if name names an object relative to this context, the result is the name of the same object, but relative to the ancestor context. None of the names may be null.

For example

  composeName("My Company", "HKCU\\Software")  

will return "HKCU\\Software\\My Company".

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.

See Also:

composeName(String, String)

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. See composeName(Name, Name) for details.

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.

createSubcontext

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

Creates and binds a new context (registry key). 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.

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.NameAlreadyBoundException - if name is already bound.

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

See Also:

createSubcontext(String)

createSubcontext

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

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

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.NameAlreadyBoundException - if name is already bound.

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 (registry key) and removes it from the namespace (registry). 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.

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.NameNotFoundException - if an intermediate context does not exist.

javax.naming.NotContextException - if the name is bound but does not name a context, or does not name a context of the appropriate type.

javax.naming.ContextNotEmptyException - if the named context is not empty.

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

See Also:

destroySubcontext(String)

destroySubcontext

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

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

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.NameNotFoundException - if an intermediate context does not exist.

javax.naming.NotContextException - if the name is bound but does not name a context, or does not name a context of the appropriate type.

javax.naming.ContextNotEmptyException - if the named context is not empty.

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. "com.scand.jndi.registry.entryPrefix" property is always present in the returned hashtable.

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

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

See Also:

addToEnvironment(String, Object), removeFromEnvironment(String)

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.

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.

See Also:

getNameParser(String), CompoundName

getNameParser

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

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

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.

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.

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

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.

See Also:

list(String), listBindings(Name), NameClassPair

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. See list(Name) for details.

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.

See Also:

listBindings(String), list(Name), Binding

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. See listBindings(Name) for details.

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.

lookup

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

Retrieves the named object. If name is empty, returns a new instance of this context (which represents the same naming context as this context, but its environment may be modified independently and it may be accessed concurrently). If registry key's default value is not set and you try to lookup it the NameNotFoundException will be thrown. If "com.scand.jndi.registry.entryPrefix" is set to "" then the method 1) searches for an entry, if found returns entry 2) searches for a key, if found returns key 3) throws NameNotFoundException. If "com.scand.jndi.registry.entryPrefix" is set to non-empty string then the method searches for an entry if terminal atomic component of the name starts with the value of "com.scand.jndi.registry.entryPrefix", otherwise the method searches for a key.

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.NameNotFoundException - if name is not found in the registry.

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

See Also:

lookup(String), lookupLink(Name)

lookup

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

Retrieves the named object. See lookup(Name) for details.

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.

lookupLink

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

The same as lookup(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

See Also:

Context.lookupLink(String)

lookupLink

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

The same as lookup(String).

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

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; can be null only if parameter name is not entry name.

Throws:

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

See Also:

rebind(String, Object), bind(Name, Object)

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. See rebind(Name, Object) for details.

Specified by:

rebind in interface javax.naming.Context

Parameters:

name - The name to bind; may not be empty.

obj - The object to bind; can be null only if parameter name is not entry name.

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. "com.scand.jndi.registry.entryPrefix" property cannot be removed.

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.

See Also:

getEnvironment(), addToEnvironment(String, Object)

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. Intermediate contexts of the old name are not changed. Cannot rename registry keys.

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.NameAlreadyBoundException - if newName is already bound.

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

See Also:

rename(String, String), bind(Name, Object), rebind(Name, Object)

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. See rename(Name, Name) for details.

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.NameAlreadyBoundException - if newName is already bound.

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

toString

public java.lang.String toString()

Description copied from class: java.lang.Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns:

String representation of RegistryContext.

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. If "com.scand.jndi.registry.entryPrefix" is set to "" then the method unbinds an entry. If "com.scand.jndi.registry.entryPrefix" is set to non-empty string then the method unbinds an entry if terminal atomic component of the name starts with the value of "com.scand.jndi.registry.entryPrefix", otherwise the method unbinds a key.

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. Intermediate contexts are not changed.

Specified by:

unbind in interface javax.naming.Context

Parameters:

name - The name to unbind; may not be empty.

Throws:

javax.naming.NameNotFoundException - if an intermediate context does not exist.

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

See Also:

unbind(String)

unbind

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

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

Specified by:

unbind in interface javax.naming.Context

Parameters:

name - The name to unbind; may not be empty.

Throws:

javax.naming.NameNotFoundException - if an intermediate context does not exist.

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