Package org.apache.accumulo.cluster

Interface AccumuloCluster

All Known Implementing Classes:

MiniAccumuloClusterImpl, StandaloneAccumuloCluster

public interface AccumuloCluster

Defines a minimum required set of methods to run an Accumulo cluster. (Experimental, not guaranteed to stay backwards compatible)

Since:

1.6.0

Method Summary

Modifier and Type	Method	Description
AccumuloClient	createAccumuloClient(String user, AuthenticationToken token)
String	getAccumuloPropertiesPath()
ClientConfiguration	getClientConfig()	Deprecated. since 2.0.0, replaced by getClientProperties()}
Properties	getClientProperties()
String	getClientPropsPath()
ClusterControl	getClusterControl()	Get an object that can manage a cluster
org.apache.hadoop.fs.FileSystem	getFileSystem()
String	getInstanceName()
ServerContext	getServerContext()
AccumuloConfiguration	getSiteConfiguration()	Get server side config derived from accumulo.properties
org.apache.hadoop.fs.Path	getTemporaryPath()
String	getZooKeepers()
void	start()	Start the AccumuloCluster
void	stop()	Stop the AccumuloCluster

Method Detail

getInstanceName

String getInstanceName()

Returns:

Accumulo instance name

getZooKeepers

String getZooKeepers()

Returns:

zookeeper connection string

getServerContext

ServerContext getServerContext()

Returns:

ServerContext

createAccumuloClient

AccumuloClient createAccumuloClient(String user,
                                    AuthenticationToken token)

Returns:

AccumuloClient that must be closed by user

Since:

2.0

getClientConfig

@Deprecated(since="2.0.0")
ClientConfiguration getClientConfig()

Deprecated.

since 2.0.0, replaced by getClientProperties()}

Get the client configuration for the cluster

getClientProperties

Properties getClientProperties()

Returns:

client connection info for cluster

getSiteConfiguration

AccumuloConfiguration getSiteConfiguration()

Get server side config derived from accumulo.properties

getAccumuloPropertiesPath

String getAccumuloPropertiesPath()

Returns:

Path to accumulo.properties

Since:

2.0.0

getClientPropsPath

String getClientPropsPath()

Returns:

Path to accumulo-client.properties

Since:

2.0.0

getClusterControl

ClusterControl getClusterControl()

Get an object that can manage a cluster

Returns:

Manage the state of the cluster

start

void start()
    throws Exception

Start the AccumuloCluster

Throws:

Exception

stop

void stop()
   throws Exception

Stop the AccumuloCluster

Throws:

Exception

getFileSystem

org.apache.hadoop.fs.FileSystem getFileSystem()

Returns:

the FileSystem in use by this cluster

getTemporaryPath

org.apache.hadoop.fs.Path getTemporaryPath()

Returns:

A path on FileSystem this cluster is running on that can be used for temporary files