Index (Tomcat Maven Plugin 1.0.1-SNAPSHOT API)

A B C D E F G H I J K L M P R S T U V W
All Classes and Interfaces|All Packages

A

AbstractTomcatMojo - Class in io.github.rajendarreddyj.tomcat: Abstract base class for all Tomcat plugin Mojos.
AbstractTomcatMojo() - Constructor for class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo
Auto-Publish - Search tag in package io.github.rajendarreddyj.tomcat.deploy: Section
autopublishEnabled - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Enable automatic republishing when source files change.
autopublishEnabled(boolean) - Method in class io.github.rajendarreddyj.tomcat.config.DeployableConfiguration.Builder: Sets whether auto-publish is enabled.
autopublishInactivityLimit - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Seconds of inactivity before auto-publish triggers.
autopublishInactivityLimit(int) - Method in class io.github.rajendarreddyj.tomcat.config.DeployableConfiguration.Builder: Sets the auto-publish inactivity limit.
Available Goals - Search tag in package io.github.rajendarreddyj.tomcat: Section

B

build() - Method in class io.github.rajendarreddyj.tomcat.config.DeployableConfiguration.Builder: Builds the DeployableConfiguration.
build() - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration.Builder: Builds the ServerConfiguration.
buildDeployableConfiguration(ServerConfiguration) - Method in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Builds DeployableConfiguration from Mojo parameters.
builder() - Static method in class io.github.rajendarreddyj.tomcat.config.DeployableConfiguration: Creates a new Builder instance.
builder() - Static method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration: Creates a new Builder instance.
Builder Pattern - Search tag in package io.github.rajendarreddyj.tomcat.config: Section
buildJdwpAgentArg() - Method in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Builds the JDWP agent string for debug mode.
buildServerConfiguration() - Method in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Builds ServerConfiguration from Mojo parameters.

C

Caching - Search tag in package io.github.rajendarreddyj.tomcat.download: Section
calculateChecksum(Path) - Method in class io.github.rajendarreddyj.tomcat.download.ChecksumValidator: Calculates SHA-512 checksum of a file.
catalinaBase - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Path to Tomcat instance directory (CATALINA_BASE).
catalinaBase(Path) - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration.Builder: Sets the CATALINA_BASE directory.
CatalinaBaseGenerator - Class in io.github.rajendarreddyj.tomcat.config: Generates a custom CATALINA_BASE directory with modified server.xml for port configuration.
catalinaHome - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Path to an existing Tomcat installation (CATALINA_HOME).
catalinaHome(Path) - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration.Builder: Sets the CATALINA_HOME directory.
ChecksumValidator - Class in io.github.rajendarreddyj.tomcat.download: Validates file integrity using SHA-512 checksums.
ChecksumValidator() - Constructor for class io.github.rajendarreddyj.tomcat.download.ChecksumValidator
Classes - Search tag in package io.github.rajendarreddyj.tomcat.deploy: Section
Classes - Search tag in package io.github.rajendarreddyj.tomcat.download: Section
Classes - Search tag in package io.github.rajendarreddyj.tomcat.lifecycle: Section
classpathAdditions - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Additional JAR files to add to Tomcat's classpath.
classpathAdditions(List<String>) - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration.Builder: Sets the additional classpath entries.
close() - Method in class io.github.rajendarreddyj.tomcat.deploy.HotDeployWatcher
Configuration - Search tag in class io.github.rajendarreddyj.tomcat.StopMojo: Section
Configuration Classes - Search tag in package io.github.rajendarreddyj.tomcat.config: Section
Configuration Example - Search tag in class io.github.rajendarreddyj.tomcat.DebugMojo: Section
Configuration Example - Search tag in class io.github.rajendarreddyj.tomcat.DeployMojo: Section
Configuration Example - Search tag in class io.github.rajendarreddyj.tomcat.RunMojo: Section
contextPath - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Context path for the deployed application.
contextPath(String) - Method in class io.github.rajendarreddyj.tomcat.config.DeployableConfiguration.Builder: Sets the context path.

D

debugHost - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Host/interface for the debug agent to bind to.
DebugMojo - Class in io.github.rajendarreddyj.tomcat: Runs Apache Tomcat in debug mode with JDWP agent enabled.
DebugMojo() - Constructor for class io.github.rajendarreddyj.tomcat.DebugMojo
debugPort - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Port for the JDWP debug agent to listen on.
debugSuspend - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Whether to suspend JVM startup until a debugger attaches.
deploy(DeployableConfiguration) - Method in class io.github.rajendarreddyj.tomcat.deploy.ExplodedWarDeployer: Deploys the webapp to the configured location.
DeployableConfiguration - Class in io.github.rajendarreddyj.tomcat.config: Immutable configuration for deployment settings.
DeployableConfiguration.Builder - Class in io.github.rajendarreddyj.tomcat.config: Builder for DeployableConfiguration.
deployDir(Path) - Method in class io.github.rajendarreddyj.tomcat.config.DeployableConfiguration.Builder: Sets the deployment directory.
Deployment Modes - Search tag in package io.github.rajendarreddyj.tomcat.deploy: Section
deploymentOutputName - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Target directory for deployment within webapps.
deploymentOutputName(String) - Method in class io.github.rajendarreddyj.tomcat.config.DeployableConfiguration.Builder: Sets the deployment output name.
DeployMojo - Class in io.github.rajendarreddyj.tomcat: Deploys or redeploys the webapp to a running Tomcat instance.
DeployMojo() - Constructor for class io.github.rajendarreddyj.tomcat.DeployMojo
detectInstalledVersion(Path) - Method in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Detects the installed Tomcat version from an existing installation.
download(String, Path, Log) - Method in class io.github.rajendarreddyj.tomcat.download.TomcatDownloader: Downloads Tomcat if not cached, then extracts and returns the installation path.
Download Process - Search tag in package io.github.rajendarreddyj.tomcat.download: Section
downloadTomcat() - Method in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Downloads and extracts Tomcat distribution.

E

Eclipse - Search tag in class io.github.rajendarreddyj.tomcat.DebugMojo: Section
environmentVariables - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Environment variables to set for Tomcat process.
environmentVariables(Map<String, String>) - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration.Builder: Sets the environment variables.
execute() - Method in class io.github.rajendarreddyj.tomcat_maven_plugin.HelpMojo
execute() - Method in class io.github.rajendarreddyj.tomcat.DebugMojo: Executes the debug goal.
execute() - Method in class io.github.rajendarreddyj.tomcat.DeployMojo: Executes the deploy goal.
execute() - Method in class io.github.rajendarreddyj.tomcat.RunMojo: Executes the run goal.
execute() - Method in class io.github.rajendarreddyj.tomcat.StartMojo: Executes the start goal.
execute() - Method in class io.github.rajendarreddyj.tomcat.StopMojo: Executes the stop goal.
ExplodedWarDeployer - Class in io.github.rajendarreddyj.tomcat.deploy: Deploys exploded WAR directories to Tomcat webapps.
ExplodedWarDeployer(Log) - Constructor for class io.github.rajendarreddyj.tomcat.deploy.ExplodedWarDeployer: Creates a new ExplodedWarDeployer with the given logger.

F

fromVersionString(String) - Static method in enum class io.github.rajendarreddyj.tomcat.config.TomcatVersion: Determines the TomcatVersion from a version string.

G

