Vijayant Bhatia
Vijayant Bhatia

Reputation: 2525

ApplicationContextException: Unable to start ServletWebServerApplicationContext due to missing ServletWebServerFactory bean

I have written a spring batch application using Spring boot. When I am trying to run that application using command line and classpath on my local system it is running fine. However, when I tried to run it on linux server it is giving me following exception

Unable to start web server; nested exception is
org.springframework.context.ApplicationContextException: 
Unable to start ServletWebServerApplicationContext due to missing ServletWebServerFactory bean.

Below is the way I am running it:

java -cp jarFileName.jar; lib\* -Dlogging.level.org.springframework=DEBUG -Dspring.profiles.active=dev -Dspring.batch.job.names=abcBatchJob com.aa.bb.StartSpringBatch > somelogs.log

Upvotes: 198

Views: 499808

Answers (30)

Ukpa Uchechi
Ukpa Uchechi

Reputation: 730

Another issue could be that the name of the class is different from that in the SpringApplication.run() argument, this was the case for me.

public class Chat {
    public static void main(String[] args) {
        SpringApplication.run(WebSocketConfig.class, args);
    }
}   

Upvotes: 0

Vikash Kumar
Vikash Kumar

Reputation: 1206

Sometimes Intellij Behaves crazy , So If you are not able to run through Intellij, Try running project directly from command prompt.

mvn spring-boot:run

Upvotes: 2

GolamMazid Sajib
GolamMazid Sajib

Reputation: 9437

Case 1:

@SpringBootApplication annotation missing in your spring boot starter class.

Case 2:

For non-web applications, disable web application type in the properties file.

In application.properties:

spring.main.web-application-type=none

If you use application.yml then add:

  spring:
    main:
      web-application-type: none

For web applications, extends *SpringBootServletInitializer* in the main class.

@SpringBootApplication
public class YourAppliationName extends SpringBootServletInitializer{
    public static void main(String[] args) {
        SpringApplication.run(YourAppliationName.class, args);
    }
}

Case 3:

If you use spring-boot-starter-webflux then also add spring-boot-starter-web as dependency.

Case 4:

if you use netty then use below properties:

spring.main.web-application-type=reactive

or yml:

spring:
    main:
      web-application-type: reactive

Upvotes: 302

Shtefan
Shtefan

Reputation: 808

You just need to autowire any implementation of ServletWebServerFactory interface. For example as already suggested by @Kapil it can be TomcatServletWebServerFactory or any other ones available in your app. Other possible option would be JettyServletWebServerFactory.

@Bean
public ServletWebServerFactory servletWebServerFactory() {
    return new JettyServletWebServerFactory();
}

Upvotes: 0

VincentH
VincentH

Reputation: 383

In my case, even though I had @SpringBootApplication in my main class... for some strange reason, the annotation was missing in the corresponding class in the 'target' folder. I wasted hours looking into it.

Running a Maven clean and rebuilding the app fixed the issue and the @SpringBootApplication annotation magically appeared in the corresponding main class in the target folder.

All working now, but very strange this happened in the first place.

Upvotes: 0

Tomas Šatas
Tomas Šatas

Reputation: 131

in my case it was annotation @SpringBootApplication missing in main

Upvotes: 3

badger
badger

Reputation: 3246

I had the same problem, root cause was:

<dependency>
  <groupId>org.mock-server</groupId>
  <artifactId>mockserver-netty</artifactId>
  <version>5.15.0</version>
</dependency>
<dependency>
  <groupId>org.mock-server</groupId>
  <artifactId>mockserver-client-java</artifactId>
  <version>5.15.0</version>
</dependency>

I have to define their scope as test, like <scope>test</scope>

Upvotes: 0

Jasper Vandaele
Jasper Vandaele

Reputation: 71

In my case, the gretty plugin (3.0.6) was still active. Gretty somehow influences the embedded tomcat dependency. Removing gretty fixed the error

Upvotes: 0

arviarya
arviarya

Reputation: 660

To convert an Spring boot wen application to standalone:

  1. Either configure application.properties:
spring.main.web-application-type=none
  1. Or Update application context with NONE web context.
ApplicationContext ctx = new SpringApplicationBuilder(MigrationRunner.class)
                .web(WebApplicationType.NONE).run(args);

Using application context, you can get your beans:

myBean bean = (MyBean) ctx.getBean("myBean", MyBean.class); bean.call_a_method(..);

Upvotes: 6

SMilos
SMilos

Reputation: 491

Missing dependency could be cause of this issue

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
</dependency>

Upvotes: 2

Arjun Gautam
Arjun Gautam

Reputation: 329

I was getting same error while using tomcat-jasper newer version

<dependency>
    <groupId>org.apache.tomcat</groupId>
    <artifactId>tomcat-jasper</artifactId>
    <version>10.0.6</version>
</dependency>

I replaced with the stable older version it worked fine for me.

<dependency>
    <groupId>org.apache.tomcat</groupId>
    <artifactId>tomcat-jasper</artifactId>
    <version>9.0.46</version>
</dependency>

Upvotes: 3

MonishGhutke
MonishGhutke

Reputation: 139

I wanted to run the WAR type spring boot application, and when I was trying to run the app as spring boot application I was getting above error. So declaring the web application type in application.properties has worked for me. spring.main.web-application-type=none

Possible web application type:

  1. NONE - the application should not run as a web application and should not start an embedded web server.
  2. REACTIVE - the application should run as a reactive web application and should start an embedded reactive web server.
  3. SERVLET - the application should run as a servlet-based web application and should start an embedded servlet web server.

Upvotes: 2

Sobin George
Sobin George

Reputation: 86

My problem was the same as that in the original question, only that I was running via Eclipse and not cmd. Tried all the solutions listed, but didn't work. The final working solution for me, however, was while running via cmd (or can be run similarly via Eclipse). Used a modified command appended with spring config from cmd:

start java -Xms512m -Xmx1024m <and the usual parameters as needed, like PrintGC etc> -Dspring.config.location=<propertiesfiles> -jar <jar>

I guess my issue was the spring configurations not being loaded correctly.

Upvotes: 0

Mike
Mike

Reputation: 159

In case you're using IntelliJ and this is happening to you (like it did to my noob-self), ensure the Run setting has Spring Boot Application and NOT plain Application.

Upvotes: 3

Bhanu Dhulipudi
Bhanu Dhulipudi

Reputation: 72

I did right click on my project in IntelliJ IDEA then Maven -> Reload project, problem solved.

Upvotes: 3

tschumann
tschumann

Reputation: 3246

Similar to the solution of making sure org.springframework.boot:spring-boot-starter-tomcat was installed, I was missing org.eclipse.jetty:jetty-server from my build.gradle

org.springframework.boot:spring-boot-starter-web needs a server be it Tomcat, Jetty or something else - it will compile but not run without one.

Upvotes: 2

Kapil
Kapil

Reputation: 917

Adding following bean worked for me.

    @Bean
    public ServletWebServerFactory servletWebServerFactory() {
        return new TomcatServletWebServerFactory();
    }

I was running non web spring application using SpringApplication.run(MyApplication.class, args); without @SpringBootApplication annotation.

Upvotes: 17

Anurag
Anurag

Reputation: 397

Apart from the possible solutions in other answers, it is also possible that somehow Maven dependency corruption has occurred on your machine. I was facing the same error on trying to run my (Web) Spring boot application, and it got resolved by running the following -

mvn dependency:purge-local-repository -DreResolve=true

followed by

mvn package

I came onto this solution looking into another issue where Eclipse wouldn't let me run the main application class from the IDE, due to a different error, similar to one on this SO thread -> The type org.springframework.context.ConfigurableApplicationContext cannot be resolved. It is indirectly referenced from required .class files

Upvotes: 2

Evandro Coan
Evandro Coan

Reputation: 9418

