APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.jndi.toolkit.ctx

public abstract Class PartialCompositeContext

extends Object
implements Context, Resolver
Class Inheritance
All Implemented Interfaces
javax.naming.spi.Resolver, javax.naming.Context
Known Direct Subclasses
com.sun.jndi.toolkit.ctx.ComponentContext
Imports
java.util.Hashtable, .Enumeration, javax.naming.*, javax.naming.spi.Resolver, .ResolveResult, .NamingManager
PartialCompositeContext implements Context operations on composite names using implementations of the p_ interfaces defined by its subclasses. The main purpose provided by this class is that it deals with partial resolutions and continuations, so that callers of the Context operation don't have to. Types of clients that will be direct subclasses of PartialCompositeContext may be service providers that implement one of the JNDI protocols, but which do not deal with continuations. Usually, service providers will be using one of the subclasses of PartialCompositeContext.
Author
Rosanna Lee

Field Summary

Modifier and TypeField and Description
protected static final int
_ATOMIC

protected static final int
_COMPONENT

protected int
_contextType

pack-priv static final CompositeName
_EMPTY_NAME

pack-priv static CompositeName
_NNS_NAME

protected static final int
_PARTIAL

Constructor Summary

AccessConstructor and Description
protected
PartialCompositeContext()

Method Summary

Modifier and TypeMethod and Description
protected static boolean
allEmpty(Name name)

Tests whether a name contains a nonempty component.

public void
bind(String name, Object newObj)

Implements javax.naming.Context.bind.

Binds a name to an object.

public void
bind(Name name, Object newObj)

Implements javax.naming.Context.bind.

Binds a name to an object.

public String
composeName(String name, String prefix)

Implements javax.naming.Context.composeName.

Composes the name of this context with a name relative to this context.

public Name
composeName(Name name, Name prefix)

Implements javax.naming.Context.composeName.

This default implementation simply concatenates the two names.

public Context
createSubcontext(String name)

Implements javax.naming.Context.createSubcontext.

Creates and binds a new context.

public Context
createSubcontext(Name name)

Implements javax.naming.Context.createSubcontext.

Creates and binds a new context.

public void
destroySubcontext(String name)

Implements javax.naming.Context.destroySubcontext.

Destroys the named context and removes it from the namespace.

public void
destroySubcontext(Name name)

Implements javax.naming.Context.destroySubcontext.

Destroys the named context and removes it from the namespace.

public NameParser
getNameParser(String name)

Implements javax.naming.Context.getNameParser.

Retrieves the parser associated with the named context.

public NameParser
getNameParser(Name name)

Implements javax.naming.Context.getNameParser.

Retrieves the parser associated with the named context.

protected static PartialCompositeContext
getPCContext(Continuation cont)

Retrieves a PartialCompositeContext for the resolved object in cont.

public NamingEnumeration<NameClassPair>
list(String name)

Implements javax.naming.Context.list.

Enumerates the names bound in the named context, along with the class names of objects bound to them.

public NamingEnumeration<NameClassPair>
list(Name name)

Implements javax.naming.Context.list.

Enumerates the names bound in the named context, along with the class names of objects bound to them.

public NamingEnumeration<Binding>
listBindings(String name)

Implements javax.naming.Context.listBindings.

Enumerates the names bound in the named context, along with the objects bound to them.

public NamingEnumeration<Binding>
listBindings(Name name)

Implements javax.naming.Context.listBindings.

Enumerates the names bound in the named context, along with the objects bound to them.

public Object
lookup(String name)

Implements javax.naming.Context.lookup.

Retrieves the named object.

public Object
lookup(Name name)

Implements javax.naming.Context.lookup.

Retrieves the named object.

protected abstract void
p_bind(Name name, Object obj, Continuation cont)

protected abstract Context
p_createSubcontext(Name name, Continuation cont)

protected abstract void
p_destroySubcontext(Name name, Continuation cont)

