Java Doc for NamingContext.java in  » Web-Server » Rimfaxe-Web-Server » org » apache » naming » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Web Server » Rimfaxe Web Server » org.apache.naming 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.naming.NamingContext

NamingContext
public class NamingContext implements Context(Code)
Catalina JNDI Context implementation.
author:
   Remy Maucherat
version:
   $Revision: 1.8 $ $Date: 2001/11/08 21:02:04 $


Field Summary
protected  Hashtablebindings
     Bindings in this Context.
protected  Hashtableenv
     Environment.
protected  Stringname
     Name of the associated Catalina Context.
final protected static  NameParsernameParser
     Name parser for this context.
protected  StringManagersm
     The string manager for this package.

Constructor Summary
public  NamingContext(Hashtable env, String name)
     Builds a naming context using the given environment.
public  NamingContext(Hashtable env, String name, Hashtable bindings)
     Builds a naming context using the given environment.

Method Summary
public  ObjectaddToEnvironment(String propName, Object propVal)
     Adds a new environment property to the environment of this context.
public  voidbind(Name name, Object obj)
     Binds a name to an object.
public  voidbind(String name, Object obj)
     Binds a name to an object.
protected  voidbind(Name name, Object obj, boolean rebind)
     Binds a name to an object.
protected  voidcheckWritable()
     Throws a naming exception is Context is not writable.
public  voidclose()
     Closes this context.
public  NamecomposeName(Name name, Name prefix)
     Composes the name of this context with a name relative to this context.

