com.resilientedge.util.naming
Class AbstractCtx

java.lang.Object
  |
  +--com.resilientedge.util.naming.AbstractCtx
All Implemented Interfaces:
javax.naming.Context, ContextAncestors, javax.naming.event.EventContext
Direct Known Subclasses:
AbstractFederatedCtx, AbstractSimpleCtx, DelegatingCtx

public abstract class AbstractCtx
extends java.lang.Object
implements javax.naming.event.EventContext, ContextAncestors

Closing the the context will free its resources. Use of the context after closing will have unpredictable results.

Author:
jgardner

Fields inherited from interface javax.naming.event.EventContext
OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE
 
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
AbstractCtx()
          The default constructor will create an empty Context with an empty environment and no parent.
AbstractCtx(javax.naming.Context parent, java.util.Hashtable env)
           
 
Method Summary
 void addNamingListener(javax.naming.Name target, int scope, javax.naming.event.NamingListener l)
           
 void addNamingListener(java.lang.String target, int scope, javax.naming.event.NamingListener l)
           
 java.lang.Object addToEnvironment(java.lang.String name, java.lang.Object value)
           
 void bind(java.lang.String name, java.lang.Object obj)
           
 void close()
          Closing the the context will free its resources.
 javax.naming.Name composeName(javax.naming.Name name, javax.naming.Name prefix)
           
 java.lang.String composeName(java.lang.String name, java.lang.String prefix)
           
 javax.naming.Context createSubcontext(javax.naming.Name name)
           
 javax.naming.Context createSubcontext(java.lang.String name)
           
 void destroySubcontext(javax.naming.Name name)
           
 void destroySubcontext(java.lang.String name)
           
protected  void fireObjectChangeEvent(javax.naming.event.NamingEvent ev)
           
 java.util.Hashtable getEnvironment()
           
 java.lang.String getNameInNamespace()
           
protected abstract  javax.naming.NameParser getNameParser()
           
 javax.naming.NameParser getNameParser(javax.naming.Name name)
           
 javax.naming.NameParser getNameParser(java.lang.String name)
           
 javax.naming.Context getParentContext()
          Return the parent context.
 javax.naming.Context getRootContext()
          Return the root context.
 javax.naming.NamingEnumeration list(java.lang.String name)
           
 javax.naming.NamingEnumeration listBindings(java.lang.String name)
           
 java.lang.Object lookup(java.lang.String name)
           
 java.lang.Object lookupLink(java.lang.String name)
           
 void rebind(java.lang.String name, java.lang.Object obj)
           
 java.lang.Object removeFromEnvironment(java.lang.String name)
           
 void removeNamingListener(javax.naming.event.NamingListener l)
           
 void rename(java.lang.String oldName, java.lang.String newName)
           
 void setParentContext(javax.naming.Context ctx)
          Set the parent Context of this Context .
 boolean targetMustExist()
           
 void unbind(java.lang.String name)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.naming.Context
bind, list, listBindings, lookup, lookupLink, rebind, rename, unbind
 

Constructor Detail

AbstractCtx

public AbstractCtx()
The default constructor will create an empty Context with an empty environment and no parent.

AbstractCtx

public AbstractCtx(javax.naming.Context parent,
                   java.util.Hashtable env)
Parameters:
parent - The parent Context of this Context. May be null.
env - The environment for this context. May be null.
Method Detail

setParentContext

public void setParentContext(javax.naming.Context ctx)
Set the parent Context of this Context .
Parameters:
ctx - The new ParentContext value

getNameParser

public javax.naming.NameParser getNameParser(java.lang.String name)
                                      throws javax.naming.NamingException
Specified by:
getNameParser in interface javax.naming.Context
Parameters:
name - Parameter Description
Returns:
The NameParser value
Throws:
javax.naming.NamingException - Exception Description

getNameParser

public javax.naming.NameParser getNameParser(javax.naming.Name name)
                                      throws javax.naming.NamingException