protected Hashtable<?, ?>

Returns:

The possibly null environment of the context.
p_getEnvironment()

A cheap way of getting the environment.

protected abstract NameParser
p_getNameParser(Name name, Continuation cont)

protected abstract NamingEnumeration<NameClassPair>
p_list(Name name, Continuation cont)

protected abstract NamingEnumeration<Binding>
p_listBindings(Name name, Continuation cont)

protected abstract Object
p_lookup(Name name, Continuation cont)

protected abstract void
p_rebind(Name name, Object obj, Continuation cont)

protected abstract void
p_rename(Name oldname, Name newname, Continuation cont)

protected abstract ResolveResult
p_resolveToClass(Name name, Class<?> contextType, Continuation cont)

protected abstract void
p_unbind(Name name, Continuation cont)

public void
rebind(String name, Object newObj)

Implements javax.naming.Context.rebind.

Binds a name to an object, overwriting any existing binding.

public void
rebind(Name name, Object newObj)

Implements javax.naming.Context.rebind.

Binds a name to an object, overwriting any existing binding.

public void
rename(String oldName, String newName)

Implements javax.naming.Context.rename.

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

public void
rename(Name oldName, Name newName)

Implements javax.naming.Context.rename.

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

public ResolveResult
resolveToClass(String name, Class<? extends Context> contextType)

Implements javax.naming.spi.Resolver.resolveToClass.

Partially resolves a name.

public ResolveResult
resolveToClass(Name name, Class<? extends Context> contextType)

Implements javax.naming.spi.Resolver.resolveToClass.

Partially resolves a name.

public void
unbind(String name)

Implements javax.naming.Context.unbind.

Unbinds the named object.

public void
unbind(Name name)

Implements javax.naming.Context.unbind.

Unbinds the named object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_ATOMICback to summary
protected static final int _ATOMIC
_COMPONENTback to summary
protected static final int _COMPONENT
_contextTypeback to summary
protected int _contextType
_EMPTY_NAMEback to summary
pack-priv static final CompositeName _EMPTY_NAME
_NNS_NAMEback to summary
pack-priv static CompositeName _NNS_NAME
_PARTIALback to summary
protected static final int _PARTIAL

Constructor Detail

PartialCompositeContextback to summary
protected PartialCompositeContext()

Method Detail

allEmptyback to summary
protected static boolean allEmpty(Name name)

Tests whether a name contains a nonempty component.

bindback to summary
public void bind(String name, Object newObj) throws NamingException

Implements javax.naming.Context.bind.

Doc from javax.naming.Context.bind.

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

Exceptions
NamingException:
if a naming exception is encountered
bindback to summary
public void bind(Name name, Object newObj) throws NamingException

Implements javax.naming.Context.bind.

Doc from javax.naming.Context.bind.

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.

Exceptions
NamingException:
if a naming exception is encountered
composeNameback to summary
public String composeName(String name, String prefix) throws NamingException

Implements javax.naming.Context.composeName.

Doc from javax.naming.Context.composeName.

Composes the name of this context with a name relative to this context. See composeName(Name, Name) for details.

Exceptions
NamingException:
if a naming exception is encountered
composeNameback to summary
public Name composeName(Name name, Name prefix) throws NamingException

Implements javax.naming.Context.composeName.

This default implementation simply concatenates the two names. There's one twist when the "java.naming.provider.compose.elideEmpty" environment setting is set to "true": if each name contains a nonempty component, and if 'prefix' ends with an empty component or 'name' starts with one, then one empty component is dropped. For example: 

elideEmpty=false     elideEmpty=true
{"a"} + {"b"}          =>  {"a", "b"}           {"a", "b"}
{"a"} + {""}           =>  {"a", ""}            {"a", ""}
{"a"} + {"", "b"}      =>  {"a", "", "b"}       {"a", "b"}
{"a", ""} + {"b", ""}  =>  {"a", "", "b", ""}   {"a", "b", ""}
{"a", ""} + {"", "b"}  =>  {"a", "", "", "b"}   {"a", "", "b"}
Exceptions
NamingException:

