org.codehaus.mojo.jboss
Class StopMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.codehaus.mojo.jboss.AbstractJBossServerMojo
          extended by org.codehaus.mojo.jboss.StopMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class StopMojo
extends AbstractJBossServerMojo

Stops JBoss. By default the plugin will return immediately after calling "shutdown" command. The @see #stopWait parameter can be used to force the plugin to wait for a specified time before returning control.

Author:
Jeff Genender
Requires a Maven project to run:
false
Is defined by the goal name:
stop

Field Summary
protected  String options
          Deprecated. use stopOptions instead
static String SHUTDOWN_COMMAND
          The command to shutdown JBoss.
protected  String stopOptions
          The set of options to pass to the JBoss "run" command.
protected  int stopWait
          Wait in ms for server to shutdown before the plugin returns.
 
Fields inherited from class org.codehaus.mojo.jboss.AbstractJBossServerMojo
jbossHome, serverName
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
StopMojo()
           
 
Method Summary
 void execute()
          Main plugin execution.
 
Methods inherited from class org.codehaus.mojo.jboss.AbstractJBossServerMojo
checkConfig, getPassword, getUsername, launch, launchUnixScript, launchWindowsBatch
 
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SHUTDOWN_COMMAND

public static final String SHUTDOWN_COMMAND
The command to shutdown JBoss.

See Also:
Constant Field Values

stopOptions

protected String stopOptions
The set of options to pass to the JBoss "run" command.

Since:
1.5.0
Is defined by:
expression:
${jboss.stopOptions}
default-value:
-S

stopWait

protected int stopWait
Wait in ms for server to shutdown before the plugin returns.

Since:
1.4.1
Is defined by:
expression:
${jboss.stopWait}

options

protected String options
Deprecated. use stopOptions instead
The set of options to pass to the JBoss "run" command.

Is defined by:
expression:
${jboss.options}
default-value:
Constructor Detail

StopMojo

public StopMojo()
Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException
Main plugin execution.

Throws:
org.apache.maven.plugin.MojoExecutionException


Copyright © 2005-2012 Codehaus. All Rights Reserved.