org.codehaus.mojo.cassandra

Class AbstractCassandraMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.cassandra.AbstractCassandraMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractCqlExecMojo, AbstractSchemaCassandraMojo, CleanupCassandraMojo, CompactCassandraMojo, FlushCassandraMojo, LoadCassandraUnitDataSetMojo, RepairCassandraMojo, TruncateCassandraMojo

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

Base class for all the Cassandra Maven Plugin goals.

Author:

stephenc

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addMainClasspath Adds the main classpath to cassandra (for example you could use this when you have a custom comparator on your main classpath.
protected boolean	addTestClasspath Adds the test classpath to cassandra (for example you could use this when you have a custom comparator on your test classpath.
protected File	cassandraDir The directory to hold cassandra's database.
protected int	jmxPort Port to listen to for the JMX interface.
protected String	keyspace The keyspace against which individual operations will be executed
protected String	listenAddress Address to bind to and tell other Cassandra nodes to connect to.
protected int	maxMemory Number of megabytes to limit the cassandra JVM to.
protected int	nativeTransportPort Port on which the CQL native transport listens for clients.
protected org.apache.maven.project.MavenProject	project The enclosing project.
protected String	rpcAddress Address to use for the RPC interface.
protected int	rpcPort Port to listen to for the RPC interface.
protected org.apache.maven.execution.MavenSession	session The current build session instance.
protected boolean	skip Skip the execution.
protected boolean	startNativeTransport Enable or disable the native transport server.
protected String	stopKey Key to be provided when stopping cassandra
protected int	stopPort Port to listen to for receiving the stop command over
protected int	storagePort Port to listen to for the Storage interface.
protected Map<String,String>	systemPropertyVariables List of System properties to pass to the JUnit tests.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractCassandraMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	createCassandraHome() Creates the cassandra home directory.
protected void	createCassandraHome(File cassandraDir, String listenAddress, String rpcAddress, BigInteger initialToken, String[] seeds) Creates the cassandra home directory.
protected void	createCassandraJar(File jarFile, String mainClass) Create a jar with just a manifest containing a Main-Class entry for SurefireBooter and a Class-Path entry for all classpath elements.
protected void	createCassandraJar(File jarFile, String mainClass, File cassandraDir) Create a jar with just a manifest containing a Main-Class entry for SurefireBooter and a Class-Path entry for all classpath elements.
protected Map<String,String>	createEnvironmentVars() Creates the environment required when launching Cassandra or the CLI tools.
protected org.apache.maven.toolchain.Toolchain	getToolchain() Gets the Java toolchain.
protected org.apache.commons.exec.CommandLine	newJavaCommandLine() Create a CommandLine to launch Java.
protected org.apache.commons.exec.CommandLine	newNodetoolCommandLine(String... args) Creates the command line to launch the nodetool utility.
protected org.apache.commons.exec.CommandLine	newServiceCommandLine() Creates the command line to launch the cassandra server.
protected org.apache.commons.exec.CommandLine	newServiceCommandLine(File cassandraDir, String listenAddress, String rpcAddress, BigInteger initialToken, String[] seeds, boolean jmxRemoteEnabled, int jmxPort) Creates the command line to launch the cassandra server.

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

cassandraDir

protected File cassandraDir

The directory to hold cassandra's database.

project

protected org.apache.maven.project.MavenProject project

The enclosing project.

addTestClasspath

protected boolean addTestClasspath

Adds the test classpath to cassandra (for example you could use this when you have a custom comparator on your test classpath.

addMainClasspath

protected boolean addMainClasspath

Adds the main classpath to cassandra (for example you could use this when you have a custom comparator on your main classpath.

skip

protected boolean skip

Skip the execution.

session

protected org.apache.maven.execution.MavenSession session

The current build session instance. This is used for toolchain manager API calls.

rpcAddress

protected String rpcAddress

Address to use for the RPC interface. Do not change this unless you really know what you are doing.

rpcPort

protected int rpcPort

Port to listen to for the RPC interface.

jmxPort

protected int jmxPort

Port to listen to for the JMX interface.

nativeTransportPort

protected int nativeTransportPort

Port on which the CQL native transport listens for clients.

Since:

2.0.0-1

startNativeTransport

protected boolean startNativeTransport

Enable or disable the native transport server. Currently, only the Thrift server is started by default because the native transport is considered beta.

Since:

2.0.0-1

listenAddress

protected String listenAddress

Address to bind to and tell other Cassandra nodes to connect to. You must change this if you want multiple nodes to be able to communicate!

Leaving it blank leaves it up to InetAddress.getLocalHost(). This will always do the Right Thing if the node is properly configured (hostname, name resolution, etc), and the Right Thing is to use the address associated with the hostname (it might not be).

Setting this to 0.0.0.0 is always wrong. Do not change this unless you really know what you are doing.

storagePort

protected int storagePort

Port to listen to for the Storage interface.

stopPort

protected int stopPort

Port to listen to for receiving the stop command over

stopKey

protected String stopKey

Key to be provided when stopping cassandra

maxMemory

protected int maxMemory

Number of megabytes to limit the cassandra JVM to.

keyspace

protected String keyspace

The keyspace against which individual operations will be executed

systemPropertyVariables

protected Map<String,String> systemPropertyVariables

List of System properties to pass to the JUnit tests.

Since:

1.2.1-2

Constructor Detail

AbstractCassandraMojo

public AbstractCassandraMojo()

Method Detail

createCassandraJar

protected void createCassandraJar(File jarFile,
                      String mainClass)
                           throws IOException

Create a jar with just a manifest containing a Main-Class entry for SurefireBooter and a Class-Path entry for all classpath elements. Copied from surefire (ForkConfiguration#createJar())

Parameters:

jarFile - The jar file to create/update

mainClass - The main class to run.

Throws:

IOException - if something went wrong.

createCassandraJar

protected void createCassandraJar(File jarFile,
                      String mainClass,
                      File cassandraDir)
                           throws IOException

Create a jar with just a manifest containing a Main-Class entry for SurefireBooter and a Class-Path entry for all classpath elements. Copied from surefire (ForkConfiguration#createJar())

Parameters:

jarFile - The jar file to create/update

mainClass - The main class to run.

Throws:

IOException - if something went wrong.

createCassandraHome

protected void createCassandraHome()
                            throws IOException

Creates the cassandra home directory.

Throws:

IOException - if something goes wrong.

createCassandraHome

protected void createCassandraHome(File cassandraDir,
                       String listenAddress,
                       String rpcAddress,
                       BigInteger initialToken,
                       String[] seeds)
                            throws IOException

Creates the cassandra home directory.

Parameters:

cassandraDir - the cassandra home directory.

Throws:

IOException - if something goes wrong.

getToolchain

protected org.apache.maven.toolchain.Toolchain getToolchain()

Gets the Java toolchain.

Returns:

the Java toolchain.

newJavaCommandLine

protected org.apache.commons.exec.CommandLine newJavaCommandLine()

Create a CommandLine to launch Java.

Returns:

a CommandLine to launch Java.

createEnvironmentVars

protected Map<String,String> createEnvironmentVars()

Creates the environment required when launching Cassandra or the CLI tools.

Returns:

the environment required when launching Cassandra or the CLI tools.

newServiceCommandLine

protected org.apache.commons.exec.CommandLine newServiceCommandLine()
                                                             throws IOException

Creates the command line to launch the cassandra server.

Returns:

the command line to launch the cassandra server.

Throws:

IOException - if there are issues creating the cassandra home directory.

newServiceCommandLine

protected org.apache.commons.exec.CommandLine newServiceCommandLine(File cassandraDir,
                                                        String listenAddress,
                                                        String rpcAddress,
                                                        BigInteger initialToken,
                                                        String[] seeds,
                                                        boolean jmxRemoteEnabled,
                                                        int jmxPort)
                                                             throws IOException

Creates the command line to launch the cassandra server.

Returns:

the command line to launch the cassandra server.

Throws:

IOException - if there are issues creating the cassandra home directory.

newNodetoolCommandLine

protected org.apache.commons.exec.CommandLine newNodetoolCommandLine(String... args)
                                                              throws IOException

Creates the command line to launch the nodetool utility.

Parameters:

args - the command line arguments to pass to the nodetool utility.

Returns:

the CommandLine to launch nodetool with the supplied arguments.

Throws:

IOException - if there are issues creating the cassandra home directory.