Doc from javax.naming.Context.composeName.

if a naming exception is encountered

createSubcontextback to summary
public Context createSubcontext(String name) throws NamingException

Implements javax.naming.Context.createSubcontext.

Doc from javax.naming.Context.createSubcontext.

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

Exceptions
NamingException:
if a naming exception is encountered
createSubcontextback to summary
public Context createSubcontext(Name name) throws NamingException

Implements javax.naming.Context.createSubcontext.

Doc from javax.naming.Context.createSubcontext.

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.

Exceptions
NamingException:
if a naming exception is encountered
destroySubcontextback to summary
public void destroySubcontext(String name) throws NamingException

Implements javax.naming.Context.destroySubcontext.

Doc from javax.naming.Context.destroySubcontext.

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

Exceptions
NamingException:
if a naming exception is encountered
destroySubcontextback to summary
public void destroySubcontext(Name name) throws NamingException

Implements javax.naming.Context.destroySubcontext.

Doc from javax.naming.Context.destroySubcontext.

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.

Exceptions
NamingException:
if a naming exception is encountered
getNameParserback to summary
public NameParser getNameParser(String name) throws NamingException

Implements javax.naming.Context.getNameParser.

Doc from javax.naming.Context.getNameParser.

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

Exceptions
NamingException:
if a naming exception is encountered
getNameParserback to summary
public NameParser getNameParser(Name name) throws NamingException

Implements javax.naming.Context.getNameParser.

Doc from javax.naming.Context.getNameParser.

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

Exceptions
NamingException:
if a naming exception is encountered
getPCContextback to summary
protected static PartialCompositeContext getPCContext(Continuation cont) throws NamingException

Retrieves a PartialCompositeContext for the resolved object in cont. Throws CannotProceedException if not successful.

listback to summary
public NamingEnumeration<NameClassPair> list(String name) throws NamingException

Implements javax.naming.Context.list.

Doc from javax.naming.Context.list.

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

Exceptions
NamingException:
if a naming exception is encountered
listback to summary
public NamingEnumeration<NameClassPair> list(Name name) throws NamingException

Implements javax.naming.Context.list.

Doc from javax.naming.Context.list.

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.

Exceptions
NamingException:
if a naming exception is encountered
listBindingsback to summary
public NamingEnumeration<Binding> listBindings(String name) throws NamingException

Implements javax.naming.Context.listBindings.

Doc from javax.naming.Context.listBindings.

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

Exceptions
NamingException:
if a naming exception is encountered
listBindingsback to summary
public NamingEnumeration<Binding> listBindings(Name name) throws NamingException

Implements javax.naming.Context.listBindings.

Doc from javax.naming.Context.listBindings.

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.

Exceptions
NamingException:
if a naming exception is encountered
lookupback to summary
public Object lookup(String name) throws NamingException

Implements javax.naming.Context.lookup.

Doc from javax.naming.Context.lookup.

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

Exceptions
NamingException:
if a naming exception is encountered
lookupback to summary
public Object lookup(Name name) throws NamingException

Implements javax.naming.Context.lookup.

Doc from javax.naming.Context.lookup.

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

Exceptions
NamingException:
if a naming exception is encountered
lookupLinkback to summary
public Object lookupLink(String name) throws NamingException

Implements javax.naming.Context.lookupLink.

Doc from javax.naming.Context.lookupLink.

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

Exceptions
NamingException:
if a naming exception is encountered
lookupLinkback to summary
public Object lookupLink(Name name) throws NamingException

Implements javax.naming.Context.lookupLink.

Doc from javax.naming.Context.lookupLink.

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.

