MiniAccumuloConfigImpl (Apache Accumulo MiniCluster 1.9.3 API)

java.lang.Object
- org.apache.accumulo.minicluster.impl.MiniAccumuloConfigImpl

```
public class MiniAccumuloConfigImpl
extends Object
```
Holds configuration for MiniAccumuloClusterImpl. Required configurations must be passed to constructor(s) and all other configurations are optional.

Since:

1.6.0

Constructor Summary

Constructors
Constructor and Description

MiniAccumuloConfigImpl(File dir, String rootPassword)

Constructors
Constructor and Description
`MiniAccumuloConfigImpl(File dir, String rootPassword)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.apache.hadoop.conf.Configuration`	`getAccumuloConfiguration()`
`File`	`getAccumuloDir()`
`String[]`	`getClasspathItems()` Gets the classpath elements to use when spawning processes.
`File`	`getClientConfFile()`
`File`	`getConfDir()`
`Map<String,String>`	`getConfiguredSiteConfig()`
`int`	`getConfiguredZooKeeperPort()`
`long`	`getDefaultMemory()`
`File`	`getDir()`
`String`	`getExistingZooKeepers()`
`File`	`getHadoopConfDir()`
`org.apache.hadoop.conf.Configuration`	`getHadoopConfiguration()`
`String`	`getInstanceName()`
`File`	`getLogDir()`
`long`	`getMemory(ServerType serverType)`
`String[]`	`getNativeLibPaths()`
`int`	`getNumTservers()`
`String`	`getRootPassword()`
`String`	`getRootUserName()`
`Map<String,String>`	`getSiteConfig()`
`Map<String,String>`	`getSystemProperties()`
`int`	`getZooKeeperPort()`
`String`	`getZooKeepers()`
`long`	`getZooKeeperStartupTime()`
`boolean`	`isJDWPEnabled()`
`boolean`	`isUseCredentialProvider()`
`void`	`setClasspathItems(String... classpathItems)` Sets the classpath elements to use when spawning processes.
`MiniAccumuloConfigImpl`	`setDefaultMemory(long memory, MemoryUnit memoryUnit)` Sets the default memory size to use.
`MiniAccumuloConfigImpl`	`setExistingZooKeepers(String existingZooKeepers)` Configure an existing ZooKeeper instance to use.
`MiniAccumuloConfigImpl`	`setInstanceName(String instanceName)` Calling this method is optional.
`MiniAccumuloConfigImpl`	`setJDWPEnabled(boolean jdwpEnabled)`
`MiniAccumuloConfigImpl`	`setMemory(ServerType serverType, long memory, MemoryUnit memoryUnit)` Sets the amount of memory to use in the master process.
`MiniAccumuloConfigImpl`	`setNativeLibPaths(String... nativePathItems)` Sets the path for processes to use for loading native libraries
`MiniAccumuloConfigImpl`	`setNumTservers(int numTservers)` Calling this method is optional.
`void`	`setProperty(Property p, String value)` Sets arbitrary configuration properties.
`void`	`setRootUserName(String rootUserName)` Sets the default Accumulo "superuser".
`MiniAccumuloConfigImpl`	`setSiteConfig(Map<String,String> siteConfig)` Calling this method is optional.
`void`	`setSystemProperties(Map<String,String> systemProperties)` sets system properties set for service processes
`void`	`setUseCredentialProvider(boolean useCredentialProvider)`
`MiniAccumuloConfigImpl`	`setZooKeeperPort(int zooKeeperPort)` Calling this method is optional.
`MiniAccumuloConfigImpl`	`setZooKeeperStartupTime(long zooKeeperStartupTime)` Configure the time to wait for ZooKeeper to startup.
`boolean`	`useExistingInstance()`
`MiniAccumuloConfigImpl`	`useExistingInstance(File accumuloSite, File hadoopConfDir)` Informs MAC that it's running against an existing accumulo instance.
`boolean`	`useExistingZooKeepers()`
`boolean`	`useMiniDFS()`
`void`	`useMiniDFS(boolean useMiniDFS)` Configures this cluster to use miniDFS instead of the local `FileSystem`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MiniAccumuloConfigImpl
```
public MiniAccumuloConfigImpl(File dir,
                              String rootPassword)
```
    Parameters:
    
    dir - An empty or nonexistant directory that Accumulo and Zookeeper can store data in. Creating the directory is left to the user. Java 7, Guava, and Junit provide methods for creating temporary directories.
    
    rootPassword - The initial password for the Accumulo root user
- Method Detail
  - setNumTservers
```
public MiniAccumuloConfigImpl setNumTservers(int numTservers)
```
    Calling this method is optional. If not set, it defaults to two.
    
    Parameters:
    
    numTservers - the number of tablet servers that mini accumulo cluster should start
  - setInstanceName
```
public MiniAccumuloConfigImpl setInstanceName(String instanceName)
```
    Calling this method is optional. If not set, defaults to 'miniInstance'
    
    Since:
    
    1.6.0
  - setSiteConfig
