Field Detail

• public static final java.lang.Object CONFIG_FILE

Property Detail

• @org.gradle.api.tasks.Input java.lang.String URIEncoding

  Specifies the character encoding used to decode the URI bytes by the HTTP Connector. Defaults to "UTF-8".

• @org.gradle.api.tasks.InputFiles java.lang.Iterable<java.io.File> additionalRuntimeResources

  Defines additional runtime JARs or directories that are not provided by the web application.

• @org.gradle.api.tasks.Input java.lang.Integer ajpPort

  The TCP port which Tomcat should listen for AJP requests. Defaults to 8009.

• @org.gradle.api.tasks.Input java.lang.String ajpProtocol

  The AJP protocol handler class name to be used. Defaults to org.apache.coyote.ajp.AjpProtocol.

• @org.gradle.api.tasks.Input @java.util.Optional java.lang.String clientAuth

  The clientAuth setting to use, values may be: "true", "false" or "want". Defaults to "false".

• @org.gradle.api.tasks.InputFile @java.util.Optional java.io.File configFile

  The path to the Tomcat context XML file.

• @org.gradle.api.tasks.Input @java.util.Optional java.lang.String contextPath

  The URL context path under which the web application will be registered. Defaults to WAR name.

• @org.gradle.api.tasks.Input java.lang.Boolean daemon

  Specifies whether the Tomcat server should run in the background. When true, this task completes as soon as the server has started. When false, this task blocks until the Tomcat server is stopped. Defaults to false.

• @org.gradle.api.tasks.Input java.lang.Boolean enableSSL

  Determines whether the HTTPS connector should be created. Defaults to false.

• @org.gradle.api.tasks.Input java.lang.Integer httpPort

  The TCP port which Tomcat should listen for HTTP requests. Defaults to 8080.

• @org.gradle.api.tasks.Input java.lang.String httpProtocol

  The HTTP protocol handler class name to be used. Defaults to org.apache.coyote.http11.Http11Protocol.

• @org.gradle.api.tasks.Input @java.util.Optional java.lang.Integer httpsPort

  The TCP port which Tomcat should listen for HTTPS requests. Defaults to 8443.

• @org.gradle.api.tasks.Input java.lang.String httpsProtocol

  The HTTPS protocol handler class name to be used. Defaults to org.apache.coyote.http11.Http11Protocol.

• @org.gradle.api.tasks.InputFile @java.util.Optional java.io.File keystoreFile

  The keystore file to use for SSL, if enabled (by default, a keystore will be generated).

• @org.gradle.api.tasks.Input @java.util.Optional java.lang.String keystorePass

  The keystore password to use for SSL, if enabled.

• @org.gradle.api.tasks.OutputFile @java.util.Optional java.io.File outputFile

  The file to write Tomcat log messages to. If the file already exists new messages will be appended.

• @org.gradle.api.tasks.Input java.lang.Boolean preserveSSLKey

  Doesn't override existing SSL key. Defaults to false.

• @org.gradle.api.tasks.Internal java.lang.Object realm

• @org.gradle.api.tasks.Input java.lang.Boolean reloadable

  Forces context scanning if you don't use a context file. Defaults to true.

• @org.gradle.api.tasks.Internal java.net.URL resolvedConfigFile

• @org.gradle.api.tasks.Internal java.lang.Object server

• @org.gradle.api.tasks.Input java.lang.String stopKey

  The key to pass to Tomcat when requesting it to stop. Defaults to "stopKey".

• @org.gradle.api.tasks.Input java.lang.Integer stopPort

  The TCP port which Tomcat should listen for admin requests. Defaults to 8081.

• @org.gradle.api.tasks.InputFiles org.gradle.api.file.FileCollection tomcatClasspath

  Classpath for Tomcat libraries.

• @org.gradle.api.tasks.InputFile @java.util.Optional java.io.File truststoreFile

  The truststore file to use for SSL, if enabled.

• @org.gradle.api.tasks.Input @java.util.Optional java.lang.String truststorePass

  The truststore password to use for SSL, if enabled.

• @org.gradle.api.tasks.Input @java.util.Optional java.util.List<TomcatUser> users

  The list of Tomcat users. Defaults to an empty list.

• @org.gradle.api.tasks.InputFile @java.util.Optional java.io.File webDefaultXml

  The default web.xml. If it doesn't get defined an instance of org.apache.catalina.servlets.DefaultServlet and org.apache.jasper.servlet.JspServlet will be set up.

Constructor Detail

• AbstractTomcatRun()

Method Detail

• protected void addWebappResource(java.io.File resource)

• protected void configureWebApplication()

  Configures web application

• @org.gradle.api.tasks.Internal protected java.lang.String getFullContextPath()

• void setWebApplicationContext()

• @org.gradle.api.tasks.TaskAction protected void start()

• void startTomcat()

• void user(java.lang.String username, java.lang.String password, java.util.List<java.lang.String> roles)

  Adds a Tomcat user by providing required fields. Allows for adding users in enhanced tasks without having to know the plugin's API class representing a Tomcat user.

  Parameters:

  username - Username

  password - Password

  roles - Roles

• protected void validateConfiguration()

  Validates configuration and throws an exception if

• void validateConfigurationAndStartTomcat()