Specified by:
getNameParser in interface javax.naming.Context
Parameters:
name - Parameter Description
Returns:
The NameParser value
Throws:
javax.naming.NamingException - Exception Description

getEnvironment

public java.util.Hashtable getEnvironment()
                                   throws javax.naming.NamingException
Specified by:
getEnvironment in interface javax.naming.Context
Returns:
The Environment value
Throws:
javax.naming.NamingException - Exception Description

getNameInNamespace

public java.lang.String getNameInNamespace()
                                    throws javax.naming.NamingException
Specified by:
getNameInNamespace in interface javax.naming.Context
Returns:
The NameInNamespace value
Throws:
javax.naming.NamingException - Exception Description

getParentContext

public javax.naming.Context getParentContext()
Return the parent context.

Specified by:
getParentContext in interface ContextAncestors
Returns:
Context Return the parent Context . Returns null if there is no parent.

getRootContext

public javax.naming.Context getRootContext()
Return the root context.

Specified by:
getRootContext in interface ContextAncestors
Returns:
Context Return a non null Context . The Context may be this .

lookup

public java.lang.Object lookup(java.lang.String name)
                        throws javax.naming.NamingException
Specified by:
lookup in interface javax.naming.Context
Parameters:
name - Parameter Description
Returns:
Returned Value Description
Throws:
javax.naming.NamingException - Exception Description

bind

public void bind(java.lang.String name,
                 java.lang.Object obj)
          throws javax.naming.NamingException
Specified by:
bind in interface javax.naming.Context
Parameters:
name - Parameter Description
obj - Parameter Description
Throws:
javax.naming.NamingException - Exception Description

rebind

public void rebind(java.lang.String name,
                   java.lang.Object obj)
            throws javax.naming.NamingException
Specified by:
rebind in interface javax.naming.Context
Parameters:
name - Parameter Description
obj - Parameter Description
Throws:
javax.naming.NamingException - Exception Description

unbind

public void unbind(java.lang.String name)
            throws javax.naming.NamingException
Specified by:
unbind in interface javax.naming.Context
Parameters:
name - Parameter Description
Throws:
javax.naming.NamingException - Exception Description

rename

public void rename(java.lang.String oldName,
                   java.lang.String newName)
            throws javax.naming.NamingException
Specified by:
rename in interface javax.naming.Context
Parameters:
oldName - Parameter Description
newName - Parameter Description
Throws:
javax.naming.NamingException - Exception Description

list

public javax.naming.NamingEnumeration list(java.lang.String name)
                                    throws javax.naming.NamingException
Specified by:
list in interface javax.naming.Context
Parameters:
name - Parameter Description
Returns:
Returned Value Description
Throws:
javax.naming.NamingException - Exception Description

listBindings

public javax.naming.NamingEnumeration listBindings(java.lang.String name)
                                            throws javax.naming.NamingException
Specified by:
listBindings in interface javax.naming.Context
Parameters:
name - Parameter Description
Returns:
Returned Value Description
Throws:
javax.naming.NamingException - Exception Description

destroySubcontext

public void destroySubcontext(java.lang.String name)
                       throws javax.naming.NamingException
Specified by:
destroySubcontext in interface javax.naming.Context
Parameters:
name - Parameter Description
Throws:
javax.naming.NamingException - Exception Description

destroySubcontext

public void destroySubcontext(javax.naming.Name name)
                       throws javax.naming.NamingException
Specified by:
destroySubcontext in interface javax.naming.Context
Parameters:
name - Parameter Description
Throws:
javax.naming.NamingException - Exception Description

createSubcontext

public javax.naming.Context createSubcontext(java.lang.String name)
                                      throws javax.naming.NamingException
Specified by:
createSubcontext in interface javax.naming.Context
Parameters:
name - Parameter Description
Returns:
Returned Value Description
Throws:
javax.naming.NamingException - Exception Description

createSubcontext

public javax.naming.Context createSubcontext(javax.naming.Name name)
                                      throws javax.naming.NamingException