generate(Path, Path, int, String) - Static method in class io.github.rajendarreddyj.tomcat.config.CatalinaBaseGenerator: Generates a CATALINA_BASE directory with customized configuration.
getArchiveChecksumUrl(String) - Method in enum class io.github.rajendarreddyj.tomcat.config.TomcatVersion: Gets the archive checksum URL for a specific version.
getArchiveDownloadUrl(String) - Method in enum class io.github.rajendarreddyj.tomcat.config.TomcatVersion: Gets the fallback (archive) download URL for a specific version.
getAutopublishInactivityLimit() - Method in class io.github.rajendarreddyj.tomcat.config.DeployableConfiguration: Gets the auto-publish inactivity limit in seconds.
getCatalinaBase() - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration: Gets the Tomcat instance directory (CATALINA_BASE).
getCatalinaHome() - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration: Gets the Tomcat installation directory (CATALINA_HOME).
getChecksumUrl(String) - Method in enum class io.github.rajendarreddyj.tomcat.config.TomcatVersion: Gets the checksum URL for a specific version.
getClasspathAdditions() - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration: Gets the additional classpath entries.
getContextPath() - Method in class io.github.rajendarreddyj.tomcat.config.DeployableConfiguration: Gets the context path.
getDeployDir() - Method in class io.github.rajendarreddyj.tomcat.config.DeployableConfiguration: Gets the deployment directory.
getDeploymentOutputName() - Method in class io.github.rajendarreddyj.tomcat.config.DeployableConfiguration: Gets the deployment output name.
getDownloadUrl(String) - Method in enum class io.github.rajendarreddyj.tomcat.config.TomcatVersion: Gets the primary download URL for a specific version.
getEnvironmentVariables() - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration: Gets the environment variables.
getHttpHost() - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration: Gets the HTTP host to bind to.
getHttpPort() - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration: Gets the HTTP port.
getJavaHome() - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration: Gets the Java home directory.
getMajorMinor() - Method in enum class io.github.rajendarreddyj.tomcat.config.TomcatVersion: Gets the major.minor version string.
getMinimumJava() - Method in enum class io.github.rajendarreddyj.tomcat.config.TomcatVersion: Gets the minimum Java version required.
getModuleName() - Method in class io.github.rajendarreddyj.tomcat.config.DeployableConfiguration: Gets the module name (typically the artifact ID).
getProcess() - Method in class io.github.rajendarreddyj.tomcat.lifecycle.TomcatLauncher: Gets the underlying Tomcat process.
getShutdownTimeout() - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration: Gets the shutdown timeout in milliseconds.
getSourcePath() - Method in class io.github.rajendarreddyj.tomcat.config.DeployableConfiguration: Gets the source path of the web application.
getStartupTimeout() - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration: Gets the startup timeout in milliseconds.
getTargetDirectoryName() - Method in class io.github.rajendarreddyj.tomcat.config.DeployableConfiguration: Derives the target directory name for deployment.
getVmOptions() - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration: Gets the JVM options.

H

hasCorrectPort(Path, int) - Static method in class io.github.rajendarreddyj.tomcat.config.CatalinaBaseGenerator: Checks if a CATALINA_BASE has the correct HTTP port configured.
HelpMojo - Class in io.github.rajendarreddyj.tomcat_maven_plugin: Display help information on tomcat-maven-plugin.
Call mvn tomcat:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
HelpMojo() - Constructor for class io.github.rajendarreddyj.tomcat_maven_plugin.HelpMojo
HotDeployWatcher - Class in io.github.rajendarreddyj.tomcat.deploy: Watches for file changes and triggers hot deployment after an inactivity period.
HotDeployWatcher(DeployableConfiguration, ExplodedWarDeployer, Log) - Constructor for class io.github.rajendarreddyj.tomcat.deploy.HotDeployWatcher: Creates a new HotDeployWatcher.
httpHost - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: HTTP host/address for Tomcat to bind to.
httpHost(String) - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration.Builder: Sets the HTTP host.
httpPort - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: HTTP port for Tomcat to listen on.
httpPort(int) - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration.Builder: Sets the HTTP port.

I

