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	DOWNLOADS_URL Base URL where the binary files are located.
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	getArchiveExtension() Returns the file extension of the archive (Like "zip" or "tar.gz").
String	getArchiveName() Returns the name of the archive (Like "EventStore-OSS-Win" or "EventStore-OSS-Linux") without version and file extension.
String	getArchiveVersion() Returns the version of the archive (Like "3.0.5").
String	getBaseUrl() Returns the base URl where the event store archives are located.
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.
protected File	getPidFile() Returns the PID file.
File	getTargetDir() Returns the target build directory.
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	setArchiveExtension(String archiveExtension) Sets the file extension of the archive (Like "zip" or "tar.gz").
void	setArchiveName(String archiveName) Sets the name of the archive (Like "EventStore-OSS-Win" or "EventStore-OSS-Linux") without version and file extension.
void	setArchiveVersion(String archiveVersion) Sets the version of the archive (Like "3.0.5").
void	setBaseUrl(String baseUrl) Sets the base URl where the event store archives are located.
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	setTargetDir(File targetDir) Sets the target build directory.
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

DOWNLOADS_URL

public static final String DOWNLOADS_URL

Base URL where the binary files are located.

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

getBaseUrl

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

Returns the base URl where the event store archives are located.

Returns:

Base URL where archives are located.

Throws:

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

setBaseUrl

public final void setBaseUrl(String baseUrl)

Sets the base URl where the event store archives are located.

Parameters:

baseUrl - Base URL where archives are located to set

getArchiveName

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

Returns the name of the archive (Like "EventStore-OSS-Win" or "EventStore-OSS-Linux") without version and file extension.

Returns:

the archiveName

Throws:

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

setArchiveName

public final void setArchiveName(String archiveName)

Sets the name of the archive (Like "EventStore-OSS-Win" or "EventStore-OSS-Linux") without version and file extension.

Parameters:

archiveName - Archive name to set.

getArchiveVersion

public final String getArchiveVersion()

Returns the version of the archive (Like "3.0.5").

Returns:

Event store version.

setArchiveVersion

public final void setArchiveVersion(String archiveVersion)

Sets the version of the archive (Like "3.0.5").

Parameters:

archiveVersion - The event store version to set.

getArchiveExtension

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

Returns the file extension of the archive (Like "zip" or "tar.gz").

Returns:

Archive file extension.

Throws:

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

setArchiveExtension

public final void setArchiveExtension(String archiveExtension)

Sets the file extension of the archive (Like "zip" or "tar.gz").

Parameters:

archiveExtension - Archive file extension 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

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