Exceptions
NamingException:
if a naming exception is encountered
p_bindback to summary
protected abstract void p_bind(Name name, Object obj, Continuation cont) throws NamingException
p_createSubcontextback to summary
protected abstract Context p_createSubcontext(Name name, Continuation cont) throws NamingException
p_destroySubcontextback to summary
protected abstract void p_destroySubcontext(Name name, Continuation cont) throws NamingException
p_getEnvironmentback to summary
protected Hashtable<?, ?> p_getEnvironment() throws NamingException

A cheap way of getting the environment. Default implementation is NOT cheap because it simply calls getEnvironment(), which most implementations clone before returning. Subclass should ALWAYS override this with the cheapest possible way. The toolkit knows to clone when necessary.

Returns:Hashtable<?, ?>

The possibly null environment of the context.

p_getNameParserback to summary
protected abstract NameParser p_getNameParser(Name name, Continuation cont) throws NamingException
p_listback to summary
protected abstract NamingEnumeration<NameClassPair> p_list(Name name, Continuation cont) throws NamingException
p_listBindingsback to summary
protected abstract NamingEnumeration<Binding> p_listBindings(Name name, Continuation cont) throws NamingException
p_lookupback to summary
protected abstract Object p_lookup(Name name, Continuation cont) throws NamingException
p_lookupLinkback to summary
protected abstract Object p_lookupLink(Name name, Continuation cont) throws NamingException
p_rebindback to summary
protected abstract void p_rebind(Name name, Object obj, Continuation cont) throws NamingException
p_renameback to summary
protected abstract void p_rename(Name oldname, Name newname, Continuation cont) throws NamingException
p_resolveToClassback to summary
protected abstract ResolveResult p_resolveToClass(Name name, Class<?> contextType, Continuation cont) throws NamingException
p_unbindback to summary
protected abstract void p_unbind(Name name, Continuation cont) throws NamingException
rebindback to summary
public void rebind(String name, Object newObj) throws NamingException

Implements javax.naming.Context.rebind.

Doc from javax.naming.Context.rebind.

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

Exceptions
NamingException:
if a naming exception is encountered
rebindback to summary
public void rebind(Name name, Object newObj) throws NamingException

Implements javax.naming.Context.rebind.

Doc from javax.naming.Context.rebind.

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.

Exceptions
NamingException:
if a naming exception is encountered
renameback to summary
public void rename(String oldName, String newName) throws NamingException

Implements javax.naming.Context.rename.

Doc from javax.naming.Context.rename.

Binds a new name to the object bound to an old name, and unbinds the old name. See rename(Name, Name) for details.

Exceptions
NamingException:
if a naming exception is encountered
renameback to summary
public void rename(Name oldName, Name newName) throws NamingException

Implements javax.naming.Context.rename.

Doc from javax.naming.Context.rename.

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

Exceptions
NamingException:
if a naming exception is encountered
resolveToClassback to summary
public ResolveResult resolveToClass(String name, Class<? extends Context> contextType) throws NamingException

Implements javax.naming.spi.Resolver.resolveToClass.

Doc from javax.naming.spi.Resolver.resolveToClass.

Partially resolves a name. See resolveToClass(Name, Class) for details.

Exceptions
NamingException:
if a naming exception was encountered
resolveToClassback to summary
public ResolveResult resolveToClass(Name name, Class<? extends Context> contextType) throws NamingException

Implements javax.naming.spi.Resolver.resolveToClass.

Doc from javax.naming.spi.Resolver.resolveToClass.

Partially resolves a name. Stops at the first context that is an instance of a given subtype of Context.

Exceptions
NamingException:
if a naming exception was encountered
unbindback to summary
public void unbind(String name) throws NamingException

Implements javax.naming.Context.unbind.

Doc from javax.naming.Context.unbind.

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

Exceptions
NamingException:
if a naming exception is encountered
unbindback to summary
public void unbind(Name name) throws NamingException

Implements javax.naming.Context.unbind.

Doc from javax.naming.Context.unbind.

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.

Exceptions
NamingException:
if a naming exception is encountered