oracle.xdb.spi
Class XDBBaseContext

java.lang.Object
  |
  +--oracle.xdb.spi.XDBBaseContext

All Implemented Interfaces:

javax.naming.Context

public class XDBBaseContext

extends java.lang.Object

implements javax.naming.Context

This class implements the guts of the XDB JNDI SPI. The current implementation has no federation support, being completely unaware of the existence of other namespaces.

OBJ_CONTAINER

public static final int OBJ_CONTAINER

See Also:

Constant Field Values

OBJ_DOCUMENT

public static final int OBJ_DOCUMENT

See Also:

Constant Field Values

s_parser

protected static XDBNameParser s_parser

m_env

protected java.util.Hashtable m_env

m_msgBundle

protected java.util.ResourceBundle m_msgBundle

m_path

protected java.lang.String m_path

XDBBaseContext

public XDBBaseContext(java.util.Hashtable env,
                      int type)

XDBBaseContext

protected XDBBaseContext(java.util.Hashtable env,
                         java.lang.String path,
                         int type)

lookupCState

protected long[] lookupCState(java.lang.String name)
                       throws javax.naming.NamingException

javax.naming.NamingException

lookup

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

Retrieves the named object. If the name resolves to a subcontext, the corresponding XDBContext object is returned. If the name resolves to an XML document, the corresponding XDBDocument object is returned.

Specified by:

lookup in interface javax.naming.Context

Parameters:

name - the name to look up, relative to the current context.

Returns:

the object bound and the given name

Throws:

javax.naming.NameNotFoundException - name not found

javax.naming.NamingException - other naming exception

See Also:

XDBDocument

lookup

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

Retrieves the named object. If the name resolves to a subcontext, the corresponding XDBContext object is returned. If the name resolves to an XML document, the corresponding XDBDocument object is returned.

Specified by:

lookup in interface javax.naming.Context

Parameters:

name - the name to look up, relative to the current context.

Returns:

the object bound and the given name

javax.naming.NamingException

See Also:

XDBDocument

bind

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

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

Specified by:

bind in interface javax.naming.Context

Parameters:

name - the name to bind to; may not be empty

obj - the XDBDocument object to bind; may not be null

Throws:

javax.naming.NameNotFoundException - parent path not found

javax.naming.NotContextException - parent path not a context

javax.naming.NameAlreadyBoundException - name already bound

javax.naming.NamingException - other naming exception

See Also:

XDBDocument

bind

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

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

Specified by:

bind in interface javax.naming.Context

Parameters:

name - the name to bind to; may not be empty

obj - the XDBDocument object to bind; may not be null

Throws:

javax.naming.NameNotFoundException - parent path not found

javax.naming.NotContextException - parent path not a context

javax.naming.NameAlreadyBoundException - name already bound

javax.naming.NamingException - other naming exception

See Also:

XDBDocument

rebind

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

Binds the given name to the object, overwriting any existing binding for the name. All intermediate contexts and the target context (that named by all but terminal atomic component of the name) must already exist. The object must be an instance of XDBDocument.

Specified by:

rebind in interface javax.naming.Context

Parameters:

name - the name to bind to; may not be empty

obj - the XDBDocument object to bind; may not be null

Throws:

javax.naming.NameNotFoundException - parent path not found

javax.naming.NotContextException - parent path not a context

javax.naming.NameAlreadyBoundException - name already bound

javax.naming.NamingException - other naming exception

See Also:

XDBDocument

rebind

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

Binds the given name to the object, overwriting any existing binding for the name. All intermediate contexts and the target context (that named by all but terminal atomic component of the name) must already exist. The object must be an instance of XDBDocument.

Specified by:

rebind in interface javax.naming.Context

Parameters:

name - the name to bind to; may not be empty

obj - the XDBDocument object to bind; may not be null

Throws:

javax.naming.NameNotFoundException - parent path not found

javax.naming.NotContextException - parent path not a context

javax.naming.NameAlreadyBoundException - name already bound

javax.naming.NamingException - other naming exception

See Also:

XDBDocument

unbind

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

Unbinds the name object. This method will not throw an exception if the terminal atomic name is not found, as long as the intermediate contexts exist. This method cannot be used to unbind a name bound to a subcontext; use destroySubcontext instead.

