Support for multiple Tomcat Connectors

[stringy05]

TomcatEmbeddedServletContainerFactory creates a single Connector which can be altered using a TomcatConnectorCustomizer, however there is no mechanism to add additional Connectors (ie for SSL or AJP in addition to HTTP).

The addConnectorCustomizers method allows you to add a list of customisers for the connector that gets created by getEmbeddedServletEngine, however if you provide a list it looks like they just overwrite the existing connector config so the last customizer in the list wins. This is a bit confusing, especially if you are just looking at the API as you think you can add more connectors but you cant :(

I propose a fix that

• deprecates the addConnectorCustomizers(TomcatConnectorCustomizer... ) method
• creates a new addConnectorCustomizer(TomcatConnectorCustomizer ) method
• add a new addAdditionalConnectors(Connectors... ) method which appends to a list of connectors that get added in addition to the default connector.

Thanks

Brock

[philwebb]

Perhaps I am missing something, but it looks to me like addConnectorCustomizers already appends to the list and doesn't replace it.

https://github.com/spring-projects/spring-boot/blob/v1.0.0.RC4/spring-boot/src/main/java/org/springframework/boot/context/embedded/tomcat/TomcatEmbeddedServletContainerFactory.java#L421

Can you clarify?

[stringy05]

Sure. addConnectorCustomizers appends to the list of connectors but the problem is that each customiser just changes the single connector that gets created in the getEmbeddedServlet method

 @Override
public EmbeddedServletContainer getEmbeddedServletContainer(ServletContextInitializer... initializers) {
  Tomcat tomcat = new Tomcat();
  File baseDir = (this.baseDirectory != null ? this.baseDirectory : createTempDir("tomcat"));
  tomcat.setBaseDir(baseDir.getAbsolutePath());
- Connector connector = new Connector(this.protocol);*
  tomcat.getService().addConnector(connector);
  customizeConnector(connector);
  tomcat.setConnector(connector);

so if I create 2 TomcatConnectorCustomizers, say one listening on 8443 for ssl and 8081 for AJP I think I'm going to get 3 connectors - 8080/HTTP, 8443/SSL, 8081/AJP- but I only end up with 1 (eg 8081/AJP, if that's the last customiser in the list).

I've added the addAdditionalConnectors method and changed the getEmbeddedServletContainer method to do this:

public EmbeddedServletContainer getEmbeddedServletContainer(ServletContextInitializer... initializers) {
  Tomcat tomcat = new Tomcat();
  File baseDir = (this.baseDirectory != null ? this.baseDirectory : createTempDir("tomcat"));
  tomcat.setBaseDir(baseDir.getAbsolutePath());
  Connector connector = new Connector(this.protocol);
  tomcat.getService().addConnector(connector);
  customizeConnector(connector);
  tomcat.setConnector(connector);
  tomcat.getHost().setAutoDeploy(false);
  tomcat.getEngine().setBackgroundProcessorDelay(-1);
- // add additional connectors*
  -  for (Connector additionalConnector : this.additionalTomcatConnectors)
    {    tomcat.getService().addConnector(additionalConnector);  }*

So now we get multiple connectors and I can run my embedded tomcat with SSL and HTTP. I've got this working locally

I can create a push request, I just need to work out how the integration tests work

Spring Boot is an ace project by the way.

Cheers
Brock

[philwebb]

I see, thanks. I'm not sure that the changing addConnectorCustomizers is necessary, it's possible that you might have more than one customizer, each changing different parts of the Connector.

It does seem like adding support for additional Connectors would be useful though.

[dsyer]

See #535 for pull request. BTW you can specify the issue that a pull request targets when you submit it (then there aren't two issues for the same thing in the tracker).