Package org.jboss.jca.sjc.maven

Class AbstractHostPortMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.jboss.jca.sjc.maven.AbstractHostPortMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

Deploy, Ping, Undeploy

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

An abstract host / port mojo

Author:

Jesper Pedersen

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractHostPortMojo()	Constructor

Method Summary

Modifier and Type	Method	Description
abstract void	execute()	Execute
protected Serializable	executeCommand(String command)	Execute command
protected Serializable	executeCommand(String command, Serializable[] arguments)	Execute command
String	getHost()	Get the host
int	getPort()	Get the port
protected boolean	isCommandAvailable(String command)	Is a command available
protected boolean	isLocal()	Is local
void	setHost(String v)	Set the host
void	setPort(int v)	Set the port

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

Constructor Detail

AbstractHostPortMojo

public AbstractHostPortMojo()

Constructor

Method Detail

getHost

public String getHost()

Get the host

Returns:

The value

setHost

public void setHost(String v)

Set the host

Parameters:

v - The value

getPort

public int getPort()

Get the port

Returns:

The value

setPort

public void setPort(int v)

Set the port

Parameters:

v - The value

isLocal

protected boolean isLocal()

Is local

Returns:

True if local; otherwise false

isCommandAvailable

protected boolean isCommandAvailable(String command)
                              throws Throwable

Is a command available

Parameters:

command - The command name

Returns:

True if available; otherwise false

Throws:

Throwable - If an error occurs

executeCommand

protected Serializable executeCommand(String command)
                               throws Throwable

Execute command

Parameters:

command - The command

Returns:

The result

Throws:

Throwable - If an error occurs

executeCommand

protected Serializable executeCommand(String command,
                                      Serializable[] arguments)
                               throws Throwable

Execute command

Parameters:

command - The command

arguments - The arguments

Returns:

The result

Throws:

Throwable - If an error occurs

execute

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

Execute

Throws:

org.apache.maven.plugin.MojoExecutionException - Thrown if the plugin cant be executed

org.apache.maven.plugin.MojoFailureException - Thrown if there is an error