org.codehaus.mojo.jboss
Class AbstractJBossServerMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.codehaus.mojo.jboss.AbstractJBossServerMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

ConfigureJBossMojo, HardDeployMojo, HardUnDeployMojo, StartMojo, StopMojo

public abstract class AbstractJBossServerMojo
extends AbstractMojo

This class provides the general functionality for interacting with a local JBoss server.

Field Summary

protected String	jbossHome The location of JBoss Home.
protected String	options The set of options to pass to the JBoss "run" command.
protected String	serverName The name of the configuration profile to use when starting the server.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

AbstractJBossServerMojo()

Method Summary

protected void	checkConfig() Check that JBOSS_HOME is correctly configured.
protected void	dump(InputStream input)
String	getPassword()
String	getUsername()
protected void	launch(String commandName, String params) Call the JBoss startup or shutdown script.

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

Methods inherited from interface org.apache.maven.plugin.Mojo

execute

Field Detail

jbossHome

protected String jbossHome

The location of JBoss Home. This is a required configuration parameter (unless JBOSS_HOME is set).

Is defined by:

expression:

${env.JBOSS_HOME}

Is required.

serverName

protected String serverName

The name of the configuration profile to use when starting the server. This might be something like "all", "default", or "minimal".

Is defined by:

expression:

${jboss.serverName}

default-value:

default

options

protected String options

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

Is defined by:

expression:

${jboss.options}

default-value:

Constructor Detail

AbstractJBossServerMojo

public AbstractJBossServerMojo()

Method Detail

checkConfig

protected void checkConfig()
                    throws MojoExecutionException

Check that JBOSS_HOME is correctly configured.

Throws:

MojoExecutionException

launch

protected void launch(String commandName,
                      String params)
               throws MojoExecutionException

Call the JBoss startup or shutdown script.

Parameters:

commandName - - The name of the command to run

params - - The command line parameters

Throws:

MojoExecutionException

dump

protected void dump(InputStream input)

getUsername

public String getUsername()
                   throws MojoExecutionException

Throws:

MojoExecutionException

getPassword

public String getPassword()
                   throws MojoExecutionException

Throws:

MojoExecutionException