org.eclipse.jetty.maven.plugin.JettyStartMojo Maven / Gradle / Ivy
//
// ========================================================================
// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//
package org.eclipse.jetty.maven.plugin;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.ResolutionScope;
/**
*
* This goal is similar to the jetty:run goal in that it it starts jetty on an unassembled webapp,
* EXCEPT that it is designed to be bound to an execution inside your pom. Thus, this goal does NOT
* run a parallel build cycle, so you must be careful to ensure that you bind it to a phase in
* which all necessary generated files and classes for the webapp have been created.
*
*
* This goal will NOT scan for changes in either the webapp project or any scanTargets or scanTargetPatterns.
*
*
* You can configure this goal to run your webapp either in-process with maven, or forked into a new process, or deployed into a
* jetty distribution.
*
*/
@Mojo(name = "start", requiresDependencyResolution = ResolutionScope.TEST)
public class JettyStartMojo extends AbstractUnassembledWebAppMojo
{
/**
* Starts the webapp - without first compiling the classes -
* in the same process as maven.
*/
@Override
public void startJettyEmbedded() throws MojoExecutionException
{
try
{
JettyEmbedder jetty = newJettyEmbedder();
jetty.setExitVm(false);
jetty.setStopAtShutdown(false);
jetty.start();
}
catch (Exception e)
{
throw new MojoExecutionException("Error starting jetty", e);
}
}
/**
* Start the webapp in a forked jetty process. Use the
* jetty:stop goal to terminate.
*/
@Override
public void startJettyForked() throws MojoExecutionException
{
try
{
JettyForker jetty = newJettyForker();
jetty.setWaitForChild(false); //we never wait for child to finish
jetty.setMaxChildStartChecks(maxChildStartChecks);
jetty.setMaxChildStartCheckMs(maxChildStartCheckMs);
jetty.setJettyOutputFile(getJettyOutputFile("jetty-start.out"));
jetty.start(); //forks jetty instance
}
catch (Exception e)
{
throw new MojoExecutionException("Error starting jetty", e);
}
}
/**
* Start the webapp in a forked jetty distribution. Use the
* jetty:stop goal to terminate
*/
@Override
public void startJettyHome() throws MojoExecutionException
{
try
{
JettyHomeForker jetty = newJettyHomeForker();
jetty.setWaitForChild(false); //never wait for child to finish
jetty.setMaxChildStartChecks(maxChildStartChecks);
jetty.setMaxChildStartCheckMs(maxChildStartCheckMs);
jetty.setJettyOutputFile(getJettyOutputFile("jetty-start.out"));
jetty.start(); //forks a jetty home
}
catch (Exception e)
{
throw new MojoExecutionException("Error starting jetty", e);
}
}
}