|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.smardec.jndi.mirror.MirrorCtx
MirrorCtx
is a Context
implementation. The class can be saved in XML or
serialized.
Nested Class Summary | |
(package private) class |
MirrorCtx.BindingsEnumeration
Class for enumerating bindings. |
(package private) class |
MirrorCtx.NamesEnumeration
Class for enumerating name/class pairs. |
Field Summary | |
private java.util.Hashtable |
bindings
Context's bindings. |
private java.util.Hashtable |
environment
Environment properties. |
private java.lang.String |
name
Context name. |
private static javax.naming.NameParser |
nameParser
NameParser instance. |
private MirrorCtx |
parent
Parent context. |
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 | |
|
MirrorCtx()
Creates MirrorCtx object. |
(package private) |
MirrorCtx(java.util.Hashtable environment)
Creates MirrorCtx object using the specified environment. |
private |
MirrorCtx(MirrorCtx parent,
java.lang.String name,
java.util.Hashtable environment)
Creates context with specified parent context, name and environment. |
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. |
java.lang.Object |
clone()
Returns cloned 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. |
javax.naming.Context |
createSubcontext(java.lang.String name)
Creates and binds a new context. |
void |
destroySubcontext(javax.naming.Name name)
Destroys the named context and removes it from the namespace. |
void |
destroySubcontext(java.lang.String name)
Destroys the named context and removes it from the namespace. |
java.util.Hashtable |
getBindings()
Returns context bindings. |
java.util.Hashtable |
getEnvironment()
Retrieves the environment in effect for this context. |
java.lang.String |
getName()
Returns context name. |
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. |
MirrorCtx |
getParent()
Returns context parent. |
private javax.naming.Name |
getParsedName(javax.naming.Name name)
Utility method for processing composite/compound name. |
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)
Retrieves the named object, following links except for the terminal atomic component of the name. |
java.lang.Object |
lookupLink(java.lang.String name)
Retrieves the named object, following links except for the terminal atomic component of the name. |
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. |
void |
setBindings(java.util.Hashtable bindings)
Sets context bindings. |
void |
setName(java.lang.String name)
Sets context name. |
void |
setParent(MirrorCtx parent)
Sets context parent. |
java.lang.String |
toString()
Writes itself as XML using XMLEncoder . |
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 |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
private static final javax.naming.NameParser nameParser
NameParser
instance.
private java.util.Hashtable environment
private java.util.Hashtable bindings
private MirrorCtx parent
private java.lang.String name
Constructor Detail |
MirrorCtx(java.util.Hashtable environment)
MirrorCtx
object using the specified environment.
environment
- Environment for the contextprivate MirrorCtx(MirrorCtx parent, java.lang.String name, java.util.Hashtable environment)
parent
- Parent contextname
- Name of the created contextenvironment
- Environment for the contextpublic MirrorCtx()
MirrorCtx
object. Required for XML serialization.
Method Detail |
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
- If the context cannot be cloned.private javax.naming.Name getParsedName(javax.naming.Name name) throws javax.naming.NamingException
name
- The non-null
composite or compound name to process
null
string name in this namespace to be processed.
javax.naming.NamingException
public java.lang.Object addToEnvironment(java.lang.String propName, java.lang.Object propVal) throws javax.naming.NamingException
addToEnvironment
in interface javax.naming.Context
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
null
if the property was
not in the environment before
javax.naming.NamingException
- if a naming exception is encounteredgetEnvironment()
,
removeFromEnvironment(String)
public void bind(javax.naming.Name name, java.lang.Object obj) throws javax.naming.NamingException
bind
in interface javax.naming.Context
name
- the name to bind; may not be emptyobj
- the object to bind; possibly null
javax.naming.NameAlreadyBoundException
- if name is already bound
javax.naming.directory.InvalidAttributesException
- if object did not supply all mandatory attributes
javax.naming.NamingException
- if a naming exception is encounteredbind(String, Object)
,
rebind(javax.naming.Name, Object)
public void bind(java.lang.String name, java.lang.Object obj) throws javax.naming.NamingException
bind(javax.naming.Name, Object)
for details.
bind
in interface javax.naming.Context
name
- the name to bind; may not be emptyobj
- the object to bind; possibly null
javax.naming.NameAlreadyBoundException
- if name is already bound
javax.naming.directory.InvalidAttributesException
- if object did not supply all mandatory attributes
javax.naming.NamingException
- if a naming exception is encounteredpublic void close() throws javax.naming.NamingException
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 javax.naming.Context
javax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.Name composeName(javax.naming.Name name, javax.naming.Name prefix) throws javax.naming.NamingException
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 javax.naming.Context
name
- a name relative to this contextprefix
- the name of this context relative to one of its ancestors
prefix
and name
javax.naming.NamingException
- if a naming exception is encounteredcomposeName(String, String)
public java.lang.String composeName(java.lang.String name, java.lang.String prefix) throws javax.naming.NamingException
composeName(javax.naming.Name, javax.naming.Name)
for details.
composeName
in interface javax.naming.Context
name
- a name relative to this contextprefix
- the name of this context relative to one of its ancestors
prefix
and name
javax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.Context createSubcontext(javax.naming.Name name) throws javax.naming.NamingException
createSubcontext
in interface javax.naming.Context
name
- the name of the context to create; may not be empty
javax.naming.NameAlreadyBoundException
- if name is already bound
javax.naming.directory.InvalidAttributesException
- if creation of the subcontext requires specification of
mandatory attributes
javax.naming.NamingException
- if a naming exception is encounteredcreateSubcontext(String)
public javax.naming.Context createSubcontext(java.lang.String name) throws javax.naming.NamingException
createSubcontext(javax.naming.Name)
for details.
createSubcontext
in interface javax.naming.Context
name
- the name of the context to create; may not be empty
javax.naming.NameAlreadyBoundException
- if name is already bound
javax.naming.directory.InvalidAttributesException
- if creation of the subcontext requires specification of
mandatory attributes
javax.naming.NamingException
- if a naming exception is encounteredpublic void destroySubcontext(javax.naming.Name name) throws javax.naming.NamingException
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 javax.naming.Context
name
- the name of the context to be destroyed; may not be empty
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 encountereddestroySubcontext(String)
public void destroySubcontext(java.lang.String name) throws javax.naming.NamingException
destroySubcontext(javax.naming.Name)
for details.
destroySubcontext
in interface javax.naming.Context
name
- the name of the context to be destroyed; may not be empty
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 encounteredpublic java.util.Hashtable getEnvironment() throws javax.naming.NamingException
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 javax.naming.Context
null
javax.naming.NamingException
- if a naming exception is encounteredaddToEnvironment(String, Object)
,
removeFromEnvironment(String)
public java.lang.String getNameInNamespace() throws javax.naming.NamingException
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 javax.naming.Context
null
javax.naming.OperationNotSupportedException
- if the naming system does
not have the notion of a full name
javax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.NameParser getNameParser(javax.naming.Name name) throws javax.naming.NamingException
getNameParser
in interface javax.naming.Context
name
- the name of the context from which to get the parser
javax.naming.NamingException
- if a naming exception is encounteredgetNameParser(String)
,
CompoundName
public javax.naming.NameParser getNameParser(java.lang.String name) throws javax.naming.NamingException
getNameParser(javax.naming.Name)
for details.
getNameParser
in interface javax.naming.Context
name
- the name of the context from which to get the parser
javax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.NamingEnumeration list(javax.naming.Name name) throws javax.naming.NamingException
If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.
list
in interface javax.naming.Context
name
- the name of the context to list
javax.naming.NamingException
- if a naming exception is encounteredlist(String)
,
listBindings(javax.naming.Name)
public javax.naming.NamingEnumeration list(java.lang.String name) throws javax.naming.NamingException
list(javax.naming.Name)
for details.
list
in interface javax.naming.Context
name
- the name of the context to list
javax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.NamingEnumeration listBindings(javax.naming.Name name) throws javax.naming.NamingException
If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.
listBindings
in interface javax.naming.Context
name
- the name of the context to list
javax.naming.NamingException
- if a naming exception is encounteredlistBindings(String)
,
list(javax.naming.Name)
public javax.naming.NamingEnumeration listBindings(java.lang.String name) throws javax.naming.NamingException
listBindings(javax.naming.Name)
for details.
listBindings
in interface javax.naming.Context
name
- the name of the context to list
javax.naming.NamingException
- if a naming exception is encounteredpublic java.lang.Object lookup(javax.naming.Name name) throws javax.naming.NamingException
lookup
in interface javax.naming.Context
name
- the name of the object to look up
javax.naming.NamingException
- if a naming exception is encounteredlookup(String)
,
lookupLink(javax.naming.Name)
public java.lang.Object lookup(java.lang.String name) throws javax.naming.NamingException
lookup(javax.naming.Name)
for details.
lookup
in interface javax.naming.Context
name
- the name of the object to look up
javax.naming.NamingException
- if a naming exception is encounteredpublic java.lang.Object lookupLink(javax.naming.Name name) throws javax.naming.NamingException
lookupLink
in interface javax.naming.Context
name
- the name of the object to look up
javax.naming.NamingException
- if a naming exception is encounteredlookupLink(String)
public java.lang.Object lookupLink(java.lang.String name) throws javax.naming.NamingException
lookupLink(javax.naming.Name)
for details.
lookupLink
in interface javax.naming.Context
name
- the name of the object to look up
javax.naming.NamingException
- if a naming exception is encounteredpublic void rebind(javax.naming.Name name, java.lang.Object obj) throws javax.naming.NamingException
rebind
in interface javax.naming.Context
name
- the name to bind; may not be emptyobj
- the object to bind; possibly null
javax.naming.directory.InvalidAttributesException
- if object did not supply all mandatory attributes
javax.naming.NamingException
- if a naming exception is encounteredrebind(String, Object)
,
bind(javax.naming.Name, Object)
public void rebind(java.lang.String name, java.lang.Object obj) throws javax.naming.NamingException
rebind(javax.naming.Name, Object)
for details.
rebind
in interface javax.naming.Context
name
- the name to bind; may not be emptyobj
- the object to bind; possibly null
javax.naming.directory.InvalidAttributesException
- if object did not supply all mandatory attributes
javax.naming.NamingException
- if a naming exception is encounteredpublic java.lang.Object removeFromEnvironment(java.lang.String propName) throws javax.naming.NamingException
removeFromEnvironment
in interface javax.naming.Context
propName
- the name of the environment property to remove; may not be null
null
if the property was
not in the environment
javax.naming.NamingException
- if a naming exception is encounteredgetEnvironment()
,
addToEnvironment(String, Object)
public void rename(javax.naming.Name oldName, javax.naming.Name newName) throws javax.naming.NamingException
rename
in interface javax.naming.Context
oldName
- the name of the existing binding; may not be emptynewName
- the name of the new binding; may not be empty
javax.naming.NameAlreadyBoundException
- if newName is already bound
javax.naming.NamingException
- if a naming exception is encounteredrename(String, String)
,
bind(javax.naming.Name, Object)
,
rebind(javax.naming.Name, Object)
public void rename(java.lang.String oldName, java.lang.String newName) throws javax.naming.NamingException
rename(javax.naming.Name, javax.naming.Name)
for details.
rename
in interface javax.naming.Context
oldName
- the name of the existing binding; may not be emptynewName
- the name of the new binding; may not be empty
javax.naming.NameAlreadyBoundException
- if newName is already bound
javax.naming.NamingException
- if a naming exception is encounteredpublic void unbind(javax.naming.Name name) throws javax.naming.NamingException
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 javax.naming.Context
name
- the name to unbind; may not be empty
javax.naming.NameNotFoundException
- if an intermediate context does not exist
javax.naming.NamingException
- if a naming exception is encounteredunbind(String)
public void unbind(java.lang.String name) throws javax.naming.NamingException
unbind(javax.naming.Name)
for details.
unbind
in interface javax.naming.Context
name
- the name to unbind; may not be empty
javax.naming.NameNotFoundException
- if an intermediate context does not exist
javax.naming.NamingException
- if a naming exception is encounteredpublic java.util.Hashtable getBindings()
public void setBindings(java.util.Hashtable bindings)
bindings
- Context bindingspublic java.lang.String getName()
public void setName(java.lang.String name)
name
- Context namepublic MirrorCtx getParent()
public void setParent(MirrorCtx parent)
parent
- Context parentpublic java.lang.String toString()
XMLEncoder
. Works on JDK1.4 and higher.
toString
in class java.lang.Object
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |