Java Doc for JndiObjectFactoryBean.java in  » J2EE » spring-framework-2.0.6 » org » springframework » jndi » 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 » J2EE » spring framework 2.0.6 » org.springframework.jndi 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.springframework.jndi.JndiAccessor
      org.springframework.jndi.JndiLocatorSupport
         org.springframework.jndi.JndiObjectLocator
            org.springframework.jndi.JndiObjectFactoryBean

JndiObjectFactoryBean
public class JndiObjectFactoryBean extends JndiObjectLocator implements FactoryBean,BeanClassLoaderAware(Code)
org.springframework.beans.factory.FactoryBean that looks up a JNDI object. Exposes the object found in JNDI for bean references, e.g. for data access object's "dataSource" property in case of a javax.sql.DataSource .

The typical usage will be to register this as singleton factory (e.g. for a certain JNDI-bound DataSource) in an application context, and give bean references to application services that need it.

The default behavior is to look up the JNDI object on startup and cache it. This can be customized through the "lookupOnStartup" and "cache" properties, using a JndiObjectTargetSource underneath. Note that you need to specify a "proxyInterface" in such a scenario, since the actual JNDI object type is not known in advance.

Of course, bean classes in a Spring environment may lookup e.g. a DataSource from JNDI themselves. This class simply enables central configuration of the JNDI name, and easy switching to non-JNDI alternatives. The latter is particularly convenient for test setups, reuse in standalone clients, etc.

Note that switching to e.g. DriverManagerDataSource is just a matter of configuration: Simply replace the definition of this FactoryBean with a org.springframework.jdbc.datasource.DriverManagerDataSource definition!
author:
   Juergen Hoeller
since:
   22.05.2003
See Also:   JndiObjectFactoryBean.setProxyInterface
See Also:   JndiObjectFactoryBean.setLookupOnStartup
See Also:   JndiObjectFactoryBean.setCache
See Also:   JndiObjectTargetSource





Method Summary
public  voidafterPropertiesSet()
     Look up the JNDI object and store it.
protected  ClasscreateCompositeInterface(Class[] interfaces)
     Create a composite interface Class for the given interfaces, implementing the given interfaces in one single Class.
public  ObjectgetObject()
     Return the singleton JNDI object.
public  ClassgetObjectType()
    
public  booleanisSingleton()
    
protected  ObjectlookupWithFallback()
     Lookup variant that that returns the specified "defaultObject" (if any) in case of lookup failure.
public  voidsetBeanClassLoader(ClassLoader classLoader)
    
public  voidsetCache(boolean cache)
     Set whether to cache the JNDI object once it has been located.
public  voidsetDefaultObject(Object defaultObject)
     Specify a default object to fall back to if the JNDI lookup fails.
public  voidsetLookupOnStartup(boolean lookupOnStartup)
     Set whether to look up the JNDI object on startup.
public  voidsetProxyInterface(Class proxyInterface)
     Specify the proxy interface to use for the JNDI object.
public  voidsetProxyInterfaces(Class[] proxyInterfaces)
     Specify multiple proxy interfaces to use for the JNDI object.



Method Detail
afterPropertiesSet
public void afterPropertiesSet() throws IllegalArgumentException, NamingException(Code)
Look up the JNDI object and store it.



createCompositeInterface
protected Class createCompositeInterface(Class[] interfaces)(Code)
Create a composite interface Class for the given interfaces, implementing the given interfaces in one single Class.

The default implementation builds a JDK proxy class for the given interfaces.
Parameters:
  interfaces - the interfaces to merge the merged interface as Class
See Also:   java.lang.reflect.Proxy.getProxyClass




getObject
public Object getObject()(Code)
Return the singleton JNDI object.



getObjectType
public Class getObjectType()(Code)



isSingleton
public boolean isSingleton()(Code)



lookupWithFallback
protected Object lookupWithFallback() throws NamingException(Code)
Lookup variant that that returns the specified "defaultObject" (if any) in case of lookup failure. the located object, or the "defaultObject" as fallback
throws:
  NamingException - in case of lookup failure without fallback
See Also:   JndiObjectFactoryBean.setDefaultObject



setBeanClassLoader
public void setBeanClassLoader(ClassLoader classLoader)(Code)



setCache
public void setCache(boolean cache)(Code)
Set whether to cache the JNDI object once it has been located. Default is "true".

Can be turned off to allow for hot redeployment of JNDI objects. In this case, the JNDI object will be fetched for each invocation.

For hot redeployment, a proxy interface needs to be specified.
See Also:   JndiObjectFactoryBean.setProxyInterface
See Also:   JndiObjectFactoryBean.setLookupOnStartup




setDefaultObject
public void setDefaultObject(Object defaultObject)(Code)
Specify a default object to fall back to if the JNDI lookup fails. Default is none.

This can be an arbitrary bean reference or literal value. It is typically used for literal values in scenarios where the JNDI environment might define specific config settings but those are not required to be present.

Note: This is only supported for lookup on startup.
See Also:   JndiObjectFactoryBean.setLookupOnStartup




setLookupOnStartup
public void setLookupOnStartup(boolean lookupOnStartup)(Code)
Set whether to look up the JNDI object on startup. Default is "true".

Can be turned off to allow for late availability of the JNDI object. In this case, the JNDI object will be fetched on first access.

For a lazy lookup, a proxy interface needs to be specified.
See Also:   JndiObjectFactoryBean.setProxyInterface
See Also:   JndiObjectFactoryBean.setCache




setProxyInterface
public void setProxyInterface(Class proxyInterface)(Code)
Specify the proxy interface to use for the JNDI object.

Typically used in conjunction with "lookupOnStartup"=false and/or "cache"=false. Needs to be specified because the actual JNDI object type is not known in advance in case of a lazy lookup.
See Also:   JndiObjectFactoryBean.setProxyInterfaces
See Also:   JndiObjectFactoryBean.setLookupOnStartup
See Also:   JndiObjectFactoryBean.setCache




setProxyInterfaces
public void setProxyInterfaces(Class[] proxyInterfaces)(Code)
Specify multiple proxy interfaces to use for the JNDI object.

Typically used in conjunction with "lookupOnStartup"=false and/or "cache"=false. Note that proxy interfaces will be autodetected from a specified "expectedType", if necessary.
See Also:   JndiObjectFactoryBean.setExpectedType
See Also:   JndiObjectFactoryBean.setLookupOnStartup
See Also:   JndiObjectFactoryBean.setCache




Methods inherited from org.springframework.jndi.JndiObjectLocator
public void afterPropertiesSet() throws IllegalArgumentException, NamingException(Code)(Java Doc)
public Class getExpectedType()(Code)(Java Doc)
public String getJndiName()(Code)(Java Doc)
protected Object lookup() throws NamingException(Code)(Java Doc)
public void setExpectedType(Class expectedType)(Code)(Java Doc)
public void setJndiName(String jndiName)(Code)(Java Doc)

Fields inherited from org.springframework.jndi.JndiLocatorSupport
final public static String CONTAINER_PREFIX(Code)(Java Doc)

Methods inherited from org.springframework.jndi.JndiLocatorSupport
protected String convertJndiName(String jndiName)(Code)(Java Doc)
public boolean isResourceRef()(Code)(Java Doc)
protected Object lookup(String jndiName) throws NamingException(Code)(Java Doc)
protected Object lookup(String jndiName, Class requiredType) throws NamingException(Code)(Java Doc)
public void setResourceRef(boolean resourceRef)(Code)(Java Doc)

Fields inherited from org.springframework.jndi.JndiAccessor
final protected Log logger(Code)(Java Doc)

Methods inherited from org.springframework.jndi.JndiAccessor
public Properties getJndiEnvironment()(Code)(Java Doc)
public JndiTemplate getJndiTemplate()(Code)(Java Doc)
public void setJndiEnvironment(Properties jndiEnvironment)(Code)(Java Doc)
public void setJndiTemplate(JndiTemplate jndiTemplate)(Code)(Java Doc)

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.