IDE Connection - Search tag in class io.github.rajendarreddyj.tomcat.DebugMojo: Section
Integration Test Example - Search tag in class io.github.rajendarreddyj.tomcat.StartMojo: Section
IntelliJ IDEA - Search tag in class io.github.rajendarreddyj.tomcat.DebugMojo: Section
io.github.rajendarreddyj.tomcat - package io.github.rajendarreddyj.tomcat: Main package for the Tomcat Maven Plugin.
io.github.rajendarreddyj.tomcat_maven_plugin - package io.github.rajendarreddyj.tomcat_maven_plugin
io.github.rajendarreddyj.tomcat.config - package io.github.rajendarreddyj.tomcat.config: Configuration classes for the Tomcat Maven Plugin.
io.github.rajendarreddyj.tomcat.deploy - package io.github.rajendarreddyj.tomcat.deploy: Deployment utilities for the Tomcat Maven Plugin.
io.github.rajendarreddyj.tomcat.download - package io.github.rajendarreddyj.tomcat.download: Download and extraction utilities for the Tomcat Maven Plugin.
io.github.rajendarreddyj.tomcat.lifecycle - package io.github.rajendarreddyj.tomcat.lifecycle: Tomcat process lifecycle management for the Tomcat Maven Plugin.
isAutopublishEnabled() - Method in class io.github.rajendarreddyj.tomcat.config.DeployableConfiguration: Checks if auto-publish is enabled.
isValidCatalinaBase(Path) - Static method in class io.github.rajendarreddyj.tomcat.config.CatalinaBaseGenerator: Checks if a CATALINA_BASE already exists and appears valid.

J

javaHome - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Path to JDK installation (JAVA_HOME).
javaHome(Path) - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration.Builder: Sets the Java home directory.

K

Key Features - Search tag in package io.github.rajendarreddyj.tomcat: Section

L

Lifecycle Operations - Search tag in package io.github.rajendarreddyj.tomcat.lifecycle: Section

M

moduleName(String) - Method in class io.github.rajendarreddyj.tomcat.config.DeployableConfiguration.Builder: Sets the module name.

P

Process Management - Search tag in package io.github.rajendarreddyj.tomcat.lifecycle: Section
project - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo

R

redeploy(DeployableConfiguration) - Method in class io.github.rajendarreddyj.tomcat.deploy.ExplodedWarDeployer: Redeploys the webapp (remove and recreate).
resolveCatalinaHome() - Method in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Resolves the CATALINA_HOME path, downloading Tomcat if necessary.
Resource Management - Search tag in class io.github.rajendarreddyj.tomcat.deploy.HotDeployWatcher: Section
run() - Method in class io.github.rajendarreddyj.tomcat.lifecycle.TomcatLauncher: Starts Tomcat in foreground mode (blocks until shutdown).
RunMojo - Class in io.github.rajendarreddyj.tomcat: Runs Apache Tomcat in foreground mode with the project's webapp deployed.
RunMojo() - Constructor for class io.github.rajendarreddyj.tomcat.RunMojo

S

ServerConfiguration - Class in io.github.rajendarreddyj.tomcat.config: Immutable configuration for Tomcat server settings.
ServerConfiguration.Builder - Class in io.github.rajendarreddyj.tomcat.config: Builder for ServerConfiguration.
Shutdown Handling - Search tag in package io.github.rajendarreddyj.tomcat.lifecycle: Section
shutdownTimeout - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Timeout in milliseconds for Tomcat shutdown.
shutdownTimeout(long) - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration.Builder: Sets the shutdown timeout.
skip - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Skip plugin execution entirely.
sourcePath(Path) - Method in class io.github.rajendarreddyj.tomcat.config.DeployableConfiguration.Builder: Sets the source path.
start() - Method in class io.github.rajendarreddyj.tomcat.deploy.HotDeployWatcher: Starts watching for file changes.
start() - Method in class io.github.rajendarreddyj.tomcat.lifecycle.TomcatLauncher: Starts Tomcat in background mode.
StartMojo - Class in io.github.rajendarreddyj.tomcat: Starts Apache Tomcat in background mode with the project's webapp deployed.
StartMojo() - Constructor for class io.github.rajendarreddyj.tomcat.StartMojo
startupTimeout - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Timeout in milliseconds for Tomcat startup.
startupTimeout(long) - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration.Builder: Sets the startup timeout.
stop() - Method in class io.github.rajendarreddyj.tomcat.lifecycle.TomcatLauncher: Stops running Tomcat instance.
StopMojo - Class in io.github.rajendarreddyj.tomcat: Stops a running Apache Tomcat instance started by the start goal.
StopMojo() - Constructor for class io.github.rajendarreddyj.tomcat.StopMojo
Supported Tomcat Versions - Search tag in package io.github.rajendarreddyj.tomcat: Section
syncChanges(DeployableConfiguration, Path) - Method in class io.github.rajendarreddyj.tomcat.deploy.ExplodedWarDeployer: Synchronizes changed files from source to deployed webapp.

