1 package org.apache.tomcat.maven.plugin.tomcat7.run;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import org.apache.maven.plugin.MojoExecutionException;
23 import org.apache.tomcat.maven.common.run.EmbeddedRegistry;
24 import org.apache.tomcat.maven.plugin.tomcat7.AbstractTomcat7Mojo;
25
26
27 /**
28 * <p>
29 * Shuts down all possibly started embedded tomcat servers. This will be automatically down
30 * through a shutdown hook or you may call this Mojo to shut them down explictly.
31 * </p>
32 * <p>
33 * By default the <code>shutdown</code> goal is not bound to any phase. For integration tests
34 * you might want to bind it to <code>post-integration-test</code>.
35 * </p>
36 *
37 * @author Mark Michaelis
38 * @goal shutdown
39 * @requiresDependencyResolution runtime
40 * @since 2.0
41 */
42 public class ShutdownMojo
43 extends AbstractTomcat7Mojo
44 {
45 /**
46 * Shuts down all embedded tomcats which got started up to now.
47 *
48 * @throws org.apache.maven.plugin.MojoExecutionException
49 * if shutting down one or all servers failed
50 */
51 public void execute()
52 throws MojoExecutionException
53 {
54 try
55 {
56 EmbeddedRegistry.getInstance().shutdownAll( getLog() );
57 }
58 catch ( Exception e )
59 {
60 throw new MojoExecutionException( messagesProvider.getMessage( "ShutdownMojo.shutdownError" ), e );
61 }
62 }
63 }