Class AbstractServletWebServerFactory

Method Details

• getContextPath

  public String getContextPath()

  Returns the context path for the web server. The path will start with "/" and not end with "/". The root context is represented by an empty string.

  Returns:

  the context path

• setContextPath

  public void setContextPath(String contextPath)

  Description copied from interface: ConfigurableServletWebServerFactory

  Sets the context path for the web server. The context should start with a "/" character but not end with a "/" character. The default context path can be specified using an empty string.

  Specified by:

  setContextPath in interface ConfigurableServletWebServerFactory

  Parameters:

  contextPath - the contextPath to set

• getDisplayName

  public String getDisplayName()

• setDisplayName

  public void setDisplayName(String displayName)

  Description copied from interface: ConfigurableServletWebServerFactory

  Sets the display name of the application deployed in the web server.

  Specified by:

  setDisplayName in interface ConfigurableServletWebServerFactory

  Parameters:

  displayName - the displayName to set

• isRegisterDefaultServlet

  public boolean isRegisterDefaultServlet()

  Flag to indicate that the default servlet should be registered.

  Returns:

  true if the default servlet is to be registered

• setRegisterDefaultServlet

  public void setRegisterDefaultServlet(boolean registerDefaultServlet)

  Description copied from interface: ConfigurableServletWebServerFactory

  Set if the DefaultServlet should be registered. Defaults to false since 2.4.

  Specified by:

  setRegisterDefaultServlet in interface ConfigurableServletWebServerFactory

  Parameters:

  registerDefaultServlet - if the default servlet should be registered

• getMimeMappings

  public MimeMappings getMimeMappings()

  Returns the mime-type mappings.

  Returns:

  the mimeMappings the mime-type mappings.

• setMimeMappings

  public void setMimeMappings(MimeMappings mimeMappings)

  Description copied from interface: ConfigurableServletWebServerFactory

  Sets the mime-type mappings.

  Specified by:

  setMimeMappings in interface ConfigurableServletWebServerFactory

  Parameters:

  mimeMappings - the mime type mappings (defaults to MimeMappings.DEFAULT)

• getDocumentRoot

  public File getDocumentRoot()

  Returns the document root which will be used by the web context to serve static files.

  Returns:

  the document root

• setDocumentRoot

  public void setDocumentRoot(File documentRoot)

  Description copied from interface: ConfigurableServletWebServerFactory

  Sets the document root directory which will be used by the web context to serve static files.

  Specified by:

  setDocumentRoot in interface ConfigurableServletWebServerFactory

  Parameters:

  documentRoot - the document root or null if not required

• setInitializers

  public void setInitializers(List<? extends ServletContextInitializer> initializers)

  Description copied from interface: ConfigurableServletWebServerFactory

  Sets ServletContextInitializer that should be applied in addition to ServletWebServerFactory.getWebServer(ServletContextInitializer...) parameters. This method will replace any previously set or added initializers.

  Specified by:

  setInitializers in interface ConfigurableServletWebServerFactory

  Parameters:

  initializers - the initializers to set

  See Also:

  • ConfigurableServletWebServerFactory.addInitializers(org.springframework.boot.web.servlet.ServletContextInitializer...)

• addInitializers

  public void addInitializers(ServletContextInitializer... initializers)

  Description copied from interface: ConfigurableServletWebServerFactory

  Add ServletContextInitializers to those that should be applied in addition to ServletWebServerFactory.getWebServer(ServletContextInitializer...) parameters.

  Specified by:

  addInitializers in interface ConfigurableServletWebServerFactory

  Parameters:

  initializers - the initializers to add

  See Also:

  • ConfigurableServletWebServerFactory.setInitializers(java.util.List<? extends org.springframework.boot.web.servlet.ServletContextInitializer>)

• getJsp

  public Jsp getJsp()

• setJsp

  public void setJsp(Jsp jsp)

  Description copied from interface: ConfigurableServletWebServerFactory

  Sets the configuration that will be applied to the server's JSP servlet.

  Specified by:

  setJsp in interface ConfigurableServletWebServerFactory

  Parameters:

  jsp - the JSP servlet configuration

• getSession

  public Session getSession()

• setSession

  public void setSession(Session session)

  Description copied from interface: ConfigurableServletWebServerFactory

  Sets the configuration that will be applied to the container's HTTP session support.

  Specified by:

  setSession in interface ConfigurableServletWebServerFactory

  Parameters:

  session - the session configuration

• getLocaleCharsetMappings

  public Map<Locale,Charset> getLocaleCharsetMappings()

  Return the Locale to Charset mappings.

  Returns:

  the charset mappings

• setLocaleCharsetMappings

  public void setLocaleCharsetMappings(Map<Locale,Charset> localeCharsetMappings)

  Description copied from interface: ConfigurableServletWebServerFactory

  Sets the Locale to Charset mappings.

  Specified by:

  setLocaleCharsetMappings in interface ConfigurableServletWebServerFactory

  Parameters:

  localeCharsetMappings - the Locale to Charset mappings

• setInitParameters

  public void setInitParameters(Map<String,String> initParameters)

  Description copied from interface: ConfigurableServletWebServerFactory

  Sets the init parameters that are applied to the container's ServletContext.

  Specified by:

  setInitParameters in interface ConfigurableServletWebServerFactory

  Parameters:

  initParameters - the init parameters

• getInitParameters

  public Map<String,String> getInitParameters()

• setCookieSameSiteSuppliers

  public void setCookieSameSiteSuppliers(List<? extends CookieSameSiteSupplier> cookieSameSiteSuppliers)

  Description copied from interface: ConfigurableServletWebServerFactory

  Sets CookieSameSiteSuppliers that should be used to obtain the Cookie.SameSite attribute of any added cookie. This method will replace any previously set or added suppliers.

  Specified by:

  setCookieSameSiteSuppliers in interface ConfigurableServletWebServerFactory

  Parameters:

  cookieSameSiteSuppliers - the suppliers to add

  See Also:

  • ConfigurableServletWebServerFactory.addCookieSameSiteSuppliers(org.springframework.boot.web.servlet.server.CookieSameSiteSupplier...)

• addCookieSameSiteSuppliers

  public void addCookieSameSiteSuppliers(CookieSameSiteSupplier... cookieSameSiteSuppliers)

  Description copied from interface: ConfigurableServletWebServerFactory

  Add CookieSameSiteSuppliers to those that should be used to obtain the Cookie.SameSite attribute of any added cookie.

  Specified by:

  addCookieSameSiteSuppliers in interface ConfigurableServletWebServerFactory

  Parameters:

  cookieSameSiteSuppliers - the suppliers to add

  See Also:

  • ConfigurableServletWebServerFactory.setCookieSameSiteSuppliers(java.util.List<? extends org.springframework.boot.web.servlet.server.CookieSameSiteSupplier>)

• getCookieSameSiteSuppliers

  public List<CookieSameSiteSupplier> getCookieSameSiteSuppliers()

• mergeInitializers

  protected final ServletContextInitializer[] mergeInitializers(ServletContextInitializer... initializers)

  Utility method that can be used by subclasses wishing to combine the specified ServletContextInitializer parameters with those defined in this instance.

  Parameters:

  initializers - the initializers to merge

  Returns:

  a complete set of merged initializers (with the specified parameters appearing first)

• shouldRegisterJspServlet

  protected boolean shouldRegisterJspServlet()

  Returns whether the JSP servlet should be registered with the web server.

  Returns:

  true if the servlet should be registered, otherwise false

• getValidDocumentRoot

  protected final File getValidDocumentRoot()

  Returns the absolute document root when it points to a valid directory, logging a warning and returning null otherwise.

  Returns:

  the valid document root

• getUrlsOfJarsWithMetaInfResources

  protected final List<URL> getUrlsOfJarsWithMetaInfResources()

• getValidSessionStoreDir

  protected final File getValidSessionStoreDir()

• getValidSessionStoreDir

  protected final File getValidSessionStoreDir(boolean mkdirs)

• addWebListeners

  public void addWebListeners(String... webListenerClassNames)

  Description copied from interface: WebListenerRegistry

  Adds web listeners that will be registered with the servlet container.

  Specified by:

  addWebListeners in interface WebListenerRegistry

  Parameters:

  webListenerClassNames - the class names of the web listeners

• getWebListenerClassNames

  protected final Set<String> getWebListenerClassNames()