Specified by:

unbind in interface javax.naming.Context

Parameters:

name - the name to unbind

Throws:

javax.naming.NameNotFoundException - parent path not found

javax.naming.NotContextException - parent path not a context

javax.naming.OperationNotSupportedException - name bound to subcontext

javax.naming.NamingException - other naming exception

See Also:

XDBContext.destroySubcontext(java.lang.String)

unbind

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

Unbinds the name object. This method will not throw an exception if the terminal atomic name is not found, as long as the intermediate contexts exist. This method cannot be used to unbind a name bound to a subcontext; use destroySubcontext instead.

Specified by:

unbind in interface javax.naming.Context

Parameters:

name - the name to unbind

Throws:

javax.naming.NameNotFoundException - parent path not found

javax.naming.NotContextException - parent path not a context

javax.naming.OperationNotSupportedException - name bound to subcontext

javax.naming.NamingException - other naming exception

See Also:

XDBContext.destroySubcontext(javax.naming.Name)

rename

public void rename(java.lang.String oldname,
                   java.lang.String newname)
            throws javax.naming.NamingException

Bind a new name to the object already bound to another name, then 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 to the new binding; may not be empty

Throws:

javax.naming.NamingException - name not found

javax.naming.OperationNotSupportedException - name bound to subcontext

javax.naming.NamingException - other naming exception

rename

public void rename(javax.naming.Name oldname,
                   javax.naming.Name newname)
            throws javax.naming.NamingException

Binds a new name to the object already bound to another name, then 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 to the new binding; may not be empty

Throws:

javax.naming.NamingException - name not found

javax.naming.OperationNotSupportedException - name bound to subcontext

javax.naming.NamingException - other naming exception

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 bounds to them. The contents of any subcontexts are not included. If a binding is added to or removed from this context, the enumeration is invalidated.

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.NameNotFoundException - context name not found

javax.naming.NotContextException - name not bound to context

javax.naming.NamingException - other naming exception

See Also:

NameClassPair

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 bounds to them. The contents of any subcontexts are not included. If a binding is added to or removed from this context, the enumeration will become invalid. Further operations on the enumeration will produce undefined results. Currently, all objects in the namespace will be of type "XDBContext" or "XDBDocument", for subcontexts and all other bindings, respectively.

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.NameNotFoundException - context name not found

javax.naming.NotContextException - name not bound to context

javax.naming.NamingException - other naming exception

See Also:

NameClassPair

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 bounds to them. The contents of any subcontexts are not included. If a binding is added to or removed from this context, the enumeration will become invalid. Further operations on the enumeration will produce undefined results. Currently, all objects in the namespace will be of type XDBContext or XDBDocument, for subcontexts and all other bindings, respectively.

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.NameNotFoundException - context name not found

javax.naming.NotContextException - name not bound to context

javax.naming.NamingException - other naming exception

See Also:

Binding

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 bounds to them. The contents of any subcontexts are not included. If a binding is added to or removed from this context, the enumeration will become invalid. Further operations on the enumeration will produce undefined results.

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.NameNotFoundException - context name not found

javax.naming.NotContextException - name not bound to context

javax.naming.NamingException - other naming exception

See Also:

Binding

destroySubcontext

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

Unbinds the named subcontext. The subcontext must be empty. This method will not throw an exception if the terminal atomic name is not found, as long as the intermediate contexts exist.

Specified by:

destroySubcontext in interface javax.naming.Context

Parameters:

name - the name of the context to unbind

Throws:

javax.naming.NameNotFoundException - context name not found

javax.naming.NotContextException - name not bound to context

javax.naming.ContextNotEmptyException - context not empty

javax.naming.NamingException - other naming exception

destroySubcontext

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

Unbinds the named subcontext. The subcontext must be empty. This method will not throw an exception if the terminal atomic name is not found, as long as the intermediate contexts exist.

Specified by:

destroySubcontext in interface javax.naming.Context

Parameters:

name - the name of the context to unbind

Throws:

javax.naming.NameNotFoundException - context name not found

javax.naming.NotContextException - name not bound to context

javax.naming.ContextNotEmptyException - context not empty

