org.rhq.maven.plugins

Class AbstractExecCliMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.rhq.maven.plugins.AbstractExecCliMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

ExecCliCommandMojo, ExecCliScriptMojo

public abstract class AbstractExecCliMojo
extends org.apache.maven.plugin.AbstractMojo

Author:

Thomas Segismont

Field Summary

Fields

Modifier and Type	Field and Description
protected File	buildDirectory The build directory (root of build works).
protected boolean	failOnError Whether to fail the build if an error occurs while uploading.
protected String	host Remote RHQ server host.
protected boolean	login Whether to login to a remote RHQ server.
protected String	password Authentication password.
protected int	port Remote RHQ server port.
protected File	rhqCliDirectory The CLI directory (where to install the RHQ CLI).
protected String	rhqVersion Version of the RHQ CLI.
protected String	username Authentication user name.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractExecCliMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	doExecute()
void	execute()
protected File	getRhqCliStartScriptFile()
protected void	handleException(Exception e)
protected void	handleFailure(String message)
protected abstract boolean	shouldSkip()
protected abstract void	validateParams()

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

buildDirectory

@Parameter(defaultValue="${project.build.directory}",
           required=true,
           readonly=true)
protected File buildDirectory

The build directory (root of build works).

rhqCliDirectory

@Parameter(defaultValue="${project.build.directory}/rhq-cli",
           required=true)
protected File rhqCliDirectory

The CLI directory (where to install the RHQ CLI).

rhqVersion

@Parameter(required=true)
protected String rhqVersion

Version of the RHQ CLI.

login

@Parameter(defaultValue="false")
protected boolean login

Whether to login to a remote RHQ server.

host

@Parameter(required=false)
protected String host

Remote RHQ server host. Required if login is set to true.

port

@Parameter(defaultValue="7080")
protected int port

Remote RHQ server port.

username

@Parameter(required=false)
protected String username

Authentication user name. Required if login is set to true.

password

@Parameter(required=false)
protected String password

Authentication password. Required if login is set to true.

failOnError

@Parameter(defaultValue="true")
protected boolean failOnError

Whether to fail the build if an error occurs while uploading.

Constructor Detail

AbstractExecCliMojo

public AbstractExecCliMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

shouldSkip

protected abstract boolean shouldSkip()

validateParams

protected abstract void validateParams()
                                throws org.apache.maven.plugin.MojoExecutionException,
                                       org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

doExecute

protected abstract void doExecute()
                           throws org.apache.maven.plugin.MojoExecutionException,
                                  org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getRhqCliStartScriptFile

protected File getRhqCliStartScriptFile()
                                 throws IOException

Throws:

IOException

handleFailure

protected void handleFailure(String message)
                      throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

handleException

protected void handleException(Exception e)
                        throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException