How to create JNDI context in Spring Boot with Embedded Tomcat Container

Question

import org apache catalina Context  import org apache catalina deploy ContextResource  import org apache catalina startup Tomcat  import org springframework boot autoconfigure EnableAutoConfiguration  import org springframework boot builder SpringApplicationBuilder  import org springframework boot context embedded ConfigurableEmbeddedServletContainer  import org springframework boot context embedded EmbeddedServletContainerCustomizer  import org springframework boot context embedded tomcat TomcatContextCustomizer  import org springframework boot context embedded tomcat TomcatEmbeddedServletContainer  import org springframework boot context embedded tomcat TomcatEmbeddedServletContainerFactory  import org springframework context annotation Bean  import org springframework context annotation ComponentScan  import org springframework context annotation Configuration  import org springframework context annotation ImportResource    Configuration  EnableAutoConfiguration  ComponentScan  ImportResource  classpath applicationContext xml   public class Application        public static void main String   args  throws Exception           new SpringApplicationBuilder                    showBanner false                   sources Application class                   run args       Bean public TomcatEmbeddedServletContainerFactory tomcatFactory         return new TomcatEmbeddedServletContainerFactory              Override         protected TomcatEmbeddedServletContainer getTomcatEmbeddedServletContainer                  Tomcat tomcat                tomcat enableNaming                return super getTomcatEmbeddedServletContainer tomcat                        Bean public EmbeddedServletContainerCustomizer embeddedServletContainerCustomizer         return new EmbeddedServletContainerCustomizer              Override         public void customize ConfigurableEmbeddedServletContainer container                if  container instanceof TomcatEmbeddedServletContainerFactory                    TomcatEmbeddedServletContainerFactory tomcatEmbeddedServletContainerFactory    TomcatEmbeddedServletContainerFactory  container                  tomcatEmbeddedServletContainerFactory addContextCustomizers new TomcatContextCustomizer                          Override                     public void customize Context context                            ContextResource mydatasource   new ContextResource                            mydatasource setName  jdbc mydatasource                            mydatasource setAuth  Container                            mydatasource setType  javax sql DataSource                            mydatasource setScope  Sharable                            mydatasource setProperty  driverClassName    oracle jdbc driver OracleDriver                            mydatasource setProperty  url    jdbc oracle thin  mydomain com 1522 myid                            mydatasource setProperty  username    myusername                            mydatasource setProperty  password    mypassword                             context getNamingResources   addResource mydatasource                                                                                    I m using spring boot and trying to startup with an embedded tomcat that creates a JNDI context for my datasources        lt dependency gt           lt groupId gt org springframework boot lt  groupId gt           lt artifactId gt spring-boot-starter-actuator lt  artifactId gt           lt version gt 1 1 4 RELEASE lt  version gt       lt  dependency gt       lt dependency gt           lt groupId gt org springframework boot lt  groupId gt           lt artifactId gt spring-boot-starter-tomcat lt  artifactId gt           lt version gt 1 1 4 RELEASE lt  version gt       lt  dependency gt       lt dependency gt           lt groupId gt org springframework data lt  groupId gt           lt artifactId gt spring-data-oracle lt  artifactId gt           lt version gt 1 0 0 RELEASE lt  version gt       lt  dependency gt    If I remove the  ImportResource my application starts up just fine   I can connect to the tomcat instance   I can check all of my actuator endpoints   Using JConsole  I can connect to the application I can see my datasource in the MBeans  Catalina -  Resource -  Context -      -  localhost -  javax sql DataSource -  jdbc mydatasource   I also have MBeans showing up  via JConsole  here  Tomcat -  DataSource -    -  localhost -  javax sql DataSource -  jdbc mydatasource   However  when I  ImportResource what is actually looking for mydatasource via JNDI  it s not finding it    lt bean id  myDS  class  org springframework jndi JndiObjectFactoryBean  gt       lt property name  jndiName  value  java comp env jdbc mydatasource   gt   lt  bean gt    The relevant part of my imported xml file  The ContextResource that I m configuring above is with the exact same parameters that I was using in the context xml that is getting deployed when the application is deployed to a tomcat container   My imported beans and my application are working properly when deployed to a tomcat container   So it appears that I have a context now  but it doesn t appear that the naming is right   I ve tried to various combinations of the resource name  but can t seem to generate a  comp  bound in this context   Caused by  javax naming NameNotFoundException  Name  comp env jdbc mydatasource  is not bound in this Context  Unable to find  comp       at org apache naming NamingContext lookup NamingContext java 819      at org apache naming NamingContext lookup NamingContext java 167      at org apache naming SelectorContext lookup SelectorContext java 156      at javax naming InitialContext lookup InitialContext java 392      at org springframework jndi JndiTemplate 1 doInContext JndiTemplate java 155      at org springframework jndi JndiTemplate execute JndiTemplate java 87      at org springframework jndi JndiTemplate lookup JndiTemplate java 152      at org springframework jndi JndiTemplate lookup JndiTemplate java 179      at org springframework jndi JndiLocatorSupport lookup JndiLocatorSupport java 95      at org springframework jndi JndiObjectLocator lookup JndiObjectLocator java 106      at org springframework jndi JndiObjectFactoryBean lookupWithFallback JndiObjectFactoryBean java 231      at org springframework jndi JndiObjectFactoryBean afterPropertiesSet JndiObjectFactoryBean java 217      at org springframework beans factory support AbstractAutowireCapableBeanFactory invokeInitMethods AbstractAutowireCapableBeanFactory java 1612      at org springframework beans factory support AbstractAutowireCapableBeanFactory initializeBean AbstractAutowireCapableBeanFactory java 1549          30 more

User · Answer

After all i got the answer thanks to wikisona, first the beans:

@Bean
public TomcatEmbeddedServletContainerFactory tomcatFactory() {
    return new TomcatEmbeddedServletContainerFactory() {

        @Override
        protected TomcatEmbeddedServletContainer getTomcatEmbeddedServletContainer(
                Tomcat tomcat) {
            tomcat.enableNaming();
            return super.getTomcatEmbeddedServletContainer(tomcat);
        }

        @Override
        protected void postProcessContext(Context context) {
            ContextResource resource = new ContextResource();
            resource.setName("jdbc/myDataSource");
            resource.setType(DataSource.class.getName());
            resource.setProperty("driverClassName", "your.db.Driver");
            resource.setProperty("url", "jdbc:yourDb");

            context.getNamingResources().addResource(resource);
        }
    };
}

@Bean(destroyMethod="")
public DataSource jndiDataSource() throws IllegalArgumentException, NamingException {
    JndiObjectFactoryBean bean = new JndiObjectFactoryBean();
    bean.setJndiName("java:comp/env/jdbc/myDataSource");
    bean.setProxyInterface(DataSource.class);
    bean.setLookupOnStartup(false);
    bean.afterPropertiesSet();
    return (DataSource)bean.getObject();
}

the full code it's here: https://github.com/wilkinsona/spring-boot-sample-tomcat-jndi

User · Answer

By default  JNDI is disabled in embedded Tomcat which is causing the NoInitialContextException  You need to call Tomcat enableNaming   to enable it  The easiest way to do that is with a TomcatEmbeddedServletContainer subclass    Bean public TomcatEmbeddedServletContainerFactory tomcatFactory         return new TomcatEmbeddedServletContainerFactory               Override         protected TomcatEmbeddedServletContainer getTomcatEmbeddedServletContainer                  Tomcat tomcat                tomcat enableNaming                return super getTomcatEmbeddedServletContainer tomcat                        If you take this approach  you can also register the DataSource in JNDI by overriding the postProcessContext method in your TomcatEmbeddedServletContainerFactory subclass   context getNamingResources   addResource adds the resource to the java comp env context so the resource s name should be jdbc mydatasource not java comp env mydatasource   Tomcat uses the thread context class loader to determine which JNDI context a lookup should be performed against  You re binding the resource into the web app s JNDI context so you need to ensure that the lookup is performed when the web app s class loader is the thread context class loader  You should be able to achieve this by setting lookupOnStartup to false on the jndiObjectFactoryBean  You ll also need to set expectedType to javax sql DataSource    lt bean class  org springframework jndi JndiObjectFactoryBean  gt       lt property name  jndiName  value  java comp env jdbc mydatasource   gt       lt property name  expectedType  value  javax sql DataSource   gt       lt property name  lookupOnStartup  value  false   gt   lt  bean gt    This will create a proxy for the DataSource with the actual JNDI lookup being performed on first use rather than during application context startup   The approach described above is illustrated in this Spring Boot sample

User · Answer

I recently had the requirement to use JNDI with an embedded Tomcat in Spring Boot  Actual answers give some interesting hints to solve my task but it was not enough as probably not updated for Spring Boot 2  Here is my contribution tested with Spring Boot 2 0 3 RELEASE  Specifying a datasource available in the classpath at runtime You have multiple choices    using the DBCP 2 datasource  you don t want to use DBCP 1 that is outdated and less efficient   using the Tomcat JDBC datasource  using any other datasource   for example HikariCP   If you don t specify anyone of them   with the default configuration the instantiation of the datasource will throw an exception    Caused by  javax naming NamingException  Could not create resource factory instance         at org apache naming factory ResourceFactory getDefaultFactory ResourceFactory java 50          at org apache naming factory FactoryBase getObjectInstance FactoryBase java 90          at javax naming spi NamingManager getObjectInstance NamingManager java 321          at org apache naming NamingContext lookup NamingContext java 839          at org apache naming NamingContext lookup NamingContext java 159          at org apache naming NamingContext lookup NamingContext java 827          at org apache naming NamingContext lookup NamingContext java 159          at org apache naming NamingContext lookup NamingContext java 827          at org apache naming NamingContext lookup NamingContext java 159          at org apache naming NamingContext lookup NamingContext java 827          at org apache naming NamingContext lookup NamingContext java 173          at org apache naming SelectorContext lookup SelectorContext java 163          at javax naming InitialContext lookup InitialContext java 417          at org springframework jndi JndiTemplate lambda lookup 0 JndiTemplate java 156          at org springframework jndi JndiTemplate execute JndiTemplate java 91          at org springframework jndi JndiTemplate lookup JndiTemplate java 156          at org springframework jndi JndiTemplate lookup JndiTemplate java 178          at org springframework jndi JndiLocatorSupport lookup JndiLocatorSupport java 96          at org springframework jndi JndiObjectLocator lookup JndiObjectLocator java 114          at org springframework jndi JndiObjectTargetSource getTarget JndiObjectTargetSource java 140              39 common frames omitted Caused by  java lang ClassNotFoundException  org apache tomcat dbcp dbcp2 BasicDataSourceFactory         at java net URLClassLoader findClass URLClassLoader java 381          at java lang ClassLoader loadClass ClassLoader java 424          at sun misc Launcher AppClassLoader loadClass Launcher java 331          at java lang ClassLoader loadClass ClassLoader java 357          at java lang Class forName0 Native Method          at java lang Class forName Class java 264          at org apache naming factory ResourceFactory getDefaultFactory ResourceFactory java 47              58 common frames omitted      To use Apache JDBC datasource  you don t need to add any dependency but you have to change the default factory class to  org apache tomcat jdbc pool DataSourceFactory  You can do it in the resource declaration   resource setProperty  quot factory quot    quot org apache tomcat jdbc pool DataSourceFactory quot    I will explain below where add this line   To use DBCP 2 datasource a dependency is required   lt dependency gt   lt groupId gt org apache tomcat lt  groupId gt   lt artifactId gt tomcat-dbcp lt  artifactId gt   lt version gt 8 5 4 lt  version gt   lt  dependency gt    Of course  adapt the artifact version according to your Spring Boot Tomcat embedded version   To use HikariCP  add the required dependency if not already present in your configuration  it may be if you rely on persistence starters of Spring Boot  such as    lt dependency gt   lt groupId gt com zaxxer lt  groupId gt   lt artifactId gt HikariCP lt  artifactId gt   lt version gt 3 1 0 lt  version gt   lt  dependency gt    and specify the factory that goes with in the resource declaration  resource setProperty  quot factory quot    quot com zaxxer hikari HikariJNDIFactory quot      Datasource configuration declaration You have to customize the bean that creates the TomcatServletWebServerFactory instance  Two things to do    enabling the JNDI naming which is disabled by default  creating and add the JNDI resource s  in the server context   For example with PostgreSQL and a DBCP 2 datasource  do that    Bean public TomcatServletWebServerFactory tomcatFactory         return new TomcatServletWebServerFactory              Override         protected TomcatWebServer getTomcatWebServer org apache catalina startup Tomcat tomcat                tomcat enableNaming                 return super getTomcatWebServer tomcat                       Override          protected void postProcessContext Context context                    context             ContextResource resource   new ContextResource                resource setName  quot jdbc myJndiResource quot                resource setType DataSource class getName                 resource setProperty  quot driverClassName quot    quot org postgresql Driver quot                 resource setProperty  quot url quot    quot jdbc postgresql   hostname port dbname quot                resource setProperty  quot username quot    quot username quot                resource setProperty  quot password quot    quot password quot                context getNamingResources                       addResource resource                                 Here the variants for Tomcat JDBC and HikariCP datasource  In postProcessContext   set the factory property as explained early for Tomcat JDBC ds        Override      protected void postProcessContext Context context            ContextResource resource   new ContextResource                                 resource setProperty  quot factory quot    quot org apache tomcat jdbc pool DataSourceFactory quot                          context getNamingResources                   addResource resource                       and for HikariCP        Override      protected void postProcessContext Context context            ContextResource resource   new ContextResource                                 resource setProperty  quot factory quot    quot com zaxxer hikari HikariDataSource quot                          context getNamingResources                   addResource resource                        Using Injecting the datasource You should now be able to lookup the JNDI ressource anywhere by using a standard InitialContext instance   InitialContext initialContext   new InitialContext    DataSource datasource    DataSource  initialContext lookup  quot java comp env jdbc myJndiResource quot     You can also use JndiObjectFactoryBean of Spring to lookup up the resource   JndiObjectFactoryBean bean   new JndiObjectFactoryBean    bean setJndiName  quot java comp env jdbc myJndiResource quot    bean afterPropertiesSet    DataSource object    DataSource  bean getObject     To take advantage of the DI container you can also make the DataSource a Spring bean    Bean destroyMethod    quot  quot   public DataSource jndiDataSource   throws IllegalArgumentException  NamingException       JndiObjectFactoryBean bean   new JndiObjectFactoryBean        bean setJndiName  quot java comp env jdbc myJndiResource quot        bean afterPropertiesSet        return  DataSource  bean getObject       And so you can now inject the DataSource in any Spring beans such as    Autowired private DataSource jndiDataSource   Note that many examples on the internet seem to disable the lookup of the JNDI resource on startup   bean setJndiName  quot java comp env jdbc myJndiResource quot    bean setProxyInterface DataSource class   bean setLookupOnStartup false   bean afterPropertiesSet      But I think that it is helpless as it invokes just after afterPropertiesSet   that does the lookup

User · Answer

Please note instead of   public TomcatEmbeddedServletContainerFactory tomcatFactory     I had to use the following method signature  public EmbeddedServletContainerFactory embeddedServletContainerFactory

User · Answer

Have you tried  Lazy loading the datasource  Because you re initialising your embedded Tomcat container within the Spring context  you have to delay the initialisation of your DataSource  until the JNDI vars have been setup    N B  I haven t had a chance to test this code yet    Lazy  Bean destroyMethod     public DataSource jndiDataSource   throws IllegalArgumentException  NamingException       JndiObjectFactoryBean bean   new JndiObjectFactoryBean        bean setJndiName  java comp env jdbc myDataSource        bean setProxyInterface DataSource class         bean setLookupOnStartup false       bean afterPropertiesSet        return  DataSource bean getObject        You may also need to add the  Lazy annotation wherever the DataSource is being used  e g    Lazy  Autowired private DataSource dataSource

User · Answer

In SpringBoot 2 1  I found another solution  Extend standard factory class method getTomcatWebServer  And then return it as a bean from anywhere  public class CustomTomcatServletWebServerFactory extends TomcatServletWebServerFactory         Override     protected TomcatWebServer getTomcatWebServer Tomcat tomcat            System setProperty  quot catalina useNaming quot    quot true quot            tomcat enableNaming            return new TomcatWebServer tomcat  getPort    gt   0             Component public class TomcatConfiguration        Bean     public ConfigurableServletWebServerFactory webServerFactory             TomcatServletWebServerFactory factory   new CustomTomcatServletWebServerFactory             return factory         Loading resources from context xml doesn t work though  Will try to find out

[jndi] How to create JNDI context in Spring Boot with Embedded Tomcat Container

Examples related to jndi

Examples related to spring-boot

Examples related to embedded-tomcat-7