Given a name (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.

public  StringcomposeName(String name, String prefix)
     Composes the name of this context with a name relative to this context.
public  ContextcreateSubcontext(Name name)
     Creates and binds a new context.
public  ContextcreateSubcontext(String name)
     Creates and binds a new context.
public  voiddestroySubcontext(Name name)
     Destroys the named context and removes it from the namespace.
public  voiddestroySubcontext(String name)
     Destroys the named context and removes it from the namespace.
public  HashtablegetEnvironment()
     Retrieves the environment in effect for this context.
public  StringgetNameInNamespace()
     Retrieves the full name of this context within its own namespace.

Many naming services have a notion of a "full name" for objects in their respective namespaces.

public  NameParsergetNameParser(Name name)
     Retrieves the parser associated with the named context.
public  NameParsergetNameParser(String name)
     Retrieves the parser associated with the named context.
protected  booleanisWritable()
     Returns true if writing is allowed on this context.
public  NamingEnumerationlist(Name name)
     Enumerates the names bound in the named context, along with the class names of objects bound to them.
public  NamingEnumerationlist(String name)
     Enumerates the names bound in the named context, along with the class names of objects bound to them.
Parameters:
  name - the name of the context to list an enumeration of the names and class names of the bindings in this context.
public  NamingEnumerationlistBindings(Name name)
     Enumerates the names bound in the named context, along with the objects bound to them.
public  NamingEnumerationlistBindings(String name)
     Enumerates the names bound in the named context, along with the objects bound to them.
Parameters:
  name - the name of the context to list an enumeration of the bindings in this context.
public  Objectlookup(Name name)
     Retrieves the named object.
public  Objectlookup(String name)
     Retrieves the named object.
protected  Objectlookup(Name name, boolean resolveLinks)
     Retrieves the named object.
public  ObjectlookupLink(Name name)
     Retrieves the named object, following links except for the terminal atomic component of the name.
public  ObjectlookupLink(String name)
     Retrieves the named object, following links except for the terminal atomic component of the name.
public  voidrebind(Name name, Object obj)
     Binds a name to an object, overwriting any existing binding.
public  voidrebind(String name, Object obj)
     Binds a name to an object, overwriting any existing binding.
public  ObjectremoveFromEnvironment(String propName)
     Removes an environment property from the environment of this context.
public  voidrename(Name oldName, Name newName)
     Binds a new name to the object bound to an old name, and unbinds the old name.
public  voidrename(String oldName, String newName)
     Binds a new name to the object bound to an old name, and unbinds the old name.
public  voidunbind(Name name)
     Unbinds the named object.
public  voidunbind(String name)
     Unbinds the named object.

Field Detail
bindings
protected Hashtable bindings(Code)
Bindings in this Context.



env
protected Hashtable env(Code)
Environment.



name
protected String name(Code)
Name of the associated Catalina Context.



nameParser
final protected static NameParser nameParser(Code)
Name parser for this context.



sm
protected StringManager sm(Code)
The string manager for this package.




Constructor Detail
NamingContext
public NamingContext(Hashtable env, String name) throws NamingException(Code)
Builds a naming context using the given environment.



NamingContext
public NamingContext(Hashtable env, String name, Hashtable bindings) throws NamingException(Code)
Builds a naming context using the given environment.




Method Detail
addToEnvironment
public Object addToEnvironment(String propName, Object propVal) throws NamingException(Code)
Adds a new environment property to the environment of this context. If the property already exists, its value is overwritten.
Parameters:
  propName - the name of the environment property to add; may not be null
Parameters:
  propVal - the value of the property to add; may not be null
exception:
  NamingException - if a naming exception is encountered



bind
public void bind(Name name, Object obj) throws NamingException(Code)
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.
Parameters:
  name - the name to bind; may not be empty
Parameters:
  obj - the object to bind; possibly null
exception:
  NameAlreadyBoundException - if name is already bound
exception:
  InvalidAttributesException - if object did not supply all mandatory attributes
exception:
  NamingException - if a naming exception is encountered



bind
public void bind(String name, Object obj) throws NamingException(Code)
Binds a name to an object.
Parameters:
  name - the name to bind; may not be empty
Parameters:
  obj - the object to bind; possibly null
exception:
  NameAlreadyBoundException - if name is already bound
exception:
  InvalidAttributesException - if object did not supply all mandatory attributes
exception:
  NamingException - if a naming exception is encountered



bind
protected void bind(Name name, Object obj, boolean rebind) throws NamingException(Code)
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.
Parameters:
  name - the name to bind; may not be empty
Parameters:
  object - the object to bind; possibly null
Parameters:
  rebind - if true, then perform a rebind (ie, overwrite)
exception:
  NameAlreadyBoundException - if name is already bound
exception:
  InvalidAttributesException - if object did not supply all mandatory attributes
exception:
  NamingException - if a naming exception is encountered



checkWritable
protected void checkWritable() throws NamingException(Code)
Throws a naming exception is Context is not writable.



close
public void close() throws NamingException(Code)
Closes this context. This method releases this context's resources immediately, instead of waiting for them to be released automatically by the garbage collector. 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.
exception:
  NamingException - if a naming exception is encountered



composeName
public Name composeName(Name name, Name prefix) throws NamingException(Code)
Composes the name of this context with a name relative to this context.

Given a name (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.
Parameters:
  name - a name relative to this context
Parameters:
  prefix - the name of this context relative to one of its ancestors the composition of prefix and name
exception:
  NamingException - if a naming exception is encountered




composeName
public String composeName(String name, String prefix) throws NamingException(Code)
Composes the name of this context with a name relative to this context.
Parameters:
  name - a name relative to this context
Parameters:
  prefix - the name of this context relative to one of its ancestors the composition of prefix and name
exception:
  NamingException - if a naming exception is encountered



createSubcontext
public Context createSubcontext(Name name) throws NamingException(Code)
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.
Parameters:
  name - the name of the context to create; may not be empty the newly created context
exception:
  NameAlreadyBoundException - if name is already bound
exception:
  InvalidAttributesException - if creation of the subcontext requires specification of mandatory attributes
exception:
  NamingException - if a naming exception is encountered



createSubcontext
public Context createSubcontext(String name) throws NamingException(Code)
Creates and binds a new context.
Parameters:
  name - the name of the context to create; may not be empty the newly created context
exception:
  NameAlreadyBoundException - if name is already bound
exception:
  InvalidAttributesException - if creation of the subcontext requires specification of mandatory attributes
exception:
  NamingException - if a naming exception is encountered



destroySubcontext
public void destroySubcontext(Name name) throws NamingException(Code)
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.
Parameters:
  name - the name of the context to be destroyed; may not be empty
exception:
  NameNotFoundException - if an intermediate context does not exist
exception:
  NotContextException - if the name is bound but does not name a context, or does not name a context of the appropriate type




destroySubcontext
public void destroySubcontext(String name) throws NamingException(Code)
Destroys the named context and removes it from the namespace.
Parameters:
  name - the name of the context to be destroyed; may not be empty
exception:
  NameNotFoundException - if an intermediate context does not exist
exception:
  NotContextException - if the name is bound but does not name a context, or does not name a context of the appropriate type



getEnvironment
public Hashtable getEnvironment() throws NamingException(Code)
Retrieves the environment in effect for this context. See class description for more details on environment properties. 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(). the environment of this context; never null
exception:
  NamingException - if a naming exception is encountered



getNameInNamespace
public String getNameInNamespace() throws NamingException(Code)
Retrieves the full name of this context within its own namespace.

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. this context's name in its own namespace; never null
exception:
  OperationNotSupportedException - if the naming system does not have the notion of a full name
exception:
  NamingException - if a naming exception is encountered




getNameParser
public NameParser getNameParser(Name name) throws NamingException(Code)
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).
Parameters:
  name - the name of the context from which to get the parser a name parser that can parse compound names into their atomic components
exception:
  NamingException - if a naming exception is encountered



getNameParser
public NameParser getNameParser(String name) throws NamingException(Code)
Retrieves the parser associated with the named context.
Parameters:
  name - the name of the context from which to get the parser a name parser that can parse compound names into their atomic components
exception:
  NamingException - if a naming exception is encountered



isWritable
protected boolean isWritable()(Code)
Returns true if writing is allowed on this context.



list
public NamingEnumeration list(Name name) throws NamingException(Code)
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.
Parameters:
  name - the name of the context to list an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.
exception:
  NamingException - if a naming exception is encountered




list
public NamingEnumeration list(String name) throws NamingException(Code)
Enumerates the names bound in the named context, along with the class names of objects bound to them.
Parameters:
  name - the name of the context to list an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.
exception:
  NamingException - if a naming exception is encountered



listBindings
public NamingEnumeration listBindings(Name name) throws NamingException(Code)
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.
Parameters:
  name - the name of the context to list an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.
exception:
  NamingException - if a naming exception is encountered




listBindings
public NamingEnumeration listBindings(String name) throws NamingException(Code)
Enumerates the names bound in the named context, along with the objects bound to them.
Parameters:
  name - the name of the context to list an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.
exception:
  NamingException - if a naming exception is encountered



lookup
public Object lookup(Name name) throws NamingException(Code)
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).
Parameters:
  name - the name of the object to look up the object bound to name
exception:
  NamingException - if a naming exception is encountered



lookup
public Object lookup(String name) throws NamingException(Code)
Retrieves the named object.
Parameters:
  name - the name of the object to look up the object bound to name
exception:
  NamingException - if a naming exception is encountered



lookup
protected Object lookup(Name name, boolean resolveLinks) throws NamingException(Code)
Retrieves the named object.
Parameters:
  name - the name of the object to look up
Parameters:
  resolveLinks - If true, the links will be resolved the object bound to name
exception:
  NamingException - if a naming exception is encountered



lookupLink
public Object lookupLink(Name name) throws NamingException(Code)
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.
Parameters:
  name - the name of the object to look up the object bound to name, not following the terminal link (if any).
exception:
  NamingException - if a naming exception is encountered



lookupLink
public Object lookupLink(String name) throws NamingException(Code)
Retrieves the named object, following links except for the terminal atomic component of the name.
Parameters:
  name - the name of the object to look up the object bound to name, not following the terminal link (if any).
exception:
  NamingException - if a naming exception is encountered



rebind
public void rebind(Name name, Object obj) throws NamingException(Code)
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.
Parameters:
  name - the name to bind; may not be empty
Parameters:
  obj - the object to bind; possibly null
exception:
  InvalidAttributesException - if object did not supply all mandatory attributes
exception:
  NamingException - if a naming exception is encountered




rebind
public void rebind(String name, Object obj) throws NamingException(Code)
Binds a name to an object, overwriting any existing binding.
Parameters:
  name - the name to bind; may not be empty
Parameters:
  obj - the object to bind; possibly null
exception:
  InvalidAttributesException - if object did not supply all mandatory attributes
exception:
  NamingException - if a naming exception is encountered



removeFromEnvironment
public Object removeFromEnvironment(String propName) throws NamingException(Code)
Removes an environment property from the environment of this context.
Parameters:
  propName - the name of the environment property to remove; may not be null
exception:
  NamingException - if a naming exception is encountered



rename
public void rename(Name oldName, Name newName) throws NamingException(Code)
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.
Parameters:
  oldName - the name of the existing binding; may not be empty
Parameters:
  newName - the name of the new binding; may not be empty
exception:
  NameAlreadyBoundException - if newName is already bound
exception:
  NamingException - if a naming exception is encountered



rename
public void rename(String oldName, String newName) throws NamingException(Code)
Binds a new name to the object bound to an old name, and unbinds the old name.
Parameters:
  oldName - the name of the existing binding; may not be empty
Parameters:
  newName - the name of the new binding; may not be empty
exception:
  NameAlreadyBoundException - if newName is already bound
exception:
  NamingException - if a naming exception is encountered



unbind
public void unbind(Name name) throws NamingException(Code)
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.
Parameters:
  name - the name to bind; may not be empty
exception:
  NameNotFoundException - if an intermediate context does not exist
exception:
  NamingException - if a naming exception is encountered




unbind
public void unbind(String name) throws NamingException(Code)
Unbinds the named object.
Parameters:
  name - the name to bind; may not be empty
exception:
  NameNotFoundException - if an intermediate context does not exist
exception:
  NamingException - if a naming exception is encountered



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.