```
public MiniAccumuloConfigImpl setSiteConfig(Map<String,String> siteConfig)
```
    Calling this method is optional. If not set, it defaults to an empty map.
    
    Parameters:
    
    siteConfig - key/values that you normally put in accumulo-site.xml can be put here.
  - setZooKeeperPort
```
public MiniAccumuloConfigImpl setZooKeeperPort(int zooKeeperPort)
```
    Calling this method is optional. A random port is generated by default
    
    Parameters:
    
    zooKeeperPort - A valid (and unused) port to use for the zookeeper
    
    Since:
    
    1.6.0
  - setZooKeeperStartupTime
```
public MiniAccumuloConfigImpl setZooKeeperStartupTime(long zooKeeperStartupTime)
```
    Configure the time to wait for ZooKeeper to startup. Calling this method is optional. The default is 20000 milliseconds
    
    Parameters:
    
    zooKeeperStartupTime - Time to wait for ZooKeeper to startup, in milliseconds
    
    Since:
    
    1.6.1
  - setExistingZooKeepers
```
public MiniAccumuloConfigImpl setExistingZooKeepers(String existingZooKeepers)
```
    Configure an existing ZooKeeper instance to use. Calling this method is optional. If not set, a new ZooKeeper instance is created.
    
    Parameters:
    
    existingZooKeepers - Connection string for a already-running ZooKeeper instance. A null value will turn off this feature.
    
    Since:
    
    1.8.0
  - setMemory
```
public MiniAccumuloConfigImpl setMemory(ServerType serverType,
                                        long memory,
                                        MemoryUnit memoryUnit)
```
    Sets the amount of memory to use in the master process. Calling this method is optional. Default memory is 128M
    
    Parameters:
    
    serverType - the type of server to apply the memory settings
    
    memory - amount of memory to set
    
    memoryUnit - the units for which to apply with the memory size
    
    Since:
    
    1.6.0
  - setDefaultMemory
```
public MiniAccumuloConfigImpl setDefaultMemory(long memory,
                                               MemoryUnit memoryUnit)
```
    Sets the default memory size to use. This value is also used when a ServerType has not been configured explicitly. Calling this method is optional. Default memory is 128M
    
    Parameters:
    
    memory - amount of memory to set
    
    memoryUnit - the units for which to apply with the memory size
    
    Since:
    
    1.6.0
  - getSiteConfig
```
public Map<String,String> getSiteConfig()
```
    Returns:
    
    a copy of the site config
  - getConfiguredSiteConfig
```
public Map<String,String> getConfiguredSiteConfig()
```
  - getInstanceName
```
public String getInstanceName()
```
    Returns:
    
    name of configured instance
    
    Since:
    
    1.6.0
  - getZooKeeperPort
```
public int getZooKeeperPort()
```
    Returns:
    
    The configured zookeeper port
    
    Since:
    
    1.6.0
  - getConfiguredZooKeeperPort
```
public int getConfiguredZooKeeperPort()
```
  - getZooKeeperStartupTime
```
public long getZooKeeperStartupTime()
```
  - getExistingZooKeepers
```
public String getExistingZooKeepers()
```
  - useExistingZooKeepers
```
public boolean useExistingZooKeepers()
```
  - getConfDir
```
public File getConfDir()
```
  - getAccumuloDir
```
public File getAccumuloDir()
```
  - getLogDir
```
public File getLogDir()
```
  - getMemory
```
public long getMemory(ServerType serverType)
```
    Parameters:
    
    serverType - get configuration for this server type
    
    Returns:
    
    memory configured in bytes, returns default if this server type is not configured
    
    Since:
    
    1.6.0
  - getDefaultMemory
```
public long getDefaultMemory()
```
    Returns:
    
    memory configured in bytes
    
    Since:
    
    1.6.0
  - getZooKeepers
```
public String getZooKeepers()
```
    Returns:
    
    zookeeper connection string
    
    Since:
    
    1.6.0
  - getDir
```
public File getDir()
```
    Returns:
    
    the base directory of the cluster configuration
  - getRootPassword
```
public String getRootPassword()
```
    Returns:
    
    the root password of this cluster configuration
  - getNumTservers
```
public int getNumTservers()
```
    Returns:
    
    the number of tservers configured for this cluster
  - isJDWPEnabled
```
public boolean isJDWPEnabled()
```
    Returns:
    
    is the current configuration in jdwpEnabled mode?
    
    Since:
    
    1.6.0
  - setJDWPEnabled
```
public MiniAccumuloConfigImpl setJDWPEnabled(boolean jdwpEnabled)
```
    Parameters:
    
    jdwpEnabled - should the processes run remote jdwpEnabled servers?
    
    Returns:
    
    the current instance
    
    Since:
    
    1.6.0
  - useMiniDFS
```
public boolean useMiniDFS()
```
  - useMiniDFS
```
public void useMiniDFS(boolean useMiniDFS)
```
    Configures this cluster to use miniDFS instead of the local FileSystem. Using this feature will not allow you to re-start MiniAccumuloCluster by calling MiniAccumuloCluster.start() after MiniAccumuloCluster.stop(), because the underlying miniDFS cannot be restarted.
  - getClientConfFile