In my case, I was using an TOMCAT 8 and updating to TOMCAT 9 fixed it:

  <modelVersion>4.0.0</modelVersion>
  <groupId>spring-boot-app</groupId>
  <artifactId>spring-boot-app</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>war</packaging>

  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.3.1.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
  </parent>

  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>
      <groupId>com.h2database</groupId>
      <artifactId>h2</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>exec-maven-plugin</artifactId>
        <version>1.2.1</version>
        <executions>
          <execution>
            <goals>
              <goal>java</goal>
            </goals>
          </execution>
        </executions>
        <configuration>
          <mainClass>com.example.Application</mainClass>
        </configuration>
      </plugin>
    </plugins>
  </build>

  <properties>
    <tomcat.version>9.0.37</tomcat.version>
  </properties>

Related issues:

  1. https://github.com/spring-projects/spring-boot/issues?q=missing+ServletWebServerFactory+bean
  2. https://github.com/spring-projects/spring-boot/issues/22013 - Spring Boot app as a module
  3. https://github.com/spring-projects/spring-boot/issues/19141 - Application fails to load when main class extends a base class annotated with @SpringBootApplication when spring-boot-starter-web is included as a dependency

Upvotes: 1

Manjunath
Manjunath

Reputation: 824

In my case the issue resolved on commenting the tomcat dependencies exclusion from spring-boot-starte-web

     <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <!-- <exclusions>
            <exclusion>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-tomcat</artifactId>
            </exclusion>
        </exclusions> -->
    </dependency> 

Upvotes: 15

Badri Paudel
Badri Paudel

Reputation: 1630

I was trying to create a web application with spring boot and I got the same error. After inspecting I found that I was missing a dependency. So, be sure to add following dependency to your pom.xml file.

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency> 

Upvotes: 1

user1156041
user1156041

Reputation: 2195

As for me, I removed the provided scope in tomcat dependency.

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-tomcat</artifactId>
  <scope>provided</scope> // remove this scope
</dependency>

Upvotes: 5

Spencer Sutton
Spencer Sutton

Reputation: 3397

My solution had to do with a bad dependency. I had:

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
  <exclusions>
    <exclusion>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-tomcat</artifactId>
    </exclusion>
  </exclusions>
</dependency>

In my pom and I had to comment out the exclusion to get it working. It must look for this tomcat package for some reason.

Upvotes: 26

Ravindranath Akila
Ravindranath Akila

Reputation: 57

Annotate class public static void main with, for example: @SpringBootApplication

Upvotes: 5

Solomon Raja
Solomon Raja

Reputation: 1790

In my case, the problem was I didn't had a Tomcat server separately installed in my eclipse. I assumed my Springboot will start the server automatically within itself.

Since my main class extends SpringBootServletInitializer and override configure method, I definitely need a Tomcat server installed in my IDE.

To install, first download Apachce Tomcat (version 9 in my case) and create server using Servers tab.

After installation, run the main class on server.

Run As -> Run on Server

Upvotes: 1

Adrian
Adrian

Reputation: 3711

You probably use this in your project:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-webflux</artifactId>
</dependency>

in which case you'll have to also add:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

and the magic happens :)

PS: that's because Spring will use by default web-MVC instead of web-flux when both are available

Upvotes: 13

vishal thakur
vishal thakur

Reputation: 657

Probably you missing @SpringBootApplication in your spring boot starter class.

@SpringBootApplication
public class LoginSecurityAppApplication {

    public static void main(String[] args) {
        SpringApplication.run(LoginSecurityAppApplication.class, args);
    }

}

Upvotes: 46

Michael
Michael

Reputation: 1183

Upgrading spring-boot-starter-parent in pom.xml to the latest version fixed it for me.

Upvotes: 0

NemraOx
NemraOx

Reputation: 123

I encountered this problem when attempint to run my web application as a fat jar rather than from within my IDE (IntelliJ).

This is what worked for me. Simply adding a default profile to the application.properties file.

spring.profiles.active=default

You don't have to use default if you have already set up other specific profiles (dev/test/prod). But if you haven't this is necessary to run the application as a fat jar.

Upvotes: 0

Evgeniy
Evgeniy

Reputation: 146

I had this problem during migration to Spring Boot. I've found a advice to remove dependencies and it helped. So, I removed dependency for jsp-api Project had. Also, servlet-api dependency has to be removed as well.

compileOnly group: 'javax.servlet.jsp', name: 'jsp-api', version: '2.2' 

Upvotes: 3

Related Questions