org.fuin.esmp

Class AbstractEventStoreMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.fuin.esmp.AbstractEventStoreMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

EventStoreDownloadMojo, EventStorePostStartMojo, EventStoreStartMojo, EventStoreStopMojo

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

Base class for all mojos.

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION_URL URL of the JSON file with available event store versions.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractEventStoreMojo()

Method Summary

Modifier and Type	Method and Description
protected List<String>	asList(String str) Returns the string as list.
protected void	checkNotNull(String name, Object value) Checks if a variable is not null and throws an IllegalNullArgumentException if this rule is violated.
protected void	deletePid() Deletes the process ID file in the target directory.
void	execute()
protected abstract void	executeGoal() Executes the goal code.
String	getDownloadOsQualifier() Returns the qualifier that helps selecting the right download.
String	getDownloadUrl() Returns the full URL where the event store file to download is located.
File	getEventStoreDir() Returns the directory where the event store should be installed.
String	getIncludeRc() Determines if release candidates (versions with "-rc") should be included.
protected File	getPidFile() Returns the PID file.
File	getTargetDir() Returns the target build directory.
String	getVersionUrl() Returns the URl of the version JSON file.
boolean	isIncludeRc() Determines if release candidates (versions with "-rc") should be included.
protected void	logDebug(List<String> messages) Logs all lines in debug mode.
protected void	logError(List<String> messages) Logs all lines in error mode.
protected String	readPid() Reads the process ID of the event store from a file in the target directory.
void	setDownloadOsQualifier(String downloadOsQualifier) Sets the qualifier that helps selecting the right download.
void	setDownloadUrl(String downloadUrl) Sets the full URL where the event store file to download is located.
void	setEventStoreDir(File eventStoreDir) Sets the directory where the event store should be installed.
void	setIncludeRc(String includeRc) Determines if release candidates (versions with "-rc") should be included.
void	setTargetDir(File targetDir) Sets the target build directory.
void	setVersionUrl(String versionUrl) Sets the URl of the version JSON file.
protected void	writePid(String pid) Writes the process ID of the event store to a file in the target directory.

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

VERSION_URL

public static final String VERSION_URL

URL of the JSON file with available event store versions.

See Also:

Constant Field Values

Constructor Detail

AbstractEventStoreMojo

public AbstractEventStoreMojo()

Method Detail

checkNotNull

protected final void checkNotNull(String name,
                                  Object value)
                           throws org.apache.maven.plugin.MojoExecutionException

Checks if a variable is not null and throws an IllegalNullArgumentException if this rule is violated.

Parameters:

name - Name of the variable to be displayed in an error message.

value - Value to check for null.

Throws:

org.apache.maven.plugin.MojoExecutionException - Checked value was NULL.

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

getDownloadUrl

public final String getDownloadUrl()
                            throws org.apache.maven.plugin.MojoExecutionException

Returns the full URL where the event store file to download is located.

Returns:

Download archive URL.

Throws:

org.apache.maven.plugin.MojoExecutionException - Error initializing the variable.

setDownloadUrl

public final void setDownloadUrl(String downloadUrl)

Sets the full URL where the event store file to download is located.

Parameters:

downloadUrl - Download archive URL to set

getEventStoreDir

public final File getEventStoreDir()
                            throws org.apache.maven.plugin.MojoExecutionException

Returns the directory where the event store should be installed. The downloaded archive will be uncompressed into this directory.

Returns:

Target directory.

Throws:

org.apache.maven.plugin.MojoExecutionException - Error initializing the variable.

setEventStoreDir

public final void setEventStoreDir(File eventStoreDir)

Sets the directory where the event store should be installed. The downloaded archive will be uncompressed into this directory.

Parameters:

eventStoreDir - Target directory to set

getTargetDir

public final File getTargetDir()

Returns the target build directory.

Returns:

The build directory.

setTargetDir

public final void setTargetDir(File targetDir)

Sets the target build directory.

Parameters:

targetDir - The build directory to set

getDownloadOsQualifier

public String getDownloadOsQualifier()

Returns the qualifier that helps selecting the right download.

Returns:

Qualifier.

setDownloadOsQualifier

public void setDownloadOsQualifier(String downloadOsQualifier)

Sets the qualifier that helps selecting the right download.

Parameters:

downloadOsQualifier - Qualifier.

getIncludeRc

public String getIncludeRc()

Determines if release candidates (versions with "-rc") should be included.

Returns:

true if RC candidates should be included.

isIncludeRc

public boolean isIncludeRc()

Determines if release candidates (versions with "-rc") should be included.

Returns:

true if RC candidates should be included.

setIncludeRc

public void setIncludeRc(String includeRc)

Determines if release candidates (versions with "-rc") should be included.

Parameters:

includeRc - true if RC candidates should be included.

getVersionUrl

public String getVersionUrl()

Returns the URl of the version JSON file.

Returns:

URl of the version JSON file.

setVersionUrl

public void setVersionUrl(String versionUrl)

Sets the URl of the version JSON file.

Parameters:

versionUrl - URl of the version JSON file.

writePid

protected final void writePid(String pid)
                       throws org.apache.maven.plugin.MojoExecutionException

Writes the process ID of the event store to a file in the target directory.

Parameters:

pid - PID to write.

Throws:

org.apache.maven.plugin.MojoExecutionException - Error writing the PID to file.

readPid

protected final String readPid()
                        throws org.apache.maven.plugin.MojoExecutionException

Reads the process ID of the event store from a file in the target directory.

Returns:

PID from file.

Throws:

org.apache.maven.plugin.MojoExecutionException - Error reading the PID from file.

deletePid

protected final void deletePid()
                        throws org.apache.maven.plugin.MojoExecutionException

Deletes the process ID file in the target directory.

Throws:

org.apache.maven.plugin.MojoExecutionException - Error deleting the PID file.

getPidFile

protected final File getPidFile()

Returns the PID file.

Returns:

Process ID file.

asList

protected final List<String> asList(String str)
                             throws org.apache.maven.plugin.MojoExecutionException

Returns the string as list.

Parameters:

str - String to split into lines.

Returns:

List of lines.

Throws:

org.apache.maven.plugin.MojoExecutionException - Error splitting the string into lines.

logDebug

protected final void logDebug(List<String> messages)

Logs all lines in debug mode.

Parameters:

messages - Lines to log.

logError

protected final void logError(List<String> messages)

Logs all lines in error mode.

Parameters:

messages - Lines to log.

executeGoal

protected abstract void executeGoal()
                             throws org.apache.maven.plugin.MojoExecutionException

Executes the goal code.

Throws:

org.apache.maven.plugin.MojoExecutionException - if goal execution failed