javax.naming.NamingException - other naming exception

createSubcontext

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

Creates a new subcontext, bound to the given name. All intermediate contexts must already exist. The new context inherits the environment properties of the current context.

Specified by:

createSubcontext in interface javax.naming.Context

Throws:

javax.naming.NameNotFoundException - parent path not found

javax.naming.NotContextException - parent path not a context

javax.naming.NameAlreadyBoundException - name already bound

javax.naming.NamingException - other naming exception

createSubcontext

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

Creates a new subcontext, bound to the given name. All intermediate contexts must already exist. The new context inherits the environment properties of the current context.

Specified by:

createSubcontext in interface javax.naming.Context

Throws:

javax.naming.NameNotFoundException - parent path not found

javax.naming.NotContextException - parent path not a context

javax.naming.NameAlreadyBoundException - name already bound

javax.naming.NamingException - other naming exception

lookupLink

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

Retrieves the named object. If the name resolves to a subcontext, the corresponding XDBContext object is returned. If the name resolves to an XML document, the corresponding XDBDocument object is returned. This namespace does not support links, and thus this method is functionally identical to the lookup method.

Specified by:

lookupLink in interface javax.naming.Context

Parameters:

name - the name to look up, relative to the current context.

Returns:

the object bound and the given name

javax.naming.NamingException

See Also:

XDBContext.lookup(java.lang.String), XDBDocument

lookupLink

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

Retrieves the named object. If the name resolves to a subcontext, the corresponding XDBContext object is returned. If the name resolves to an XML document, the corresponding XDBDocument object is returned. This namespace does not support links, and thus this method is functionally identical to the lookup method.

Specified by:

lookupLink in interface javax.naming.Context

Parameters:

name - the name to look up, relative to the current context.

Returns:

the object bound and the given name

javax.naming.NamingException

See Also:

XDBContext.lookup(javax.naming.Name), XDBDocument

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.NameNotFoundException - context name not found

javax.naming.NotContextException - name not bound to context

javax.naming.NamingException - other naming exception

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.NameNotFoundException - context name not found

javax.naming.NotContextException - name not bound to context

javax.naming.NamingException - other naming exception

addToEnvironment

public java.lang.Object addToEnvironment(java.lang.String propName,
                                         java.lang.Object propVal)

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

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

removeFromEnvironment

public java.lang.Object removeFromEnvironment(java.lang.String propName)

Removes an environment property from the environment of this context. Nothing is done if the property does not exist.

Specified by:

removeFromEnvironment in interface javax.naming.Context

Parameters:

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

Returns:

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

getEnvironment

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

Retrieves the environment properties for this context. The result is a new copy of the environment; changes made to the returned object have no effect on the context.

Specified by:

getEnvironment in interface javax.naming.Context

Returns:

a copy of the environment of this context

javax.naming.NamingException

close

public void close()

Closes this context, signaling the implementation to free the resources taken up by this context. Once the context has been closed, the caller should not invoke any other method on the contet. Invoking this method again has no effect; invoking any other method will give undefined results.

Specified by:

close in interface javax.naming.Context

composeName

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

Composes a name by combining the prefix with the name. The result is the given name appended to the end of the prefix, with the appropriate separator in between. Note that currently, this method differs slightly from the standard JNDI spec: when given legal input (in terms of the JNDI spec), this method will give the correct output; however, this method does not require that the prefix be the name of this context relative to one of its ancestors in the way JNDI requires.

Specified by:

composeName in interface javax.naming.Context

Parameters:

name - the name to append

Returns:

the composition of prefix and name

javax.naming.NamingException

composeName

public java.lang.String composeName(java.lang.String name,
                                    java.lang.String prefix)

Composes a name by combining the prefix with the name. The result is the given name appended to the end of the prefix, with the appropriate separator in between. Note that currently, this method differs slightly from the standard JNDI spec: when given legal input (in terms of the JNDI spec), this method will give the correct output; however, this method does not require that the prefix be the name of this context relative to one of its ancestors in the way JNDI requires.

Specified by:

composeName in interface javax.naming.Context

Parameters:

name - the name to append

Returns:

the composition of prefix and name

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:

the absolute pathname of this context

javax.naming.NamingException