|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.naming.spi.ContinuationContext
This class is for dealing with federations/continuations.
Field Summary | |
protected Context |
contCtx
|
protected CannotProceedException |
cpe
|
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 |
ContinuationContext(CannotProceedException cpe)
|
Method Summary | |
Object |
addToEnvironment(String propName,
Object value)
Adds a new environment property to the environment of this context. |
void |
bind(Name name,
Object newObj)
Binds a name to an object. |
void |
bind(String name,
Object newObj)
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. |
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. |
protected Context |
getTargetContext()
|
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 newObj)
Binds a name to an object, overwriting any existing binding. |
void |
rebind(String name,
Object newObj)
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 name,
Name newName)
Binds a new name to the object bound to an old name, and unbinds the old name. |
void |
rename(String name,
String newName)
Binds a new name to the object bound to an old name, and unbinds the old name. |
ResolveResult |
resolveToClass(Name name,
Class contextType)
Partially resolves a name. |
ResolveResult |
resolveToClass(String name,
Class contextType)
Partially resolves a name. |
void |
unbind(Name name)
Unbinds the named object. |
void |
unbind(String name)
Unbinds the named object. |
Methods inherited from class java.lang.Object |
|
Field Detail |
protected CannotProceedException cpe
protected Context contCtx
Constructor Detail |
protected ContinuationContext(CannotProceedException cpe)
Method Detail |
protected Context getTargetContext() throws NamingException
public Object lookup(Name name) throws NamingException
Context
lookup
in interface Context
javax.naming.Context
name
- the name of the object to look upNamingException
- if a naming exception is encounteredContext.lookup(String)
,
Context.lookupLink(Name)
public Object lookup(String name) throws NamingException
Context
Context.lookup(Name)
for details.lookup
in interface Context
javax.naming.Context
name
- the name of the object to look upNamingException
- if a naming exception is encounteredpublic void bind(Name name, Object newObj) throws NamingException
Context
bind
in interface Context
javax.naming.Context
name
- the name to bind; may not be emptyobj
- the object to bind; possibly nullNameAlreadyBoundException
- if name is already boundInvalidAttributesException
- if object did not supply all mandatory attributesNamingException
- if a naming exception is encounteredContext.bind(String, Object)
,
Context.rebind(Name, Object)
,
DirContext.bind(Name, Object,
javax.naming.directory.Attributes)
public void bind(String name, Object newObj) throws NamingException
Context
Context.bind(Name, Object)
for details.bind
in interface Context
javax.naming.Context
name
- the name to bind; may not be emptyobj
- the object to bind; possibly nullNameAlreadyBoundException
- if name is already boundInvalidAttributesException
- if object did not supply all mandatory attributesNamingException
- if a naming exception is encounteredpublic void rebind(Name name, Object newObj) throws NamingException
Context
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.
rebind
in interface Context
javax.naming.Context
name
- the name to bind; may not be emptyobj
- the object to bind; possibly nullInvalidAttributesException
- if object did not supply all mandatory attributesNamingException
- if a naming exception is encounteredContext.rebind(String, Object)
,
Context.bind(Name, Object)
,
DirContext.rebind(Name, Object,
javax.naming.directory.Attributes)
,
DirContext
public void rebind(String name, Object newObj) throws NamingException
Context
Context.rebind(Name, Object)
for details.rebind
in interface Context
javax.naming.Context
name
- the name to bind; may not be emptyobj
- the object to bind; possibly nullInvalidAttributesException
- if object did not supply all mandatory attributesNamingException
- if a naming exception is encounteredpublic void unbind(Name name) throws NamingException
Context
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.
unbind
in interface Context
javax.naming.Context
name
- the name to unbind; may not be emptyNameNotFoundException
- if an intermediate context does not existNamingException
- if a naming exception is encounteredContext.unbind(String)
public void unbind(String name) throws NamingException
Context
Context.unbind(Name)
for details.unbind
in interface Context
javax.naming.Context
name
- the name to unbind; may not be emptyNameNotFoundException
- if an intermediate context does not existNamingException
- if a naming exception is encounteredpublic void rename(Name name, Name newName) throws NamingException
Context
rename
in interface Context
javax.naming.Context
oldName
- the name of the existing binding; may not be emptynewName
- the name of the new binding; may not be emptyNameAlreadyBoundException
- if newName is already boundNamingException
- if a naming exception is encounteredContext.rename(String, String)
,
Context.bind(Name, Object)
,
Context.rebind(Name, Object)
public void rename(String name, String newName) throws NamingException
Context
Context.rename(Name, Name)
for details.rename
in interface Context
javax.naming.Context
oldName
- the name of the existing binding; may not be emptynewName
- the name of the new binding; may not be emptyNameAlreadyBoundException
- if newName is already boundNamingException
- if a naming exception is encounteredpublic NamingEnumeration list(Name name) throws NamingException
Context
If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.
list
in interface Context
javax.naming.Context
name
- the name of the context to listNamingException
- if a naming exception is encounteredContext.list(String)
,
Context.listBindings(Name)
,
NameClassPair
public NamingEnumeration list(String name) throws NamingException
Context
Context.list(Name)
for details.list
in interface Context
javax.naming.Context
name
- the name of the context to listNamingException
- if a naming exception is encounteredpublic NamingEnumeration listBindings(Name name) throws NamingException
Context
If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.
listBindings
in interface Context
javax.naming.Context
name
- the name of the context to listNamingException
- if a naming exception is encounteredContext.listBindings(String)
,
Context.list(Name)
,
Binding
public NamingEnumeration listBindings(String name) throws NamingException
Context
Context.listBindings(Name)
for details.listBindings
in interface Context
javax.naming.Context
name
- the name of the context to listNamingException
- if a naming exception is encounteredpublic void destroySubcontext(Name name) throws NamingException
Context
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.
destroySubcontext
in interface Context
javax.naming.Context
name
- the name of the context to be destroyed; may not be emptyNameNotFoundException
- if an intermediate context does not existNotContextException
- if the name is bound but does not name a
context, or does not name a context of the appropriate typeContextNotEmptyException
- if the named context is not emptyNamingException
- if a naming exception is encounteredContext.destroySubcontext(String)
public void destroySubcontext(String name) throws NamingException
Context
Context.destroySubcontext(Name)
for details.destroySubcontext
in interface Context
javax.naming.Context
name
- the name of the context to be destroyed; may not be emptyNameNotFoundException
- if an intermediate context does not existNotContextException
- if the name is bound but does not name a
context, or does not name a context of the appropriate typeContextNotEmptyException
- if the named context is not emptyNamingException
- if a naming exception is encounteredpublic Context createSubcontext(Name name) throws NamingException
Context
createSubcontext
in interface Context
javax.naming.Context
name
- the name of the context to create; may not be emptyNameAlreadyBoundException
- if name is already boundInvalidAttributesException
- if creation of the subcontext requires specification of
mandatory attributesNamingException
- if a naming exception is encounteredContext.createSubcontext(String)
,
DirContext.createSubcontext(javax.naming.Name, javax.naming.directory.Attributes)
public Context createSubcontext(String name) throws NamingException
Context
Context.createSubcontext(Name)
for details.createSubcontext
in interface Context
javax.naming.Context
name
- the name of the context to create; may not be emptyNameAlreadyBoundException
- if name is already boundInvalidAttributesException
- if creation of the subcontext requires specification of
mandatory attributesNamingException
- if a naming exception is encounteredpublic Object lookupLink(Name name) throws NamingException
Context
lookupLink
in interface Context
javax.naming.Context
name
- the name of the object to look upNamingException
- if a naming exception is encounteredContext.lookupLink(String)
public Object lookupLink(String name) throws NamingException
Context
Context.lookupLink(Name)
for details.lookupLink
in interface Context
javax.naming.Context
name
- the name of the object to look upNamingException
- if a naming exception is encounteredpublic NameParser getNameParser(Name name) throws NamingException
Context
getNameParser
in interface Context
javax.naming.Context
name
- the name of the context from which to get the parserNamingException
- if a naming exception is encounteredContext.getNameParser(String)
,
CompoundName
public NameParser getNameParser(String name) throws NamingException
Context
Context.getNameParser(Name)
for details.getNameParser
in interface Context
javax.naming.Context
name
- the name of the context from which to get the parserNamingException
- if a naming exception is encounteredpublic Name composeName(Name name, Name prefix) throws NamingException
Context
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(s) 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, if this context is named "wiz.com" relative to the initial context, then
composeName("east", "wiz.com")might return
"east.wiz.com"
.
If instead this context is named "org/research", then
composeName("user/jane", "org/research")might return
"org/research/user/jane"
while
composeName("user/jane", "research")returns
"research/user/jane"
.composeName
in interface Context
javax.naming.Context
name
- a name relative to this contextprefix
- the name of this context relative to one of its ancestorsprefix
and name
NamingException
- if a naming exception is encounteredContext.composeName(String, String)
public String composeName(String name, String prefix) throws NamingException
Context
Context.composeName(Name, Name)
for details.composeName
in interface Context
javax.naming.Context
name
- a name relative to this contextprefix
- the name of this context relative to one of its ancestorsprefix
and name
NamingException
- if a naming exception is encounteredpublic Object addToEnvironment(String propName, Object value) throws NamingException
Context
addToEnvironment
in interface Context
javax.naming.Context
propName
- the name of the environment property to add; may not be nullpropVal
- the value of the property to add; may not be nullNamingException
- if a naming exception is encounteredContext.getEnvironment()
,
Context.removeFromEnvironment(String)
public Object removeFromEnvironment(String propName) throws NamingException
Context
removeFromEnvironment
in interface Context
javax.naming.Context
propName
- the name of the environment property to remove; may not be nullNamingException
- if a naming exception is encounteredContext.getEnvironment()
,
Context.addToEnvironment(String, Object)
public Hashtable getEnvironment() throws NamingException
Context
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().
getEnvironment
in interface Context
javax.naming.Context
NamingException
- if a naming exception is encounteredContext.addToEnvironment(String, Object)
,
Context.removeFromEnvironment(String)
public String getNameInNamespace() throws NamingException
Context
Many naming services have a notion of a "full name" for objects in their respective namespaces. For example, an LDAP entry has a distinguished name, and a DNS record has a fully qualified name. This method allows the client application to retrieve this name. The string returned by this method is not a JNDI composite name and should not be passed directly to context methods. In naming systems for which the notion of full name does not make sense, OperationNotSupportedException is thrown.
getNameInNamespace
in interface Context
javax.naming.Context
OperationNotSupportedException
- if the naming system does
not have the notion of a full nameNamingException
- if a naming exception is encounteredpublic ResolveResult resolveToClass(Name name, Class contextType) throws NamingException
Resolver
Context
.resolveToClass
in interface Resolver
javax.naming.spi.Resolver
name
- the name to resolvecontextType
- the type of object to resolve. This should
be a subtype of Context
.name
. Cannot be null.NotContextException
- if no context of the appropriate type is foundNamingException
- if a naming exception was encounteredResolver.resolveToClass(String, Class)
public ResolveResult resolveToClass(String name, Class contextType) throws NamingException
Resolver
Resolver.resolveToClass(Name, Class)
for details.resolveToClass
in interface Resolver
javax.naming.spi.Resolver
name
- the name to resolvecontextType
- the type of object to resolve. This should
be a subtype of Context
.name
. Cannot be null.NotContextException
- if no context of the appropriate type is foundNamingException
- if a naming exception was encounteredpublic void close() throws NamingException
Context
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.
close
in interface Context
javax.naming.Context
NamingException
- if a naming exception is encountered
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |