Spring Boot Embedded Tomcat 'allowLinking' property

Question

I have been looking for a way to expose the property 'allowLinking' to allow an TomcatEmbeddedServletContainerFactory to follow symlinks to resources that are under its documentRoot.

According to the Tomcat 8 Migration docs this functionality switched to the 'Resources' tag for Tomcat 8+ : Tomcat 8 Migration Guide

<!-- Tomcat 7: -->
<Context allowLinking="true" />

<!-- Tomcat 8: -->
<Context>
  <Resources allowLinking="true" />
</Context>

How would one expose this property while configuring the TomcatEmbeddedServletContainerFactory programmatically for a Spring Boot application?

score 2 · Answer 1 · answered Mar 09 '17 at 22:34

I had exactly the same issue, and was able to implement the following to resolve this:

@Bean
public EmbeddedServletContainerFactory servletContainer() 
{
    TomcatEmbeddedServletContainerFactory tomcat = new TomcatEmbeddedServletContainerFactory();
    // allow symbolic links under the filesystem context
    // don't use this on Windows!
    if (IOCase.SYSTEM.isCaseSensitive())
    {
        Log.info("Enabling support for symbolic links on the webserver.");
        for (TomcatContextCustomizer customizer : tomcat.getTomcatContextCustomizers())
        {
            StandardContext context = new StandardContext();
            context.setAllowLinking(true);
            customizer.customize(context);
        }
    }
    return tomcat;
}

score 1 · Answer 2 · answered Aug 14 '17 at 10:05

thks Erik Brandsberg, Modify the code, in Tomcat 8 to solve this problem

@Bean
public EmbeddedServletContainerFactory servletContainer()
{
    TomcatEmbeddedServletContainerFactory tomcat = new TomcatEmbeddedServletContainerFactory();
    // allow symbolic links under the filesystem context
    // don't use this on Windows!
    if (IOCase.SYSTEM.isCaseSensitive())
    {
        TomcatContextCustomizer customizer = new TomcatContextCustomizer() {
            @Override
            public void customize(Context context) {
                StandardRoot r = new StandardRoot();
                r.setAllowLinking(true);
                context.setResources(r);
            }
        };
        tomcat.addContextCustomizers(customizer);

    }
    return tomcat;
}

Spring Boot Embedded Tomcat 'allowLinking' property

2 Answers2