Built by Maven

accumulo2:start

Full name:

org.apache.accumulo:accumulo2-maven-plugin:1.0.0:start

Description:

Goal which starts an instance of MiniAccumuloCluster.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Binds by default to the lifecycle phase: pre-integration-test.

Required Parameters

Name Type Since Description
<instanceName> String 1.0.0 Specifies the instance name the Accumulo instance will use for itself, which clients use to connect. It is also used to create the working directory for MiniAccumuloCluster, which will contain the client properties file which clients can use to connect. See outputDirectory.
Default value is: testInstance.
User property is: accumulo.instanceName.
Alias is: instanceName.
<outputDirectory> File 1.0.0 Specifies the output directory in which this plugin will create files for its runtime use. This plugin will create a client properties file inside a subdirectory named after this plugin and the specified instance name. This property defaults to your Maven target directory.

For example: ${outputDirectory}/accumulo2-maven-plugin/instanceName

The client properties file can be used to construct an Accumulo client in your test code like:


String instanceName = "plugin-it-instance";
String outputDir = "target";
File propsFile = new File(outputDir + "/accumulo2-maven-plugin/" + instanceName);
Properties props = MiniAccumuloCluster.getClientProperties(propsFile);
AccumuloClient client = Accumulo.newClient().from(props).build();

Default value is: ${project.build.directory}.
User property is: accumulo.outputDirectory.
Alias is: outputDirectory.

Optional Parameters

Name Type Since Description
<rootPassword> String 1.0.0 Specifies the root user's initial password for clients to connect and perform additional operations.
Default value is: secret.
User property is: accumulo.rootPassword.
Alias is: rootPassword.
<skip> boolean 1.0.0 Instructs this plugin to skip execution.
Default value is: false.
User property is: accumulo.skip.
Alias is: skip.
<zooKeeperPort> int 1.0.0 Specifies the client port on which ZooKeeper listens. If not specified, MiniAccumuloCluster will select an available port on its own.
Default value is: 0.
User property is: accumulo.zooKeeperPort.
Alias is: zooKeeperPort.

Parameter Details

<instanceName>

Specifies the instance name the Accumulo instance will use for itself, which clients use to connect. It is also used to create the working directory for MiniAccumuloCluster, which will contain the client properties file which clients can use to connect. See outputDirectory.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: Yes
  • User Property: accumulo.instanceName
  • Default: testInstance
  • Alias: instanceName

<outputDirectory>

Specifies the output directory in which this plugin will create files for its runtime use. This plugin will create a client properties file inside a subdirectory named after this plugin and the specified instance name. This property defaults to your Maven target directory.

For example: ${outputDirectory}/accumulo2-maven-plugin/instanceName

The client properties file can be used to construct an Accumulo client in your test code like:


String instanceName = "plugin-it-instance";
String outputDir = "target";
File propsFile = new File(outputDir + "/accumulo2-maven-plugin/" + instanceName);
Properties props = MiniAccumuloCluster.getClientProperties(propsFile);
AccumuloClient client = Accumulo.newClient().from(props).build();
  • Type: java.io.File
  • Since: 1.0.0
  • Required: Yes
  • User Property: accumulo.outputDirectory
  • Default: ${project.build.directory}
  • Alias: outputDirectory

<rootPassword>

Specifies the root user's initial password for clients to connect and perform additional operations.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: accumulo.rootPassword
  • Default: secret
  • Alias: rootPassword

<skip>

Instructs this plugin to skip execution.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: accumulo.skip
  • Default: false
  • Alias: skip

<zooKeeperPort>

Specifies the client port on which ZooKeeper listens. If not specified, MiniAccumuloCluster will select an available port on its own.
  • Type: int
  • Since: 1.0.0
  • Required: No
  • User Property: accumulo.zooKeeperPort
  • Default: 0
  • Alias: zooKeeperPort