T

Thread Model - Search tag in class io.github.rajendarreddyj.tomcat.deploy.HotDeployWatcher: Section
TOMCAT_10_1 - Enum constant in enum class io.github.rajendarreddyj.tomcat.config.TomcatVersion: Tomcat 10.1.x - Jakarta EE 10, requires Java 11+.
TOMCAT_11 - Enum constant in enum class io.github.rajendarreddyj.tomcat.config.TomcatVersion: Tomcat 11.x - Jakarta EE 11, requires Java 17+.
tomcatCacheDir - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Directory for caching downloaded Tomcat distributions.
TomcatDownloader - Class in io.github.rajendarreddyj.tomcat.download: Downloads and extracts Apache Tomcat distributions.
TomcatDownloader() - Constructor for class io.github.rajendarreddyj.tomcat.download.TomcatDownloader: Creates a new TomcatDownloader instance.
TomcatLauncher - Class in io.github.rajendarreddyj.tomcat.lifecycle: Manages Tomcat process lifecycle.
TomcatLauncher(ServerConfiguration, Log) - Constructor for class io.github.rajendarreddyj.tomcat.lifecycle.TomcatLauncher: Creates a new TomcatLauncher with the given configuration.
tomcatVersion - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Tomcat version to use.
TomcatVersion - Enum Class in io.github.rajendarreddyj.tomcat.config: Represents supported Tomcat versions with their download URLs and Java requirements.
toString() - Method in class io.github.rajendarreddyj.tomcat.config.DeployableConfiguration
toString() - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration

U

Usage - Search tag in class io.github.rajendarreddyj.tomcat.DebugMojo: Section
Usage - Search tag in class io.github.rajendarreddyj.tomcat.DeployMojo: Section
Usage - Search tag in class io.github.rajendarreddyj.tomcat.RunMojo: Section
Usage - Search tag in class io.github.rajendarreddyj.tomcat.StartMojo: Section
Usage - Search tag in class io.github.rajendarreddyj.tomcat.StopMojo: Section

V

validate(Path, String) - Method in class io.github.rajendarreddyj.tomcat.download.ChecksumValidator: Validates file checksum against remote SHA-512 file.
validateDebugPortAvailable() - Method in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Validates that the debug port is available.
validateJavaVersion() - Method in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Validates Java version compatibility with Tomcat version.
validateJavaVersion() - Method in enum class io.github.rajendarreddyj.tomcat.config.TomcatVersion: Validates that the current Java runtime meets the minimum requirements.
validatePortAvailable() - Method in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Validates that the HTTP port is available before starting Tomcat.
validateTomcatInstallation(Path) - Method in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Validates that the path contains a valid Tomcat installation.
valueOf(String) - Static method in enum class io.github.rajendarreddyj.tomcat.config.TomcatVersion: Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.github.rajendarreddyj.tomcat.config.TomcatVersion: Returns an array containing the constants of this enum class, in the order they are declared.
vmOptions - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: JVM options to pass to Tomcat (CATALINA_OPTS).
vmOptions(List<String>) - Method in class io.github.rajendarreddyj.tomcat.config.ServerConfiguration.Builder: Sets the JVM options.
VS Code - Search tag in class io.github.rajendarreddyj.tomcat.DebugMojo: Section

W

warSourceDirectory - Variable in class io.github.rajendarreddyj.tomcat.AbstractTomcatMojo: Directory containing the exploded WAR to deploy.

A B C D E F G H I J K L M P R S T U V W
All Classes and Interfaces|All Packages