```
public File getClientConfFile()
```
    Returns:
    
    location of client conf file containing connection parameters for connecting to this minicluster
    
    Since:
    
    1.6.0
  - setSystemProperties
```
public void setSystemProperties(Map<String,String> systemProperties)
```
    sets system properties set for service processes
    
    Since:
    
    1.6.0
  - getSystemProperties
```
public Map<String,String> getSystemProperties()
```
    Returns:
    
    a copy of the system properties for service processes
    
    Since:
    
    1.6.0
  - getClasspathItems
```
public String[] getClasspathItems()
```
    Gets the classpath elements to use when spawning processes.
    
    Returns:
    
    the classpathItems, if set
    
    Since:
    
    1.6.0
  - setClasspathItems
```
public void setClasspathItems(String... classpathItems)
```
    Sets the classpath elements to use when spawning processes.
    
    Parameters:
    
    classpathItems - the classpathItems to set
    
    Since:
    
    1.6.0
  - getNativeLibPaths
```
public String[] getNativeLibPaths()
```
    Returns:
    
    the paths to use for loading native libraries
    
    Since:
    
    1.6.0
  - setNativeLibPaths
```
public MiniAccumuloConfigImpl setNativeLibPaths(String... nativePathItems)
```
    Sets the path for processes to use for loading native libraries
    
    Parameters:
    
    nativePathItems - the nativePathItems to set
    
    Since:
    
    1.6.0
  - setProperty
```
public void setProperty(Property p,
                        String value)
```
    Sets arbitrary configuration properties.
    
    Since:
    
    1.6.0
  - isUseCredentialProvider
```
public boolean isUseCredentialProvider()
```
    Returns:
    
    the useCredentialProvider
  - setUseCredentialProvider
```
public void setUseCredentialProvider(boolean useCredentialProvider)
```
    Parameters:
    
    useCredentialProvider - the useCredentialProvider to set
  - useExistingInstance
```
public MiniAccumuloConfigImpl useExistingInstance(File accumuloSite,
                                                  File hadoopConfDir)
                                           throws IOException
```
    Informs MAC that it's running against an existing accumulo instance. It is assumed that it's already initialized and hdfs/zookeeper are already running.
    
    Parameters:
    
    accumuloSite - a File representation of the accumulo-site.xml file for the instance being run
    
    hadoopConfDir - a File representation of the hadoop configuration directory containing core-site.xml and hdfs-site.xml
    
    Returns:
    
    MiniAccumuloConfigImpl which uses an existing accumulo configuration
    
    Throws:
    
    IOException - when there are issues converting the provided Files to URLs
    
    Since:
    
    1.6.2
  - useExistingInstance
```
public boolean useExistingInstance()
```
    Returns:
    
    MAC should run assuming it's configured for an initialized accumulo instance
    
    Since:
    
    1.6.2
  - getHadoopConfDir
```
public File getHadoopConfDir()
```
    Returns:
    
    hadoop configuration directory being used
    
    Since:
    
    1.6.2
  - getAccumuloConfiguration
```
public org.apache.hadoop.conf.Configuration getAccumuloConfiguration()
```
    Returns:
    
    accumulo Configuration being used
    
    Since:
    
    1.6.2
  - getHadoopConfiguration
```
public org.apache.hadoop.conf.Configuration getHadoopConfiguration()
```
    Returns:
    
    hadoop Configuration being used
    
    Since:
    
    1.6.2
  - getRootUserName
```
public String getRootUserName()
```
    Returns:
    
    the default Accumulo "superuser"
    
    Since:
    
    1.7.0
  - setRootUserName
```
public void setRootUserName(String rootUserName)
```
    Sets the default Accumulo "superuser".
    
    Parameters:
    
    rootUserName - The name of the user to create with administrative permissions during initialization
    
    Since:
    
    1.7.0

Class MiniAccumuloConfigImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MiniAccumuloConfigImpl

Method Detail

setNumTservers

setInstanceName

setSiteConfig

setZooKeeperPort

setZooKeeperStartupTime

setExistingZooKeepers

setMemory

setDefaultMemory

getSiteConfig

getConfiguredSiteConfig

getInstanceName

getZooKeeperPort

getConfiguredZooKeeperPort

getZooKeeperStartupTime

getExistingZooKeepers

useExistingZooKeepers

getConfDir

getAccumuloDir

getLogDir

getMemory

getDefaultMemory

getZooKeepers

getDir

getRootPassword

getNumTservers

isJDWPEnabled

setJDWPEnabled

useMiniDFS

useMiniDFS

getClientConfFile

setSystemProperties

getSystemProperties

getClasspathItems

setClasspathItems

getNativeLibPaths

setNativeLibPaths

setProperty

isUseCredentialProvider

setUseCredentialProvider

useExistingInstance

useExistingInstance

getHadoopConfDir

getAccumuloConfiguration

getHadoopConfiguration

getRootUserName

setRootUserName