Specified by:
createSubcontext in interface javax.naming.Context
Parameters:
name - Parameter Description
Returns:
Returned Value Description
Throws:
javax.naming.NamingException - Exception Description

lookupLink

public java.lang.Object lookupLink(java.lang.String name)
                            throws javax.naming.NamingException
Specified by:
lookupLink in interface javax.naming.Context
Parameters:
name - Parameter Description
Returns:
Returned Value Description
Throws:
javax.naming.NamingException - Exception Description

composeName

public java.lang.String composeName(java.lang.String name,
                                    java.lang.String prefix)
                             throws javax.naming.NamingException
Specified by:
composeName in interface javax.naming.Context
Parameters:
name - Parameter Description
prefix - Parameter Description
Returns:
Returned Value Description
Throws:
javax.naming.NamingException - Exception Description

composeName

public javax.naming.Name composeName(javax.naming.Name name,
                                     javax.naming.Name prefix)
                              throws javax.naming.NamingException
Specified by:
composeName in interface javax.naming.Context
Parameters:
name - Parameter Description
prefix - Parameter Description
Returns:
Returned Value Description
Throws:
javax.naming.NamingException - Exception Description

addToEnvironment

public java.lang.Object addToEnvironment(java.lang.String name,
                                         java.lang.Object value)
                                  throws javax.naming.NamingException
Specified by:
addToEnvironment in interface javax.naming.Context
Parameters:
name - The feature to be added to the ToEnvironment attribute
value - The feature to be added to the ToEnvironment attribute
Returns:
Returned Value Description
Throws:
javax.naming.NamingException - Exception Description

removeFromEnvironment

public java.lang.Object removeFromEnvironment(java.lang.String name)
                                       throws javax.naming.NamingException
Specified by:
removeFromEnvironment in interface javax.naming.Context
Parameters:
name - Parameter Description
Returns:
Returned Value Description
Throws:
javax.naming.NamingException - Exception Description

close

public void close()
           throws javax.naming.NamingException
Closing the the context will free its resources. Use of the context after closing will have unpredictable results.
Specified by:
close in interface javax.naming.Context
Throws:
javax.naming.NamingException - Exception Description

addNamingListener

public void addNamingListener(java.lang.String target,
                              int scope,
                              javax.naming.event.NamingListener l)
                       throws javax.naming.NamingException
Specified by:
addNamingListener in interface javax.naming.event.EventContext
Parameters:
target - The feature to be added to the NamingListener attribute
scope - The feature to be added to the NamingListener attribute
l - The feature to be added to the NamingListener attribute
Throws:
javax.naming.NamingException - Exception Description

addNamingListener

public void addNamingListener(javax.naming.Name target,
                              int scope,
                              javax.naming.event.NamingListener l)
                       throws javax.naming.NamingException
Specified by:
addNamingListener in interface javax.naming.event.EventContext
Parameters:
target - The feature to be added to the NamingListener attribute
scope - The feature to be added to the NamingListener attribute
l - The feature to be added to the NamingListener attribute
Throws:
javax.naming.NamingException - Exception Description

removeNamingListener

public void removeNamingListener(javax.naming.event.NamingListener l)
                          throws javax.naming.NamingException
Specified by:
removeNamingListener in interface javax.naming.event.EventContext
Parameters:
l - Parameter Description
Throws:
javax.naming.NamingException - Exception Description

targetMustExist

public boolean targetMustExist()
                        throws javax.naming.NamingException
Specified by:
targetMustExist in interface javax.naming.event.EventContext
Returns:
Returned Value Description
Throws:
javax.naming.NamingException - Exception Description

getNameParser

protected abstract javax.naming.NameParser getNameParser()
                                                  throws javax.naming.NamingException
Returns:
The NameParser value
Throws:
javax.naming.NamingException - Exception Description

fireObjectChangeEvent

protected void fireObjectChangeEvent(javax.naming.event.NamingEvent ev)
Parameters:
ev - Parameter Description


Copyright © 2001 Resilient Edge, Inc. All Rights Reserved.